DescribeDcdnDeliverList - 查询报表订阅任务列表

更新时间:

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

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DeliverIdlong

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

92

返回参数

名称类型描述示例值
object
Contentstring

订阅任务列表数据。

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

请求 ID。

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

Content 数据说明

参数类型描述
deliverIdLong订阅任务 ID。
statusString订阅任务状态。取值:
enable:启用。
disable:关闭。
createTimeString订阅任务创建时间。
crontabString订阅任务执行周期。
frequencyString执行频率。取值:
h:小时
d:天
M:月
nameString订阅任务名称。
dmListString[]订阅任务的域名过滤列表。
reportsString[]订阅报表列表。包含以下参数:
reportId:报表 ID。
conditions:报表过滤条件(包含过滤操作、过滤字段和过滤值),没有则为空。op:过滤操作,目前只支持 in;field:过滤字段;value:过滤值。
deliverString交付模块,包含邮件主题、收件人等信息。
email:邮件交付。
subject:邮件主题。
to:发送邮件列表。
copy:抄送邮件列表。

示例

正常返回示例

JSON格式

{
  "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\"]}}}]}",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.参数错误
400TimeParseFailedFailed to parse the time parameter.解析时间参数失败
400SubscriptionAlreadyExistsThe subscription already exists.定制服务已开通
400SubscriptionNotFoundThe subscription is not found.未开通定制服务
400NameAlreadyExistsThe name already exists.名称已存在
400DeliverExceedLimitThe maximum number of subscribed tasks is exceeded.订阅任务个数已达上限

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