Query a list of deployment tasks by calling ListDeploymentJob - Certificate Management Service

Queries the certificate deployment tasks that are created in your account.

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:ListDeploymentJob

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobType	string	No	The type of the deployment task. Valid values: cloud: multi-cloud deployment task. user: cloud service deployment task. This type of task does not support Elastic Compute Service (ECS) instances. Valid values: cloud : user :	user
Status	string	No	The status of the deployment task. Valid values: success pending scheduling processing error editing Valid values: success : success pending : pending scheduling : scheduling processing : processing error : error editing : editing	pending
CurrentPage	integer	No	The page number. Default value: 1.	1
ShowSize	integer	No	The number of entries to return on each page. Default value: 50.	20

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	12345678-1234-1234-1234-123456789ABC
Total	integer	The total number of deployment tasks returned.	7
CurrentPage	integer	The page number. Default value: 1.	1
ShowSize	integer	The number of deployment tasks per page. Default value: 50.	20
Data	array<object>	The data returned for the request.
	object
Id	integer	The ID of the deployment task. You can use the ID to query the details and status of the deployment task.	19975
GmtCreate	string	The time when the deployment task was created.	1624343180000
GmtModified	string	The time when the deployment task was last modified.	1606482979000
UserId	integer	The ID of the user.	1666884372152785
InstanceId	string	The instance ID of the deployment task.	cas-job-user-0gvntn
Name	string	The name of the deployment task.	job-test
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)	upload
ScheduleTime	string	The time when the deployment task was scheduled.	1606482979000
StartTime	string	The start time of the deployment task.	1606482979000
EndTime	string	The end time of the deployment task.	1606482979000
Status	string	The status of the deployment task. Valid values: pending editing scheduling processing error success	scheduling
Del	integer	Indicates whether the deployment task is deleted. Valid values: 0: not deleted 1: deleted	1
Rollback	integer	Indicates whether the rollback worker is included. For example, if a cloud service involved in a deployment task 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 task. cloud: multi-cloud deployment task. user: cloud service deployment task. This type of task does not support ECS instances.	user
CertDomain	string	The domain names bound to the certificate of the deployment task.	aliyundoc1.com,aliyundoc2.com,aliyundoc3.com
ProductName	string	The cloud service included in the resources of the deployment task.	NLB

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.