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

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

调试

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

请求参数

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

系统规定参数。取值:CreateCdnDeliverTask

Deliver String {"email":{"subject":"主题名称","to":["username@example.com","username@example1.com"]}}

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

Name String 域名订阅

订阅任务名称。

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

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

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

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

DomainName String www.example1.com,www.example2.com

待订阅的域名列表,多个域名用英文逗号(,)分隔。如果不传该参数,默认为账号下的所有域名订阅报表交付任务。

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

订阅交付任务结束时间。

返回数据

名称 类型 示例值 描述
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

请求ID。

示例

请求示例

http(s)://cdn.aliyuncs.com/?Action=CreateCdnDeliverTask
&Deliver={"email":{"subject":"主题名称","to":["username@example.com","username@example1.com"]}}
&Name=域名订阅
&Reports=[{\"reportId\":1,\"conditions\":[{\"field\":\"prov\",\"op\":\"in\",\"value\":[\"黑龙江\",\"北京\"]}]}]
&Schedule={"schedName":"订阅任务名称","description":"描述","crontab":"000**?","frequency":"d","status":"enable","effectiveFrom":"2020-09-17T00:00:00Z","effectiveEnd":"2020-11-17T00:00:00Z"}
&<公共请求参数>

正常返回示例

XML格式

<CreateCdnDeliverTaskResponse>
  <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</CreateCdnDeliverTaskResponse>

JSON格式

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

错误码

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. 订阅任务个数已达上限

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