Export resource usage details by using CreateUsageDetailDataExportTask - CDN - Alibaba Cloud - CDN

Creates a usage detail data export task to generate an Excel file of detailed usage data for download.

Operation description

You can create a task to query data from the past year at most. The maximum time span for a single export task is one month.
Rate limit: 100 calls per second per user.

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

cdn:CreateUsageDetailDataExportTask

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainNames}

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-12-10T20:00:00Z
EndTime	string	Yes	The end time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The end time must be later than the start time.	2019-12-10T21:00:00Z
Group	string	No	The domain name group. If this parameter is not empty, the DomainNames parameter is ignored.	xxx
DomainNames	string	No	The domain names. If the domain name group is empty, data is exported based on the domain names specified by this parameter. If this parameter is not specified, user-level data is exported.	example.com
Type	string	Yes	The type of usage data to retrieve. Valid values: flow: traffic and bandwidth data. vas: request data.	flow
TaskName	string	No	The name of the task.	Refresh
Language	string	No	The language of the exported file. Valid values: zh-cn (default): Simplified Chinese. en-us: English.	en-us

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time. The time is displayed in the ISO 8601 standard in UTC.	2015-12-10T21:00:00Z
StartTime	string	The start time. The time is displayed in the ISO 8601 standard in UTC.	2015-12-10T20:00:00Z
RequestId	string	The request ID.	ED61C6C3-8241-4187-AAA7-5157AE175CEC
TaskId	string	The task ID.	123456

Examples

Success response

JSON format

{
  "EndTime": "2015-12-10T21:00:00Z",
  "StartTime": "2015-12-10T20:00:00Z",
  "RequestId": "ED61C6C3-8241-4187-AAA7-5157AE175CEC",
  "TaskId": "123456"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidParameterProduct	Invalid Parameter Product.	The Product parameter is set to an invalid value.
400	InvalidParameterDimension	The parameter Dimension is invalid.	The Dimension parameter is invalid. Specify a valid value that is provided in the documentation.
400	InvalidParameterBillType	The parameter BillType is invalid.	The bill type is invalid. Make sure that the bill type is supported by the query method.
400	InvalidParameterAliuid	Invalid Parameter Aliuid.	The Aliuid parameter is set to an invalid value.
400	InvalidParameterStartTime	The specified StartTime is invalid.	The StartTime parameter is invalid.
400	InvalidParameterEndTime	The specified EndTime is invalid.	The EndTime parameter is invalid.
400	InvalidTimeRange	Invalid StartTime and EndTime range.	The specified time range is invalid.
400	InvalidParameterOperator	Invalid Parameter Operator.	The Operator parameter is set to an invalid value.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.