调用CreateDcdnDeliverTask创建报表订阅任务,订阅成功后系统会周期性地以邮件方式向您发送报表统计数据。
接口说明
说明
单用户调用频率:3 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 是 | 订阅任务名称。 | 域名订阅 |
Reports | string | 是 | 待订阅的报表列表,需进行 JSON 转义。 | [{\"reportId\":2,\"conditions\":[{\"field\":\"prov\",\"op\":\"in\",\"value\":[\"黑龙江\",\"北京\"]}]}] |
DomainName | string | 否 | 待订阅的域名列表,多个域名用半角逗号(,)分隔,订阅域名数量上限为 500 个,超过 500 个请提交工单申请。 说明
不传该参数,默认为账号下的所有域名订阅报表交付任务。
| example.com,example.org |
Deliver | string | 是 | 报表发送方式,仅支持邮件发送,需进行 JSON 转义。 | {"email":{"subject":"主题名称","to":["username@example.com","username@example.org"]}} |
Schedule | string | 是 | 订阅周期相关参数,需进行 JSON 转义。 | {"schedName":"订阅任务名称","description":"描述","crontab":"000**?","frequency":"d","status":"enable","effectiveFrom":"2020-09-17T00:00:00Z","effectiveEnd":"2020-11-17T00:00:00Z"} |
Reports 数据说明
参数 | 类型 | 是否必须 | 描述 |
---|---|---|---|
reportId | String | 是 | 报表 ID。 |
conditions | ConDatas[] | 否 | 报表过滤条件。 |
conditions 数据说明
参数 | 类型 | 是否必须 | 描述 |
---|---|---|---|
field | String | 否 | 过滤字段。 |
op | String | 否 | 过滤操作,目前只支持 in。 |
value | String[] | 否 | 字段值数组。 |
Deliver 数据说明
参数 | 类型 | 是否必须 | 描述 |
---|---|---|---|
subject | String | 否 | 订阅主题。 |
to | String[] | 是 | 收件邮箱列表数组。 |
Schedule 数据说明
参数 | 类型 | 是否必须 | 描述 |
---|---|---|---|
schedName | String | 否 | 订阅任务名称。 |
description | String | 否 | 订阅任务描述。 |
crontab | String | 是 | 订阅任务执行周期。 |
frequency | String | 是 | 执行频率。取值: h:小时 d:天 w:周 |
status | String | 否 | 订阅任务状态。取值: enable:启用。 disable:关闭。 |
effectiveFrom | String | 否 | 订阅交付任务开始时间。 |
effectiveEnd | String | 否 | 订阅交付任务结束时间。 |
返回参数
示例
正常返回示例
JSON
格式
{
"DeliverId": "92",
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | 参数错误 |
400 | TimeParseFailed | Failed to parse the time parameter. | 解析时间参数失败 |
400 | SubscriptionNotFound | The subscription is not found. | 未开通定制服务 |
400 | NameAlreadyExists | The name already exists. | 名称已存在 |
400 | DeliverExceedLimit | The maximum number of subscribed tasks is exceeded. | 订阅任务个数已达上限 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史