DescribeDeploymentJob - 获取部署任务详情

更新时间:
复制为 MD 格式

通过CreateDeploymentJob创建部署任务后会获取任务ID,您可以通过该任务ID调用本接口获取部署任务详情。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cert:DescribeDeployment

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

JobId

integer

部署任务 ID。此处 ID 为 CreateDeploymentJob 返回的任务 ID。也可通过 ListDeploymentJob 接口获取。

8888

返回参数

名称

类型

描述

示例值

object

OpenApiDefaultResponse

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

15C66C7B-671A-4297-9187-2C4477247A74

Id

integer

部署任务 ID。

43222

GmtCreate

string

部署任务创建时间(秒,时间戳格式)。

1679541809000

GmtModified

string

部署任务上次修订时间(秒,时间戳格式)。

1679541809000

UserId

integer

部署任务创建人的阿里云账号 ID。

166688437******

InstanceId

string

部署任务实例 ID。

14dcc8afc7578e1f

Name

string

部署任务名称。

auto-test-AXX

CertType

string

证书类型。

  • upload:上传证书

  • buy:自购证书

  • free:个人测试证书(仅中国站支持)

buy

ScheduleTime

string

部署任务计划调度时间(秒,时间戳格式)。

1678083209335

StartTime

string

部署任务执行的开始时间(秒,时间戳格式)。

1679541809000

EndTime

string

部署任务执行的结束时间(秒,时间戳格式)。

1679541809000

Status

string

部署任务状态。

  • pending:待执行

  • editing:编辑中

  • scheduling:调度中

  • processing:部署中

  • error:部署失败

  • success:部署成功

editing

Del

integer

删除标识,无实际意义。

  • 0:未删除

  • 1:已删除

1

Rollback

integer

是否包含回滚任务 worker。例如某个部署任务中的某个云产品执行过回滚,则返回 1

  • 0:不包含回滚任务 worker

  • 1:包含回滚任务 worker

1

JobType

string

任务类型。

  • cloud:多云部署任务

  • trustee:托管部署任务(仅中国站)

  • user:云产品部署任务(不含云服务器)

user

CertDomain

string

部署任务证书包含域名(多个)。

example.aliyundoc.com,demo.aliyundoc.com

ProductName

string

部署任务资源包含云产品(多个)。

CDN

Config

string

部署任务配置。

{\"shareCertIds\":[],\"certIds\":[12342649,12304338,12067351,9957285]}

CasContacts

array<object>

联系人信息。

object

Id

string

联系人 ID。

3304

Name

string

联系人姓名。

John

Mobile

string

指定的手机号码。

139****0000

Email

string

联系人邮箱。

username@example.com

示例

正常返回示例

JSON格式

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "Id": 43222,
  "GmtCreate": "1679541809000",
  "GmtModified": "1679541809000",
  "UserId": 0,
  "InstanceId": "14dcc8afc7578e1f",
  "Name": "auto-test-AXX",
  "CertType": "buy",
  "ScheduleTime": "1678083209335",
  "StartTime": "1679541809000",
  "EndTime": "1679541809000",
  "Status": "editing",
  "Del": 1,
  "Rollback": 1,
  "JobType": "user",
  "CertDomain": "example.aliyundoc.com,demo.aliyundoc.com",
  "ProductName": "CDN",
  "Config": "{\\\"shareCertIds\\\":[],\\\"certIds\\\":[12342649,12304338,12067351,9957285]}",
  "CasContacts": [
    {
      "Id": "3304",
      "Name": "John",
      "Mobile": "139****0000",
      "Email": "username@example.com"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情