DescribeDeploymentJobStatus - Certificate Management Service

Queries the number of worker tasks in 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:DescribeDeploymentJobStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	integer	No	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 elements

Element	Type	Description	Example
	object	OpenApiDefaultResponse
RequestId	string	The request ID.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
ResourceCount	integer	The total number of resources.	4127
UseCount	integer	The total number of used resources.	300
BuyCount	integer	The total number of purchased resources.	500
WorkerCount	integer	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
MatchWorkerCount	integer	The total number of worker tasks that match the certificate.	20
SuccessCount	integer	The number of successful worker tasks, excluding rollback tasks.	20
FailedCount	integer	The number of failed worker tasks, excluding rollback tasks.	20
RollbackCount	integer	The number of worker tasks that are rolled backed.	20
RollbackSuccessCount	integer	The number of worker tasks that are successfully rolled back.	20
RollbackFailedCount	integer	The number of worker tasks that failed to be rolled back.	20
CostCount	integer	The number of resources consumed by worker tasks.	20
CertCount	integer	The number of certificates involved in the deployment task.	20
ProductWorkerCount	array<object>	The number of cloud resources to which certificates are deployed in the deployment task.
	object
ProductName	string	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
Count	integer	The total number of resources of a cloud service in the deployment task.	2

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.