调用DescribeCdnDeliverList查询报表订阅任务列表-CDN-阿里云

调用DescribeCdnDeliverList查询报表订阅任务列表，系统将返回该用户所有的订阅任务列表。

接口说明

说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cdn:DescribeCdnDeliverList

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DeliverId	integer	否	待查询的订阅任务 ID。如果不传该参数，默认返回所有的订阅任务。	3

返回参数

名称	类型	描述	示例值
	object	返回主体
RequestId	string	请求 ID。	12345
Content	object	订阅任务列表数据。	"data": [{"deliverId": 1,"status": "enable","createTime": "2020-10-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": ["example@alibaba-inc.com","example@alibaba-inc.com"]}}}]}}
data	array<object>
	array<object>
createTime	string		2021-12-30T10:29:29Z
crontab	string		00 00 08 * * ?
deliver	object
email	object
to	array
	string		xx@xx.xx
deliverId	integer		1
dmList	array
	string		a.b.c
frequency	string		d
name	string		xxxx
reports	array<object>
	object
reportId	integer		1
status	string		enable
timeEndFormat	string		-1d
timeFromFormat	string		-1d

data 数据说明

参数	类型	描述
deliverId	Long	订阅任务 ID。
status	String	订阅任务状态。取值： enable：启用。 disable：关闭。
createTime	String	订阅任务创建时间。
crontab	String	订阅任务执行周期。
frequency	String	执行频率。取值： h：小时 d：天 M：月
name	String	订阅任务名称。
dmList	String[]	订阅任务的域名过滤列表。
reports	String[]	订阅报表列表。包含以下参数： reportId：报表 ID。 conditions：报表过滤条件（包含过滤操作、过滤字段和过滤值），没有则为空。op：过滤操作，目前只支持 in；field：过滤字段；value：过滤值。
deliver	String	交付模块，包含邮件主题、收件人等信息。 email：邮件交付。 subject：邮件主题。 to：发送邮件列表。 copy：抄送邮件列表。

reports 数据说明

参数	类型	描述
deliverId	Long	订阅任务 ID。
status	String	订阅任务状态。取值： enable：启用。 disable：关闭。

示例

正常返回示例

JSON格式

{
  "RequestId": "12345",
  "Content": {
    "data": [
      {
        "createTime": "2021-12-30T10:29:29Z",
        "crontab": "00 00 08 * * ?",
        "deliver": {
          "email": {
            "to": [
              "xx@xx.xx"
            ]
          }
        },
        "deliverId": 1,
        "dmList": [
          "a.b.c"
        ],
        "frequency": "d",
        "name": "xxxx",
        "reports": [
          {
            "reportId": 1
          }
        ],
        "status": "enable",
        "timeEndFormat": "-1d",
        "timeFromFormat": "-1d"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
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.	订阅任务个数已达上限

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

变更历史

更多信息，参考变更详情。