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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cert:DescribeDeployment

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	integer	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 elements

Element	Type	Description	Example
	object	OpenApiDefaultResponse.
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74
Id	integer	The ID of the deployment job.	43222
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	integer	The ID of the Alibaba Cloud account in which the deployment job is created.	166688437******
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.
	object
Id	string	The ID of the contact.	3304
Name	string	The name of the contact.	John
Mobile	string	The phone number of the contact.	139****0000
Email	string	The email address of the contact.	username@example.com

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.