Queries the tracking tasks that you have created.

Note
  • By default, this operation queries all tracking tasks. However, only one tracking task can be displayed. Therefore, only one tracking task is returned.
  • You can call this API 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCdnSubList

The operation that you want to perform. Set the value to DescribeCdnSubList.

Response parameters

Parameter Type Example Description
Content String {"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"}]}}

The information about the tracking task.

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

The ID of the request.

Parameter description

Parameter

Type

Description

subId

Long

The ID of the request.

reportId

Long[]

The ID of the metric in the report.

createTime

String

The time when the report was created.

domains

String[]

The domain names from which the tracking task collects data.

effectiveFrom

String

The start time of the tracking task.

effectiveEnd

String

The end time of the tracking task.

status

String

The status of the tracking task. Valid values:

enable: enabled

disable: disabled

Examples

Sample requests

http://cdn.aliyuncs.com?Action=DescribeCdnSubList
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCdnSubListResponse>
    <RequestId>3250A51D-C11D-46BA-B6B3-95348EEDE652</RequestId>
    <Description>Successful</Description>
    <Content>
        <data>
            <subId>5</subId>
            <reportId>1</reportId>
            <reportId>2</reportId>
            <reportId>3</reportId>
            <createTime>2020-09-25T09:39:33Z</createTime>
            <domains>www.example.com</domains>
            <domains>www.example.com</domains>
            <effectiveFrom>2020-09-17T00:00:00Z</effectiveFrom>
            <effectiveEnd>2020-11-17T00:00:00Z</effectiveEnd>
            <status>enable</status>
        </data>
    </Content>
</DescribeCdnSubListResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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"
    } ]
  }
}

Error codes

HttpCode Error code Error message Description
400 InvalidParameter The specified parameter is invalid. The error message returned because one or more parameters are invalid.
400 TimeParseFailed Failed to parse the time parameter. The error message returned because the time parameter failed to be parsed.
400 SubscriptionAlreadyExists The subscription already exists. The error message returned because the tracking task already exists.
400 SubscriptionNotFound The subscription is not found. The error message returned because the tracking task does not exist.
400 NameAlreadyExists The name already exists. The error message returned because the name of the tracking task already exists.
400 DeliverExceedLimit The maximum number of subscribed tasks is exceeded. The error message returned because the maximum number of tracking tasks has been reached.

For a list of error codes, visit the API Error Center.