CreateDcdnDeliverTask - 创建报表订阅任务

更新时间:

调用CreateDcdnDeliverTask创建报表订阅任务,订阅成功后系统会周期性地以邮件方式向您发送报表统计数据。

接口说明

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

调试

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

授权信息

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

请求参数

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

订阅任务名称。

域名订阅
Reportsstring

待订阅的报表列表,需进行 JSON 转义。

[{\"reportId\":2,\"conditions\":[{\"field\":\"prov\",\"op\":\"in\",\"value\":[\"黑龙江\",\"北京\"]}]}]
DomainNamestring

待订阅的域名列表,多个域名用半角逗号(,)分隔,订阅域名数量上限为 500 个,超过 500 个请填写信息申请。

说明 不传该参数,默认为账号下的所有域名订阅报表交付任务。
example.com,example.org
Deliverstring

报表发送方式,仅支持邮件发送,需进行 JSON 转义。

{"email":{"subject":"主题名称","to":["username@example.com","username@example.org"]}}
Schedulestring

订阅周期相关参数,需进行 JSON 转义。

{"schedName":"订阅任务名称","description":"描述","crontab":"000**?","frequency":"d","status":"enable","effectiveFrom":"2020-09-17T00:00:00Z","effectiveEnd":"2020-11-17T00:00:00Z"}

Reports 数据说明

参数类型是否必须描述
reportIdString报表 ID。
conditionsConDatas[]报表过滤条件。

conditions 数据说明

参数类型是否必须描述
fieldString过滤字段。
opString过滤操作,目前只支持 in
valueString[]字段值数组。

Deliver 数据说明

参数类型是否必须描述
subjectString订阅主题。
toString[]收件邮箱列表数组。

Schedule 数据说明

参数类型是否必须描述
schedNameString订阅任务名称。
descriptionString订阅任务描述。
crontabString订阅任务执行周期。
frequencyString执行频率。取值:
h:小时
d:天
w:周
statusString订阅任务状态。取值:
enable:启用。
disable:关闭。
effectiveFromString订阅交付任务开始时间。
effectiveEndString订阅交付任务结束时间。

返回参数

名称类型描述示例值
object
DeliverIdstring

订阅任务 ID。

92
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "DeliverId": "92",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史