全部产品
Search

搜索本产品

    CDN：CreateCdnDeliverTask - 创建报表订阅任务

    文档中心

    CDN：CreateCdnDeliverTask - 创建报表订阅任务

    更新时间：Aug 06, 2024

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

    接口说明

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

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    cdn:CreateCdnDeliverTaskcreate
    • Domain
      acs:cdn:*:{#accountId}:domain/{#DomainName}
      无
    		无

    请求参数

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

    订阅交付任务名称。

    		域名订阅
    Reportsstring是

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

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

    待订阅的域名列表，多个域名用半角逗号（,）分隔，订阅域名数量上限为 500 个，超过 500 个请提交工单申请。

    说明 不传该参数，默认为账号下的所有域名订阅报表交付任务。
    		www.example1.com,www.example2.com
    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\"}

    ReDatas 数据说明

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

    ConDatas 数据说明

    参数类型是否必须描述
    fieldString否过滤字段。
    opString否过滤操作。
    valueString[]否字段值数组。

    email 数据说明

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

    Deliver 数据说明

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

    Schedule 数据说明

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

    返回参数

    名称类型描述示例值
    object
    DeliverIdstring

    订阅任务 ID。

    		1025
    RequestIdstring

    请求 ID。

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

    示例

    正常返回示例

    JSON格式

    {
  "DeliverId": "1025",
  "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.订阅任务个数已达上限

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

    变更历史

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