DescribeDeploymentJob - Certificate Management Service - Alibaba Cloud Documentation Center

Queries the details of a deployment task. You can call the CreateDeploymentJob operation to create a deployment task and obtain the ID of the task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cert:DescribeDeployment	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
JobId	long	Yes	The ID of the deployment job. The ID of the job is returned after you call the CreateDeploymentJob operation. You can also call the ListDeploymentJob operation to obtain the ID.	8888

Response parameters

Parameter	Type	Description	Example
	object	OpenApiDefaultResponse.
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74
Id	long	The ID of the deployment job.	8888
GmtCreate	string	The time when the deployment job was created. The value is a UNIX timestamp. Unit: seconds.	1679541809000
GmtModified	string	The time when the deployment job was last modified. The value is a UNIX timestamp. Unit: seconds.	1679541809000
UserId	long	The ID of the Alibaba Cloud account in which the deployment job is created.	166688437XXXX785
InstanceId	string	The instance ID of the deployment task.	14dcc8afc7578e1f
Name	string	The name of the deployment task.	auto-test-AXX
CertType	string	The type of the certificate. Valid values: upload: uploaded certificate buy: purchased certificate free: free certificate available only on the China site (aliyun.com)	buy
ScheduleTime	string	The time when the deployment job was scheduled. The value is a UNIX timestamp. Unit: seconds.	1678083209335
StartTime	string	The start time of the deployment job. The value is a UNIX timestamp. Unit: seconds.	1679541809000
EndTime	string	The end time of the deployment job. The value is a UNIX timestamp. Unit: seconds.	1679541809000
Status	string	The status of the deployment job. Valid values: pending editing scheduling processing error success	editing
Del	integer	Indicates whether the deployment job was deleted. Valid values: 0: not deleted 1: deleted	1
Rollback	integer	Indicates whether the deployment job includes the rollback worker. For example, if a cloud service in a deployment job has been rolled back, 1 is returned. Valid values: 0: The rollback worker is not included. 1: The rollback worker is included.	1
JobType	string	The type of the deployment job. Valid values: cloud: multi-cloud deployment job. trustee: hosted deployment job available only on the China site (aliyun.com). user: cloud service deployment job. The cloud server is not included.	user
CertDomain	string	The domain names bound to the certificate of the deployment task.	example.aliyundoc.com,demo.aliyundoc.com
ProductName	string	The cloud services included in the deployment task.	CDN
Config	string	The configurations of the deployment task.	{\"shareCertIds\":[],\"certIds\":[12342649,12304338,12067351,9957285]}
CasContacts	array<object>	The information about the contact.
casContacts	object
Id	string	The ID of the contact.	3304
Name	string	The name of the contact.	zhangsan
Mobile	string	The phone number of the contact.	139****0000
Email	string	The email address of the contact.	username@example.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "Id": 8888,
  "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": "zhangsan",
      "Mobile": "139****0000",
      "Email": "username@example.com"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history