All Products
Search
Document Center

CDN:DescribeUserUsageDataExportTask

Last Updated:Aug 06, 2024

Queries usage export tasks that were created in the last three months.

Operation description

Note You can call this operation up to 100 times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cdn:DescribeUserUsageDataExportTaskget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizestringNo

The number of entries to return on each page. Default value: 20. Maximum value: 50.

Valid values: an integer from 1 to 50.

20
PageNumberstringNo

The number of the page to return. Valid values: 1 to 100000.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

A91BE91F-0B34-4CBF-8E0F-A2977E15AA52
UsageDataPerPageobject

The usage details returned per page.

PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of entries returned.

10
Dataarray<object>

The information about the tasks.

object
Statusstring

The state of the task.

  • created: The task is being created.
  • success: The task is successful.
  • failed: The task failed.
success
UpdateTimestring

The time when the task was last modified.

2019-12-31T08:45:02Z
DownloadUrlstring

The download URL.

https://cdn-polaris.xxxx
CreateTimestring

The time when the task was created.

2019-12-31T08:43:21Z
TaskNamestring

The name of the task.

Refresh
TaskIdstring

The ID of the task.

A91BE91F-0B34-4CBF-8E0F-A2977
TaskConfigobject

The configurations of the task.

EndTimestring

The end of the time range that was queried.

2019-12-30T15:59:59Z
StartTimestring

The start of the time range during which data was queried.

2019-12-29T16:00:00Z

Examples

Sample success responses

JSONformat

{
  "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\n",
          "TaskId": "A91BE91F-0B34-4CBF-8E0F-A2977",
          "TaskConfig": {
            "EndTime": "2019-12-30T15:59:59Z",
            "StartTime": "2019-12-29T16:00:00Z"
          }
        }
      ]
    }
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterProductInvalid Parameter Product.The Product parameter is set to an invalid value.
400InvalidParameterOperatorInvalid Parameter Operator.The Operator parameter is set to an invalid value.

For a list of error codes, visit the Service error codes.