All Products
Search
Document Center

Certificate Management Service:ListWorkerResource

Last Updated:Jul 31, 2024

Queries the details about the worker tasks of a deployment task. Alibaba Cloud allows you to deploy multiple certificates at a time. Therefore, a deployment task may include multiple worker tasks in multiple cloud services. A worker task refers to a task that deploys a certificate to a cloud resource in a cloud service.

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
JobIdlongYes

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
StatusstringNo

The status of the worker task.

Valid values:

  • rollback
  • rollback_error
  • success
  • rollback_success
  • pending
  • scheduling
  • processing
  • error
  • editing
editing
CloudProductstringNo

The cloud service in the deployment task.

NLB
CurrentPageintegerNo

The page number. Default value: 1.

1
ShowSizeintegerNo

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

20

Response parameters

ParameterTypeDescriptionExample
object

OpenApiPaginationResponse

Totallong

The total number of entries returned.

8
CurrentPageinteger

The page number. Default value: 1.

1
ShowSizeinteger

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

20
Dataarray<object>

The response parameters.

object
Idlong

The ID of the worker task.

22487
GmtCreatestring

The time when the worker task was created. The time is a timestamp in seconds.

1680228896000
GmtModifiedstring

The time when the worker task was last modified. The time is a timestamp in seconds.

1681956830000
UserIdlong

The ID of the Alibaba Cloud account to which the worker task belongs.

1666884372152785
JobIdlong

The ID of the deployment task to which the worker task belongs.

8888
OrderIdlong

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
CertIdlong

The ID of the certificate in the worker task.

12073663
CertDomainstring

The domain name bound to the certificate in the worker task.

www.example.com
CertInstanceIdstring

The instance ID of the certificate in the worker task.

lsn-jzk2h0xz5dmynuphb8@1883
CertNamestring

The name of the certificate in the worker task.

testCertName
ResourceIdlong

The ID of the cloud resource in the worker task.

1286999
CloudProductstring

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
ResourceCertIdlong

The ID of the certificate that was originally bound to the cloud resource in the worker task.

123
ResourceDomainstring

The domain name that was originally bound to the cloud resource in the worker task.

www.example.com
RegionIdstring

The region ID of the cloud resource in the worker task.

cn-hangzhou
CloudRegionstring

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
InstanceIdstring

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
ListenerIdstring

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
Portinteger

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
DefaultResourceboolean

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
CloudNamestring

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
NamespaceIdstring

The ID of the namespace in SAE. This parameter is returned only if you deploy certificates to SAE.

32fed52a-4bf7-44f6-955f-e82ada68ef18
Statusstring

The status of the worker task. Valid values:

  • editing
  • pending
  • scheduling
  • processing
  • error
  • success
  • rollback
  • rollback_success
  • rollback_error
editing
RequestIdstring

The request ID.

3E50D480-9765-5CFD-9650-9BACCECA5135

Examples

Sample success responses

JSONformat

{
  "Total": 8,
  "CurrentPage": 1,
  "ShowSize": 20,
  "Data": [
    {
      "Id": 22487,
      "GmtCreate": "1680228896000",
      "GmtModified": "1681956830000",
      "UserId": 1666884372152785,
      "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

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