DescribeTrailDeliveryMetricData - ActionTrail - Alibaba Cloud Documentation Center

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

actiontrail:DescribeTrailDeliveryMetricData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MetricName	string	Yes	The monitoring metrics name. Valid values: delivery_sls_success_count: the number of logs successfully delivered to Simple Log Service (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 Object Storage Service (OSS). delivery_oss_fail_count: the number of logs that failed to be delivered to OSS.	delivery_sls_success_count
TrailName	string	Yes	The trail name.	trail-name
StartTime	string	Yes	The start time. Format: 2026-02-25T00:35:00Z.	2026-04-09T01:00:00Z
EndTime	string	Yes	The end time. The format is the same as StartTime.	2026-04-10T01:00:00Z
Period	integer	Yes	The statistical period of the monitoring data. The minimum value is 60. Multiples of 60 are supported. Recommended values: 60, 900, and 3600. Unit: seconds.	3600

Response elements

Element	Type	Description	Example
	object	Schema of Response
MetricList	array<object>	The list of monitoring metrics.
	object	The monitoring metrics object.
Count	integer	The count of the monitoring metrics. The specific meaning is determined by the MetricName request parameter. For example, if MetricName is set to `delivery_sls_success_count`, the `Count` in the response represents the number of logs successfully delivered to SLS.	21
Timestamp	integer	The time window corresponding to Count. This is the timestamp of the metric data point, expressed as a UNIX timestamp in milliseconds.	1775721600000
RequestId	string	The request ID.	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.