operations
Creates, updates, deletes, gets or lists an operations resource.
Overview​
| Name | operations |
| Type | Resource |
| Id | ovh.dbaas_logs.operations |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
alias_id | string (uuid) | Alias used (wire: aliasId) |
dashboard_id | string (uuid) | Dashboard used (wire: dashboardId) |
encryption_key_id | string (uuid) | Encryption key used (wire: encryptionKeyId) |
index_id | string (uuid) | Index used (wire: indexId) |
input_id | string (uuid) | Input used (wire: inputId) |
operation_id | string (uuid) | Operation ID (wire: operationId) |
osd_id | string (uuid) | OpenSearch Dashboards used (wire: osdId) |
role_id | string (uuid) | Role used (wire: roleId) |
stream_id | string (uuid) | Stream used (wire: streamId) |
subscription_id | string (uuid) | Subscription used (wire: subscriptionId) |
tenant_id | string (uuid) | Metrics tenant used (wire: tenantId) |
token_id | string (uuid) | Token used (wire: tokenId) |
service_name | string | Service name (wire: serviceName) |
created_at | string (date-time) | Operation creation (wire: createdAt) |
state | string | Operation status (FAILURE, PENDING, RECEIVED, RETRY, REVOKED, RUNNING, STARTED, SUCCESS) |
updated_at | string (date-time) | Operation last update (wire: updatedAt) |
Asynchronous operation
| Name | Datatype | Description |
|---|---|---|
alias_id | string (uuid) | Alias used (wire: aliasId) |
dashboard_id | string (uuid) | Dashboard used (wire: dashboardId) |
encryption_key_id | string (uuid) | Encryption key used (wire: encryptionKeyId) |
index_id | string (uuid) | Index used (wire: indexId) |
input_id | string (uuid) | Input used (wire: inputId) |
operation_id | string (uuid) | Operation ID (wire: operationId) |
osd_id | string (uuid) | OpenSearch Dashboards used (wire: osdId) |
role_id | string (uuid) | Role used (wire: roleId) |
stream_id | string (uuid) | Stream used (wire: streamId) |
subscription_id | string (uuid) | Subscription used (wire: subscriptionId) |
tenant_id | string (uuid) | Metrics tenant used (wire: tenantId) |
token_id | string (uuid) | Token used (wire: tokenId) |
service_name | string | Service name (wire: serviceName) |
created_at | string (date-time) | Operation creation (wire: createdAt) |
state | string | Operation status (FAILURE, PENDING, RECEIVED, RETRY, REVOKED, RUNNING, STARTED, SUCCESS) |
updated_at | string (date-time) | Operation last update (wire: updatedAt) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | operation_id, service_name | Returns the operation. | |
list | select | service_name | x_pagination_mode | Returns the operations of the Logs Data Platform service. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
operation_id | string (uuid) | Operation ID (wire: operationId) |
service_name | string | Service name (wire: serviceName) |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Returns the operation.
SELECT
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at
FROM ovh.dbaas_logs.operations
WHERE operation_id = '{{ operation_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Returns the operations of the Logs Data Platform service.
SELECT
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at
FROM ovh.dbaas_logs.operations
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;