Observability
All operations require authentication.
List log kindsBeta
Returns the names of the log kinds OpenSearch emits, which can be forwarded to a stream.
Path parameters
Project ID
Service ID
Headers
Pagination cursor
Pagination size
Response
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/[ "string"]
List log subscriptionsBeta
Returns the identifiers of the OpenSearch log subscriptions. Set kind to restrict the list to one log kind.
Path parameters
Project ID
Service ID
Query parameters
Filter subscriptions by log kind
CUSTOMER_LOGSHeaders
Pagination cursor
Pagination size
Response
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/[ "00000000-0000-0000-0000-000000000000"]
List metricsBeta
Returns the metrics available for the service. Set extended to true to include engine-specific metrics.
Path parameters
Project ID
Service ID
Query parameters
Display engine-specific metrics
Headers
Pagination cursor
Pagination size
Response
Metric values for each host in the cluster
Name of the metric
Unit of the metric values
BYTESBYTES_PER_SECONDGIGABYTESGIGABYTES_PER_HOURMEGABYTESMEGABYTES_PER_SECONDMILLISECONDSPERCENTSCALARSCALAR_PER_SECONDSECONDSUNKNOWNExample uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/[ { "metrics": [ { "dataPoints": [ { "timestamp": 0, "value": 0 } ], "hostname": "string" } ], "name": "string", "unit": "BYTES" }]
Get a log kindBeta
Returns a log kind and the additional fields its logs carry.
Path parameters
Name
Project ID
Service ID
Response
List of additional log fields managed in this log kind
Creation date of the log kind
Log kind display name
Identifier of the log kind
Log kind name
Last update date of the log kind
Example uses name = string, projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "additionalReturnedFields": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "displayName": "string", "kindId": "00000000-0000-0000-0000-000000000000", "name": "string", "updatedAt": "2024-01-01T12:00:00Z"}
Get a log subscriptionBeta
Returns the log kind and the destination stream of a subscription.
Path parameters
Project ID
Service ID
Subscription ID
Response
Creation date of the subscription
Log kind name of this subscription
Subscribed resource, where the logs come from
Name of the destination log service
Identifier of the destination log stream
Unique identifier of the subscription, used to change or stop the forwarding
Last update date of the subscription
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, subscriptionId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "resource": { "name": "string", "type": "string" }, "serviceName": "string", "streamId": "string", "subscriptionId": "00000000-0000-0000-0000-000000000000", "updatedAt": "2024-01-01T12:00:00Z"}
Get a metricBeta
Returns the values of a metric for each node of the service, over the requested period.
Path parameters
Metric name
Project ID
Service ID
Query parameters
Time period over which to retrieve metric values
LAST_DAYLAST_HOURLAST_MONTHLAST_WEEKLAST_YEARResponse
Metric values for each host in the cluster
Name of the metric
Unit of the metric values
BYTESBYTES_PER_SECONDGIGABYTESGIGABYTES_PER_HOURMEGABYTESMEGABYTES_PER_SECONDMILLISECONDSPERCENTSCALARSCALAR_PER_SECONDSECONDSUNKNOWNExample uses metricName = string, projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "metrics": [ { "dataPoints": [ { "timestamp": 0, "value": 0 } ], "hostname": "string" } ], "name": "string", "unit": "BYTES"}
Get the Prometheus endpointBeta
Returns the scraping targets and the username for Prometheus authentication. The password is returned only by a credentials reset.
Path parameters
Project ID
Service ID
Response
Scraping targets
Username for Prometheus authentication
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "targets": [ { "host": "string", "port": 0 } ], "username": "string"}
Create a log subscriptionBeta
Forwards OpenSearch logs of one kind to a Logs Data Platform stream. The subscription is created asynchronously and the response returns the operation identifier.
Path parameters
Project ID
Service ID
Request body (required)
Log kind name to subscribe to
Identifier of the customer log stream
Response
Identifier of the operation
Operation owner's service name
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}
Generate a temporary log URLBeta
Generates a temporary URL to read the logs of one kind. The URL expires.
Path parameters
Project ID
Service ID
Request body (required)
Log kind name
Response
Temporary url expiration date
Temporary url
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "expirationDate": "2024-01-01T12:00:00Z", "url": "string"}
Reset the Prometheus credentialsBeta
Resets the Prometheus password. The previous password stops working immediately and the new credentials are returned in the response.
Path parameters
Project ID
Service ID
Response
Password for Prometheus authentication
Username for Prometheus authentication
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "password": "string", "username": "string"}
Delete a log subscriptionBeta
Deletes the subscription and stops forwarding OpenSearch logs to the stream.
Path parameters
Project ID
Service ID
Subscription ID
Response
Identifier of the operation
Operation owner's service name
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, subscriptionId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}