Query usage data export tasks - CDN - Alibaba Cloud - CDN

Queries the usage data export tasks of a user within the last three months.

Operation description

Note

Rate limit per user: 100 calls per second.

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:DescribeUserUsageDataExportTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	string	No	The number of entries per page. Default value: 20. Maximum value: 50. Valid values: any integer from 1 to 50.	20
PageNumber	string	No	The page number. Valid values: 1 to 100000.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A91BE91F-0B34-4CBF-8E0F-A2977E15AA52
UsageDataPerPage	object	The usage data per page.
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The current page number.	1
TotalCount	integer	The total number of entries.	10
Data	object
DataItem	array<object>	The task information.
	array<object>
Status	string	The task status. Valid values: created: Creating. success: Successful. failed: Failed.	success
UpdateTime	string	The last update time of the task. The time follows the ISO 8601 standard in UTC.	2019-12-31T08:45:02Z
DownloadUrl	string	The download URL.	https://cdn-polaris.xxxx
CreateTime	string	The creation time of the task. The time follows the ISO 8601 standard in UTC.	2019-12-31T08:43:21Z
TaskName	string	The task name.	Refresh
TaskId	string	The task ID.	A91BE91F-0B34-4CBF-8E0F-A2977
TaskConfig	object	The task configuration.
EndTime	string	The end time of the usage data. The time follows the ISO 8601 standard in UTC.	2019-12-30T15:59:59Z
StartTime	string	The start time of the usage data.	2019-12-29T16:00:00Z

Examples

Success response

JSON format

{
  "RequestId": "A91BE91F-0B34-4CBF-8E0F-A2977E15AA52",
  "UsageDataPerPage": {
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 10,
    "Data": {
      "DataItem": [
        {
          "Status": "success",
          "UpdateTime": "2019-12-31T08:45:02Z",
          "DownloadUrl": "https://cdn-polaris.xxxx",
          "CreateTime": "2019-12-31T08:43:21Z",
          "TaskName": "Refresh",
          "TaskId": "A91BE91F-0B34-4CBF-8E0F-A2977",
          "TaskConfig": {
            "EndTime": "2019-12-30T15:59:59Z",
            "StartTime": "2019-12-29T16:00:00Z"
          }
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameterProduct	Invalid Parameter Product.	The Product parameter is set to an invalid value.
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.