DescribeCdnDeliverList - API Reference| Alibaba Cloud Documentation Center

Note The maximum number of times that each user can call this operation per second is 3.

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	DescribeCdnDeliverList	The operation that you want to perform. Set the value to DescribeCdnDeliverList.
DeliverId	Long	No	92	The ID of the task that you want to query. If you do not specify an ID, all tracking tasks are queried.
Status	String	No	enable	The status of the tracing task. Valid values: enable: enabled disable: disabled Note The Status parameter is reserved. You do not need to set it.

Response parameters


Parameter	Type	Example	Description
Content	String	"data": [{"deliverId": 92,"status": "enable","createTime": "2021-06-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": 3}],"deliver": {"email": {"subject": "Subject","to": ["username@example.com","username@example.org"],"copy":["username@example.com","username@example.org"]}}}]}	The information about the tracking task.
RequestId	String	04F0F334-1335-436C-A1D7-6C044FE73368	The ID of the request.

Fields of the Content parameter


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 time interval at which the tracking task runs.
frequency	String	The time interval at which the tracking task sends reports. 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.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeCdnDeliverList
&DeliverId=92
&<Common request parameters>

Sample success responses

XML format

<DescribeCdnDeliverListResponse>
  <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
  <Content>
        <data>
              <deliverId>92</deliverId>
              <status>enable</status>
              <createTime>2021-06-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>3</reportId>
              </reports>
              <deliver>
                    <email>
                          <subject>Subject</subject>
                          <to>username@example.com</to>
                          <to>username@example.org</to>
                          <copy>username@example.com</copy>
                          <copy>username@example.org</copy>
                    </email>
              </deliver>
        </data>
  </Content>
</DescribeCdnDeliverListResponse>

JSON format

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
    "Content": {
        "data": [
            {
                "deliverId": 92,
                "status": "enable",  
                "createTime": "2021-06-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": 3
                    }
                ],                
                "deliver": {
                    "email": {
                        "subject": "Subject",
                        "to": [
                            "username@example.com",
                            "username@example.org"
                        ],
                        "copy":[
                            "username@example.com",
                            "username@example.org"
                        ]
                    }
                }
            }
        ]
    }
}

Error codes

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