Queries one or more tracking tasks of operations reports.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeCdnDeliverList |
The operation that you want to perform. Set the value to DescribeCdnDeliverList. |
DeliverId | Long | No | 3 |
The ID of the tracking task that you want to query. If you do not specify an ID, all tracking tasks are queried. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Content | String | "data": [{"deliverId": 1,"status": "enable","createTime": "2020-10-14T11:19:26Z","crontab": "0 0 0 * * ?","frequency": "d","name": "Domain name report","dmList": ["www.example.com"],"reports": [{"reportId": 1,"conditions": [{"op": "in","field": "prov","value": ["Heilongjiang","Beijing"]}]},{"reportId": 2}],"deliver": {"email": {"subject": "Subject","to": ["example@alibaba-inc.com","example@alibaba-inc.com"]}}}]}} |
The information about the tracking task. |
RequestId | String | 12345 |
The ID of the request. |
Field |
Type |
Description |
---|---|---|
deliverId |
Long |
The ID of the tracking task. |
status |
String |
The status of the tracking task. Valid values: enable: enabled disable: disabled |
createTime |
String |
The time when the tracking task was created. |
crontab |
String |
The period during which the tracking task runs. |
frequency |
String |
The interval at which the reports are sent. Valid values: h: every hour d: every day M: every month |
name |
String |
The name of the tracking task. |
dmList |
String[] |
The domain names from which the tracking task collects data. |
reports |
String[] |
The information about the reports released by the tracking task. The following parameters are included: reportId: the ID of the report. conditions: the filter conditions, including the filter action, fields, and values. If no filter conditions are specified, this parameter does not carry a value. op: the filter action. Only in is supported. field: the filter fields. value: the filter values. |
deliver |
String |
The delivery module, including the subject and recipient of the email. email: indicates that reports are sent to specified email addresses. subject: the subject of the email. to: the recipient of the email. copy: the contacts to whom the email is copied. |
Field |
Type |
Description |
---|---|---|
deliverId |
Long |
The ID 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=DescribeCdnDeliverList
&DeliverId=3
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeCdnDeliverListResponse>
<RequestId>12345</RequestId>
<Content>
<data>
<deliverId>1</deliverId>
<status>enable</status>
<createTime>2020-10-14T11:19:26Z</createTime>
<crontab>0 0 0 * * ?</crontab>
<frequency>d</frequency>
<name>Domain name report</name>
<dmList>www.example.com</dmList>
<reports>
<reportId>1</reportId>
<conditions>
<op>in</op>
<field>prov</field>
<value>Heilongjiang</value>
<value>Beijing</value>
</conditions>
</reports>
<reports>
<reportId>2</reportId>
</reports>
<deliver>
<email>
<subject>Subject</subject>
<to>example@alibaba-inc.com</to>
<to>example@alibaba-inc.com</to>
</email>
</deliver>
</data>
</Content>
</DescribeCdnDeliverListResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "12345",
"Content" : {
"data" : [ {
"deliverId" : 1,
"status" : "enable",
"createTime" : "2020-10-14T11:19:26Z",
"crontab" : "0 0 0 * * ?",
"frequency" : "d",
"name" : "Domain name subscription",
"dmList" : [ "www.example.com" ],
"reports" : [ {
"reportId" : 1,
"conditions" : [ {
"op" : "in",
"field" : "prov",
"value" : [ "Heilongjiang", "Beijing" ]
} ]
}, {
"reportId" : 2
} ],
"deliver" : {
"email" : {
"subject":"{Subject}",
"to" : [ "example@alibaba-inc.com", "example@alibaba-inc.com" ]
}
}
} ]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | The error message returned because the specified parameter is 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.