Call ListCloudResources to query certificate resources of cloud providers and services - Certificate Management Service

Queries the cloud resources on which certificates are deployed, such as Server Load Balancer (SLB) instances and CDN domains.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CloudName	string	No	The cloud service provider. Valid values: Tencent Huawei Aws aliyun Valid values: Tencent : Huawei : Aws : aliyun :	Tencent
CloudProduct	string	No	The cloud service name. Used to filter resources by cloud service. Valid values when CloudName is set to aliyun: SLB: Classic Load Balancer (CLB). This value is available only on the China site (aliyun.com). LIVE: ApsaraVideo Live. This value is available only on the China site (aliyun.com). webHosting: Cloud Web Hosting. This value is available only on the China site (aliyun.com). VOD: ApsaraVideo VOD. This value is available only on the China site (aliyun.com). CR: Container Registry. This value is available only on 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). WAF: Web Application Firewall (WAF). Valid values when CloudName is set to Tencent: TencentCDN: Content Delivery Network (CDN). TencentCLB: CLB. TencentWAF: WAF. Valid value when CloudName is set to Huawei: HuaweiCDN: CDN. Valid values when CloudName is set to Aws: AwsCloudFront: Amazon CloudFront. AwsCLB: CLB. AwsALB: ALB. AwsNLB: NLB.	SLB
SecretId	string	No	The AccessKey ID that is used to access cloud resources.	21
Keyword	string	No	The keyword of the domain name or instance ID bound to the cloud resource.	cert-instanceId
CurrentPage	integer	No	The page number. Default value: 1.	1
ShowSize	integer	No	The number of entries per page. Default value: 20.	20
CertIds	array	No	The certificate IDs. Separate multiple IDs with commas (,).
	integer	No	The certificate ID.	14440149

Response elements

Element	Type	Description	Example
	object	OpenApiPaginationResponse.
Total	integer	The total number of entries returned.	440
CurrentPage	integer	The page number. Default value: 1.	1
ShowSize	integer	The number of entries per page. Default value: 20.	20
Data	array<object>	The data returned for the request.
	object
Id	integer	The ID of the cloud resource.	2356
GmtCreate	string	The time when the cloud resource was created. The time is a timestamp in seconds.	1673423339000
GmtModified	string	The time when the cloud resource was last modified. The time is a timestamp in seconds.	1696911946000
CloudProduct	string	The cloud service.	ALB
UserId	integer	The ID of the Alibaba Cloud account.	1666884372152785
CertId	integer	The ID of the certificate bound to the cloud resource.	12433121
CertName	string	The name of the certificate bound to the cloud resource.	shop.amsaudio.cn
CertEndTime	string	The end date of the certificate bound to the cloud resource. The value is a timestamp in seconds.	1737795520000
CertStartTime	string	The start date of the certificate bound to the cloud resource. The value is a timestamp in seconds.	1706259520000
Domain	string	The domain name bound to the cloud resource.	www.tkgeo.ru
InstanceId	string	The instance ID of the cloud resource. Note This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.	nlb-rv05agjc97ovm14il5
ListenerId	string	The listener ID of the cloud resource. Note This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.	lsn-jiugof6t23et66lsnc@443
ListenerPort	string	The listening port of the cloud resource. Note This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.	8047
EnableHttps	integer	Indicates whether HTTPS is enabled for the cloud resource. Valid values: 1: yes. 0: no. Valid values: 0 : 1 :	1
DefaultResource	integer	Indicates whether the cloud resource is the default resource. Valid values: 1: yes 0: no Note This parameter is returned only when the value of CloudProduct is SLB, NLB, ALB, or GA.	0
Status	string	The status of the cloud resource.	BUY
UseSsl	integer	Indicates whether an Alibaba Cloud SSL certificate is used. Valid values: 1: yes 0: no Note This parameter is required only when you deploy certificates to services of multiple clouds.	1
RegionId	string	The region ID of the cloud resource.	cn-hangzhou
CloudName	string	The cloud service provider. Valid values: Tencent Huawei Aws aliyun Valid values: Tencent : Huawei : Aws : aliyun :	aliyun
CloudRegion	string	The region ID of the cloud service provider to which the cloud resource belongs.	cn-hangzhou
CloudAccessId	string	The AccessKey ID that is used to access cloud resources. Note This parameter is returned only when you deploy certificates to cloud services of third-party clouds.	1234
RequestId	string	The request ID.	12345678-1234-1234-1234-123456789ABC

Examples

Success response

JSON format

{
  "Total": 440,
  "CurrentPage": 1,
  "ShowSize": 20,
  "Data": [
    {
      "Id": 2356,
      "GmtCreate": "1673423339000",
      "GmtModified": "1696911946000",
      "CloudProduct": "ALB",
      "UserId": 0,
      "CertId": 12433121,
      "CertName": "example",
      "CertEndTime": "1737795520000",
      "CertStartTime": "1706259520000",
      "Domain": "example.com",
      "InstanceId": "nlb-rv05a********14il5",
      "ListenerId": "lsn-jiug********66lsnc@443",
      "ListenerPort": "443",
      "EnableHttps": 1,
      "DefaultResource": 0,
      "Status": "BUY",
      "UseSsl": 1,
      "RegionId": "cn-hangzhou",
      "CloudName": "aliyun",
      "CloudRegion": "cn-hangzhou\n",
      "CloudAccessId": "AK96*******6M"
    }
  ],
  "RequestId": "12345678-1234-1234-1234-123456789ABC"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.