All Products
Search
Document Center

ActionTrail:DescribeTrailDeliveryMetricData

Last Updated:Apr 27, 2026

Retrieves data for delivery monitoring metrics.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

MetricName

string

Yes

The name of the delivery monitoring metric. Valid values:

  • delivery_sls_success_count: The number of logs successfully delivered to SLS.

  • delivery_sls_fail_count: The number of logs that failed to be delivered to SLS.

  • delivery_oss_success_count: The number of logs successfully delivered to OSS.

  • delivery_oss_fail_count: The number of logs that failed to be delivered to OSS.

delivery_sls_success_count

TrailName

string

Yes

The name of the trail.

trail-name

StartTime

string

Yes

The start of the time window for the query. Specify the time in ISO 8601 format: 'YYYY-MM-DDThh:mm:ssZ'. The 'Z' indicates UTC.

2026-04-09T01:00:00Z

EndTime

string

Yes

The end of the time window for the query. Specify the time in ISO 8601 format: 'YYYY-MM-DDThh:mm:ssZ'. The 'Z' indicates UTC.

2026-04-10T01:00:00Z

Period

integer

Yes

The statistical period for the metric data, in seconds. The value must be 60 or a multiple of 60.

Recommended values: 60, 900, and 3600.

3600

Response elements

Element

Type

Description

Example

object

The data returned by the call.

MetricList

array<object>

A list of data points for the delivery monitoring metric.

object

A data point for the delivery monitoring metric.

Count

integer

The value of the metric. The meaning of this parameter depends on the value of the MetricName parameter in the request.

For example, if MetricName is set to delivery_sls_success_count, Count indicates the number of logs successfully delivered to SLS.

21

Timestamp

integer

The Unix timestamp, in milliseconds, that marks the start of the time window for this data point.

1775721600000

RequestId

string

The unique ID of the request.

851038F3-33AB-4C49-97D7-6AB37D35****

Examples

Success response

JSON format

{
  "MetricList": [
    {
      "Count": 21,
      "Timestamp": 1775721600000
    }
  ],
  "RequestId": "851038F3-33AB-4C49-97D7-6AB37D35****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.