All Products
Search
Document Center

Certificate Management Service:DescribeDeploymentJobStatus

Last Updated:Feb 27, 2025

Queries the number of worker tasks in a deployment 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.

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:DescribeDeploymentJobStatusget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdlongNo

The ID of the deployment task. You can call the CreateDeploymentJob operation to obtain the ID of a deployment task from the JobId parameter. You can also call the ListDeploymentJob operation to obtain the ID of a deployment task.

8888

Response parameters

ParameterTypeDescriptionExample
object

OpenApiDefaultResponse

RequestIdstring

The request ID.

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
ResourceCountinteger

The total number of resources.

4127
UseCountinteger

The total number of used resources.

300
BuyCountinteger

The total number of purchased resources.

500
WorkerCountinteger

The total number of resources to which certificate are deployed in the current cloud service. The value indicates the total number of worker tasks.

20
MatchWorkerCountinteger

The total number of worker tasks that match the certificate.

20
SuccessCountinteger

The number of successful worker tasks, excluding rollback tasks.

20
FailedCountinteger

The number of failed worker tasks, excluding rollback tasks.

20
RollbackCountinteger

The number of worker tasks that are rolled backed.

20
RollbackSuccessCountinteger

The number of worker tasks that are successfully rolled back.

20
RollbackFailedCountinteger

The number of worker tasks that failed to be rolled back.

20
CostCountinteger

The number of resources consumed by worker tasks.

20
CertCountinteger

The number of certificates involved in the deployment task.

20
ProductWorkerCountarray<object>

The number of cloud resources to which certificates are deployed in the deployment task.

ProductWorkerCountobject
ProductNamestring

The name of the cloud service. Valid values:

  • SLB: Classic Load Balancer (CLB). This value is supported only at the China site (aliyun.com).
  • LIVE: ApsaraVideo Live. This value is supported only at the China site (aliyun.com).
  • webHosting: Cloud Web Hosting. This value is supported only at the China site (aliyun.com).
  • VOD: ApsaraVideo VOD. This value is supported only at the China site (aliyun.com).
  • CR: Container Registry. This value is supported only at the China site (aliyun.com).
  • DCDN: Dynamic Content Delivery Network (DCDN).
  • DDOS: Anti-DDoS.
  • CDN: Alibaba Cloud CDN (CDN).
  • ALB: Application Load Balancer (ALB).
  • APIGateway: API Gateway.
  • FC: Function Compute.
  • GA: Global Accelerator (GA).
  • MSE: Microservices Engine (MSE).
  • NLB: Network Load Balancer (NLB).
  • OSS: Object Storage Service (OSS).
  • SAE: Serverless App Engine (SAE).
  • TencentCDN: Tencent Cloud Content Delivery Network (CDN).
  • WAF: Web Application Firewall (WAF).
NLB
Countinteger

The total number of resources of a cloud service in the deployment task.

2

Examples

Sample success responses

JSONformat

{
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "ResourceCount": 4127,
  "UseCount": 300,
  "BuyCount": 500,
  "WorkerCount": 20,
  "MatchWorkerCount": 20,
  "SuccessCount": 20,
  "FailedCount": 20,
  "RollbackCount": 20,
  "RollbackSuccessCount": 20,
  "RollbackFailedCount": 20,
  "CostCount": 20,
  "CertCount": 20,
  "ProductWorkerCount": [
    {
      "ProductName": "NLB",
      "Count": 2
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history