All Products
Search
Document Center

Certificate Management Service:ListDeploymentJob

Last Updated:Feb 27, 2025

Queries a list of deployment tasks that are created.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cert:ListDeploymentJoblist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobTypestringNo

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.
user
StatusstringNo

The status of the deployment task.

Valid values:

  • success
  • pending
  • scheduling
  • processing
  • error
  • editing
pending
CurrentPageintegerNo

The page number. Default value: 1.

1
ShowSizeintegerNo

The number of certificates per page. Default value: 50.

20

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

12345678-1234-1234-1234-123456789ABC
Totallong

The total number of deployment tasks returned.

7
CurrentPageinteger

The page number. Default value: 1.

1
ShowSizeinteger

The number of deployment tasks per page. Default value: 50.

20
Dataarray<object>

The data returned for the request.

Dataobject
Idlong

The ID of the deployment task. You can use the ID to query the details and status of the deployment task.

19975
GmtCreatestring

The time when the deployment task was created.

1624343180000
GmtModifiedstring

The time when the deployment task was last modified.

1606482979000
UserIdlong

The ID of the user.

1666884372152785
InstanceIdstring

The instance ID of the deployment task.

cas-job-user-0gvntn
Namestring

The name of the deployment task.

job-test
CertTypestring

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
ScheduleTimestring

The time when the deployment task was scheduled.

1606482979000
StartTimestring

The start time of the deployment task.

1606482979000
EndTimestring

The end time of the deployment task.

1606482979000
Statusstring

The status of the deployment task. Valid values:

  • pending
  • editing
  • scheduling
  • processing
  • error
  • success
scheduling
Delinteger

Indicates whether the deployment task is deleted. Valid values:

  • 0: not deleted
  • 1: deleted
1
Rollbackinteger

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
JobTypestring

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
CertDomainstring

The domain names bound to the certificate of the deployment task.

aliyundoc1.com,aliyundoc2.com,aliyundoc3.com
ProductNamestring

The cloud service included in the resources of the deployment task.

NLB

Examples

Sample success responses

JSONformat

{
  "RequestId": "12345678-1234-1234-1234-123456789ABC",
  "Total": 7,
  "CurrentPage": 1,
  "ShowSize": 20,
  "Data": [
    {
      "Id": 19975,
      "GmtCreate": "1624343180000",
      "GmtModified": "1606482979000",
      "UserId": 1666884372152785,
      "InstanceId": "cas-job-user-0gvntn",
      "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

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

Change history

Change timeSummary of changesOperation
No change history