调用DescribeDcdnDeliverList查询报表订阅任务列表,系统将返回所有的订阅任务列表。

说明 单用户调用频率:3次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDcdnDeliverList

系统规定参数。取值:DescribeDcdnDeliverList

DeliverId Long 92

待查询的订阅任务ID。如果不传该参数,默认返回所有的订阅任务。

返回数据

名称 类型 示例值 描述
Content String "data": [{"deliverId": 1,"status": "enable","createTime": "2021-06-14T11:19:26Z","crontab": "0 0 0 * * ?","frequency": "d","name": "域名订阅","dmList": ["www.example.com"],"reports": [{"reportId": 1,"conditions": [{"op": "in","field": "prov","value": ["黑龙江","北京"]}]},{"reportId": 2}],"deliver": {"email": {"subject": "主题","to": ["username@example.com","username@example.org"],"copy":["username@example.com","username@example.org"]}}}]}

订阅任务列表数据。

RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

请求ID。

Content数据说明

参数

类型

描述

deliverId

Long

订阅任务ID。

status

String

订阅任务状态。取值:

enable:启用。

disable:关闭。

createTime

String

订阅任务创建时间。

crontab

String

订阅任务执行周期。

frequency

String

执行频率。取值:

h:小时

d:天

M:月

name

String

订阅任务名称。

dmList

String[]

订阅任务的域名过滤列表。

reports

String[]

订阅报表列表。包含以下参数:

reportId:报表ID。

conditions:报表过滤条件(包含过滤操作、过滤字段和过滤值),没有则为空。op:过滤操作,目前只支持in;field:过滤字段;value:过滤值。

deliver

String

交付模块,包含邮件主题、收件人等信息。

email:邮件交付。

subject:邮件主题。

to:发送邮件列表。

copy:抄送邮件列表。

示例

请求示例

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDeliverList
&DeliverId=92
&<公共请求参数>

正常返回示例

XML格式

<DescribeDcdnDeliverListResponse>
  <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
  <Content>
        <data>
              <deliverId>1</deliverId>
              <status>enable</status>
              <createTime>2021-06-14T11:19:26Z</createTime>
              <crontab>0 0 0 * * ?</crontab>
              <frequency>d</frequency>
              <name>域名订阅</name>
              <dmList>www.example.com</dmList>
              <reports>
                    <reportId>1</reportId>
                    <conditions>
                          <op>in</op>
                          <field>prov</field>
                          <value>黑龙江</value>
                          <value>北京</value>
                    </conditions>
              </reports>
              <reports>
                    <reportId>2</reportId>
              </reports>
              <deliver>
                    <email>
                          <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>
</DescribeDcdnDeliverListResponse>

JSON格式

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
    "Content": {
        "data": [
            {
                "deliverId": 1,
                "status": "enable",  
                "createTime": "2021-06-14T11:19:26Z",
                "crontab": "0 0 0 * * ?",
                "frequency": "d",
                "name": "域名订阅",
                "dmList": [
                    "www.example.com"
                ],
                "reports": [
                    {
                        "reportId": 1,
                        "conditions": [
                            {
                                "op": "in",
                                "field": "prov",
                                "value": [
                                    "黑龙江",
                                    "北京"
                                ]
                            }
                        ]
                    },
                    {
                        "reportId": 2
                    }
                ],                
                "deliver": {
                    "email": {
                        "subject": "主题",
                        "to": [
                            "username@example.com",
                            "username@example.org"
                        ],
                        "copy":[
                            "username@example.com",
                            "username@example.org"
                        ]
                    }
                }
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter The specified parameter is invalid. 参数错误
400 TimeParseFailed Failed to parse the time parameter. 解析时间参数失败
400 SubscriptionAlreadyExists The subscription already exists. 定制服务已开通
400 SubscriptionNotFound The subscription is not found. 未开通定制服务
400 NameAlreadyExists The name already exists. 名称已存在
400 DeliverExceedLimit The maximum number of subscribed tasks is exceeded. 订阅任务个数已达上限

访问错误中心查看更多错误码。