ListDeploymentJob - 获取部署任务列表 - 数字证书管理服务

创建部署任务后，您可以通过该接口获取部署任务列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-cert:ListDeploymentJob	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
JobType	string	否	任务类型。枚举值： cloud：多云部署任务。 user：云产品部署任务（不含云服务器）。	user
Status	string	否	部署任务状态。枚举值： success：部署成功。 pending：待执行。 scheduling：调度中。 processing：部署中。 error：部署失败。 editing：编辑中。	pending
CurrentPage	integer	否	分页。当前页，默认 1。	1
ShowSize	integer	否	分页查询时，设置每页显示证书的数量。默认值为 50。	50

返回参数

名称	类型	描述	示例值
	object	返回对象。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	12345678-1234-1234-1234-123456789ABC
Total	long	查询到的部署任务总数。	7
CurrentPage	integer	分页，表示当前页，默认 1。	1
ShowSize	integer	每页包含部署任务的个数。默认值为 50。	50
Data	array<object>	请求接口返回的数据。
	object	数据中的对象。
Id	long	部署任务 ID。后续可用于查询部署任务详情、部署任务状态等。	19975
GmtCreate	string	部署任务创建时间（秒，时间戳格式）。	1624343180000
GmtModified	string	部署任务上次修订时间（秒，时间戳格式）。	1606482979000
UserId	long	用户账号 ID（UID）。	166688437*****
InstanceId	string	部署任务实例 ID。	cas-job-user-***
Name	string	部署任务名称。	job-test
CertType	string	证书类型。 upload：上传证书 buy：自购证书 free：个人测试证书（仅中国站支持）	upload
ScheduleTime	string	任务调度时间。	1606482979000
StartTime	string	部署任务执行开始时间（秒，时间戳格式）。	1606482979000
EndTime	string	部署任务执行结束时间（秒，时间戳格式）。	1606482979000
Status	string	部署任务状态。 pending：待执行 editing：编辑中 scheduling：调度中 processing：部署中 error：部署失败 success：部署成功	scheduling
Del	integer	删除标识，无实际意义。 0：未删除 1：已删除	1
Rollback	integer	是否包含回滚任务 worker。例如某个任务中的某个云产品执行过回滚，则返回 1。 0：不包含回滚任务 worker 1：包含回滚任务 worker	1
JobType	string	任务类型。 cloud：多云部署任务 user：云产品部署任务（不含云服务器）	user
CertDomain	string	部署任务证书包含的域名。	aliyundoc1.com,aliyundoc2.com,aliyundoc3.com
ProductName	string	部署任务资源包含云产品。	NLB

示例

正常返回示例

JSON格式

{
  "RequestId": "12345678-1234-1234-1234-123456789ABC",
  "Total": 7,
  "CurrentPage": 1,
  "ShowSize": 50,
  "Data": [
    {
      "Id": 19975,
      "GmtCreate": "1624343180000",
      "GmtModified": "1606482979000",
      "UserId": 0,
      "InstanceId": "cas-job-user-***",
      "Name": "job-test",
      "CertType": "upload",
      "ScheduleTime": "1606482979000",
      "StartTime": "1606482979000",
      "EndTime": "1606482979000",
      "Status": "scheduling",
      "Del": 1,
      "Rollback": 1,
      "JobType": "user",
      "CertDomain": "aliyundoc1.com,aliyundoc2.com,aliyundoc3.com",
      "ProductName": "NLB"
    }
  ]
}

错误码

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