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

Retrieves a list of deployment tasks after you create a deployment 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:ListDeploymentJob

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobType	string	No	The task type. Valid values: cloud : multi-cloud deployment task. user : cloud service deployment task (excluding ECS instances)	user
Status	string	No	The deployment task status. Valid values: success : deployment succeeded. pending : pending. scheduling : scheduling. processing : deploying. error : deployment failed. editing : editing.	pending
CurrentPage	integer	No	The page number. Default value: 1.	1
ShowSize	integer	No	The number of certificates to display per page in a paged query. Default value: 50.	50

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each request. You can use this ID to troubleshoot issues.	12345678-1234-1234-1234-123456789ABC
Total	integer	The total number of deployment tasks returned.	7
CurrentPage	integer	The current page number. Default value: 1.	1
ShowSize	integer	The number of deployment tasks per page. Default value: 50.	50
Data	array<object>	The data returned by the API.
	object	The objects in the data.
Id	integer	The deployment task ID. You can use this ID to query the deployment task details and status.	19975
GmtCreate	string	The time when the deployment task was created, in UNIX timestamp format (seconds).	1624343180000
GmtModified	string	The time when the deployment task was last modified, in UNIX timestamp format (seconds).	1606482979000
UserId	integer	The user account ID (UID).	166688437*****
InstanceId	string	The instance ID of the deployment task.	cas-job-user-***
Name	string	The name of the deployment task.	job-test
CertType	string	The certificate type. Valid values: upload: uploaded certificate buy: purchased certificate free: personal test certificate (supported only on the China site)	upload
ScheduleTime	string	The scheduled time of the task, in UNIX timestamp format (seconds).	1606482979000
StartTime	string	The start time of the deployment task execution, in UNIX timestamp format (seconds).	1606482979000
EndTime	string	The end time of the deployment task execution, in UNIX timestamp format (seconds).	1606482979000
Status	string	The deployment task status. Valid values: pending: pending execution. editing: being edited. scheduling: being scheduled. processing: being deployed. error: deployment failed. success: deployment succeeded.	scheduling
Del	integer	The deletion flag. This parameter has no practical significance. Valid values: 0: not deleted. 1: deleted.	1
Rollback	integer	Indicates whether the task contains a rollback worker. For example, if a cloud service in the task has been rolled back, the value 1 is returned. Valid values: 0: does not contain a rollback worker. 1: contains a rollback worker.	1
JobType	string	The task type. Valid values: cloud: multi-cloud deployment task. user: cloud service deployment task (excluding ECS instances).	user
CertDomain	string	The domain names included in the certificate of the deployment task.	aliyundoc1.com,aliyundoc2.com,aliyundoc3.com
ProductName	string	The cloud services included in the deployment task resources.	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.