获取部署任务列表

更新时间:2023-03-28 17:43:47

适用产品

CDN Pro

接口描述

获取部署任务列表。可使用查询参数来过滤部署任务。

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Params 参数

参数名称描述
offsetInteger
默认值: 0 取值范围: >= 0 查询起始位置。
limitInteger
默认值: 100 取值范围: <= 200 每次查询的最大条数。
propertyIdString
指定加速项目ID,查询该加速项目相关的部署任务。
certificateIdString
指定证书ID,查询该证书相关的部署任务。
targetString
取值范围: staging,production 根据部署环境查询。默认情况下,查询所有环境的部署任务。
searchString
根据搜索关键字匹配部署任务名称及加速项目下的域名进行查询。
taskIdsString
根据部署任务ID查询。可指定多个ID,以逗号分隔。
sortByString
取值范围: submissionTime,finishTime 默认值: finishTime 根据任务提交时间或完成时间进行排序。
sortOrderString
取值范围: asc,desc 默认值: desc 指定排序顺序。
startdateString
指定RFC 3339格式的日期,查询提交时间晚于该日期的部署任务。
enddateString
指定RFC 3339格式的日期,查询提交时间早于该日期的部署任务。

返回参数

Body 参数

参数名称描述
deployList
部署任务列表。
idString
部署任务的ID。您可以通过调用'获取部署任务的详细信息'接口来获取部署任务的更多信息。
nameString
部署任务的名称。
submissionTimeString
RFC 3339格式的日期,表示任务的提交时间。
finishTimeString
RFC 3339格式的日期,表示任务的完成时间。
statusString
取值范围: waiting,in progress,failed,succeeded 部署任务的执行状态,包括等待中,执行中,部署失败,部署成功等状态。
targetString
取值范围: staging,production 部署任务对应的环境,即演练环境或生产环境。
apiRequestIdString
API请求的ID。
countInteger
取值范围: >= 0 部署任务的总数。

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidTargetAn invalid target was specified. It must be either 'staging' or 'production' or left empty.400指定的部署环境无效。必须是'staging'或'production',或者放空。
InvalidListLimitThe value of limit should be an integer.400limit参数取值无效,必须是整数。
InvalidStartDateInvalid parameter 'startdate'. '2020-09-20T00:00:00Za' is not a valid RFC3339 timestamp in UTC. The timestamp should be in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.400startdate参数无效。必须是RFC3339 日期格式,采用UTC时区。具体格式为"yyyy-MM-dd'T'HH:mm:ss'Z'"。

示例

200
400
200
请求示例
复制代码 复制成功
#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/cdn/deploymentTasks" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json"
返回示例
复制代码 复制成功
{
    "deploy": [
        {
            "id": "094e1ecd-a2f3-425e-ac1f-c1d4fac8b686",
            "name": "DeploymentName_1573693584573",
            "submissionTime": "2019-11-14T01:06:25Z",
            "finishTime": "2019-11-14T01:09:09Z",
            "status": "succeeded",
            "target": "production",
            "apiRequestId": "43ee8bf183891802"
        }
    ],
    "count": 10
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!