All Products
Search
Document Center

Certificate Management Service:DescribeDeploymentJobStatus

Last Updated:Jul 31, 2024

Queries the number of worker tasks in a deployment task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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.

object
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.