Query worker task details for a deployment task with ListWorkerResource - Certificate Management Service

Queries the worker tasks of a deployment task. Each worker task deploys a certificate to a specific cloud resource in a cloud service.

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:ListWorkerResource

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	integer	Yes	The ID of the deployment task. You can call the CreateDeploymentJob operation to obtain the ID of a deployment task from the ID parameter. You can also call the ListDeploymentJob operation to obtain the ID of a deployment task.	8888
Status	string	No	The status of the worker task. Valid values: rollback rollback_error success rollback_success pending scheduling processing error editing Valid values: rollback : rollback_error : success : rollback_success : pending : scheduling : processing : error : editing :	editing
CloudProduct	string	No	The cloud service in the deployment task.	NLB
CurrentPage	integer	No	The page number. Default value: 1.	1
ShowSize	integer	No	The number of entries per page. Default value: 50.	20

Response elements

Element	Type	Description	Example
	object	OpenApiPaginationResponse
Total	integer	The total number of entries returned.	8
CurrentPage	integer	The page number. Default value: 1.	1
ShowSize	integer	The number of entries per page. Default value: 50.	20
Data	array<object>	The response parameters.
	object
Id	integer	The ID of the worker task.	22487
GmtCreate	string	The time when the worker task was created. The time is a timestamp in seconds.	1680228896000
GmtModified	string	The time when the worker task was last modified. The time is a timestamp in seconds.	1681956830000
UserId	integer	The ID of the Alibaba Cloud account to which the worker task belongs.	1666884372152785
JobId	integer	The ID of the deployment task to which the worker task belongs.	8888
OrderId	integer	The order ID of the worker task, which is the same as the order ID of the certificate. Note If the CertId parameter is returned, this parameter is not returned.	9349278
CertId	integer	The ID of the certificate in the worker task.	12073663
CertDomain	string	The domain name bound to the certificate in the worker task.	www.example.com
CertInstanceId	string	The instance ID of the certificate in the worker task.	lsn-jzk2h0xz5dmynuphb8@1883
CertName	string	The name of the certificate in the worker task.	testCertName
ResourceId	integer	The ID of the cloud resource in the worker task.	1286999
CloudProduct	string	The cloud service to which the cloud resource in the worker task belongs. Valid values: CDN: Alibaba Cloud CDN (CDN). This value is supported only at the China site (aliyun.com). SLB: Classic Load Balancer (CLB). This value is supported only at the China site (aliyun.com). DCDN: Dynamic Content Delivery Network (DCDN). This value is supported only at the China site (aliyun.com). DDOS: Anti-DDoS. 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). 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).	SLB
ResourceCertId	integer	The ID of the certificate that was originally bound to the cloud resource in the worker task.	123
ResourceDomain	string	The domain name that was originally bound to the cloud resource in the worker task.	www.example.com
RegionId	string	The region ID of the cloud resource in the worker task.	cn-hangzhou
CloudRegion	string	The original region ID of the cloud resource in the worker task. The value is the region ID defined by the cloud service provider. This parameter is required only when you deploy certificates to services of multiple clouds.	cn-hangzhou
InstanceId	string	The ID of the cloud resource in the worker task. Note This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.	cas-cn-0pp118nuu40b
ListenerId	string	The listener ID of the cloud resource in the worker task. Note This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.	lsn-lhl8y7s1e1ngc3m3zz@81
Port	integer	The listening port of the cloud resource in the worker task. Note This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.	4431
DefaultResource	boolean	Indicates whether the cloud resource in the worker task is the default resource. Valid values: true false Note This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.	0
CloudName	string	The cloud service provider to which the cloud resource in the worker task belongs. Note This parameter is not returned if you deploy certificates to Alibaba Cloud services.	aliyun
NamespaceId	string	The ID of the namespace in SAE. This parameter is returned only if you deploy certificates to SAE.	32fed52a-4bf7-44f6-955f-e82ada68ef18
Status	string	The status of the worker task. Valid values: editing pending scheduling processing error success rollback rollback_success rollback_error	editing
RequestId	string	The request ID.	3E50D480-9765-5CFD-9650-9BACCECA5135

Examples

Success response

JSON format

{
  "Total": 8,
  "CurrentPage": 1,
  "ShowSize": 50,
  "Data": [
    {
      "Id": 22487,
      "GmtCreate": "1680228896000",
      "GmtModified": "1681956830000",
      "UserId": 0,
      "JobId": 8888,
      "OrderId": 9349278,
      "CertId": 12073663,
      "CertDomain": "www.example.com",
      "CertInstanceId": "lsn-jzk2h0xz5dmynuphb8@1883",
      "CertName": "testCertName",
      "ResourceId": 1286999,
      "CloudProduct": "SLB",
      "ResourceCertId": 123,
      "ResourceDomain": "www.example.com",
      "RegionId": "cn-hangzhou",
      "CloudRegion": "cn-hangzhou",
      "InstanceId": "cas-cn-0pp118nuu40b",
      "ListenerId": "lsn-lhl8y7s1e1ngc3m3zz@81",
      "Port": 4431,
      "DefaultResource": true,
      "CloudName": "aliyun",
      "NamespaceId": "32fed52a-4bf7-44f6-955f-e82ada68ef18",
      "Status": "editing"
    }
  ],
  "RequestId": "3E50D480-9765-5CFD-9650-9BACCECA5135"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.