All Products
Search
Document Center

CDN:DescribeCdnSubList

Last Updated:Aug 06, 2024

Queries the tracking tasks that you have created.

Operation description

  • By default, this operation queries all custom operations reports. However, only one operations report can be displayed. Therefore, only one operations report is returned.
  • You can call this operation up to three 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:DescribeCdnSubListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
Contentstring

The information about the custom report task.

{"RequestId":"3250A51D-C11D-46BA-B6B3-95348EEDE652","Description":"Successful","Content":{"data":\[{"subId":5,"reportId":\[1,2,3],"createTime":"2020-09-25T09:39:33Z","domains"\["www.example.com","www.example.com"],"effectiveFrom":"2020-09-17T00:00:00Z","effectiveEnd":"2020-11-17T00:00:00Z","status":"enable"}]}}
RequestIdstring

The ID of the request.

3250A51D-C11D-46BA-B6B3-95348EEDE652

Fields of the data parameter

FieldTypeDescription
subIdLongThe ID of the request.
reportIdLong[]The ID of the report.
createTimeStringThe time when the report was created.
domainsString[]The domain names from which the custom report task collects data.
effectiveFromStringThe start time of the custom report task.
effectiveEndStringThe end time of the custom report task.
statusStringThe status of the custom report task. Valid values : enable disable

Examples

Sample success responses

JSONformat

{
  "Content": "{\"RequestId\":\"3250A51D-C11D-46BA-B6B3-95348EEDE652\",\"Description\":\"Successful\",\"Content\":{\"data\":\\[{\"subId\":5,\"reportId\":\\[1,2,3],\"createTime\":\"2020-09-25T09:39:33Z\",\"domains\"\\[\"www.example.com\",\"www.example.com\"],\"effectiveFrom\":\"2020-09-17T00:00:00Z\",\"effectiveEnd\":\"2020-11-17T00:00:00Z\",\"status\":\"enable\"}]}}\n",
  "RequestId": "3250A51D-C11D-46BA-B6B3-95348EEDE652"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.-
400TimeParseFailedFailed to parse the time parameter.Failed to parse the time parameter.
400SubscriptionAlreadyExistsThe subscription already exists.The subscription already exists.
400SubscriptionNotFoundThe subscription is not found.The subscription is not found.
400NameAlreadyExistsThe name already exists.The specified name already exists.
400DeliverExceedLimitThe maximum number of subscribed tasks is exceeded.The number of tracking tasks has reached the upper limit.

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