Query the list of certificates using DescribeCerts - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Queries the certificate list of a user.

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-waf:DescribeCerts

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
Domain	string	No	The domain name.	example.aliyun.com
PageNumber	integer	No	The page number of the paged query. Default value: 1.	1
PageSize	integer	No	The number of rows per page in a paged query. Default value: 10. Maximum value: 100.	10
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
InstanceId	string	Yes	Instance ID of the WAF instance. Note You can call the DescribeInstance operation to query instance ID of the current WAF instance.	waf_v3prepaid_public_cn-5yd****tb02
Algorithm	string	No	The type of encryption algorithm. Valid values: NotSM2 (default): a non-Chinese cryptographic algorithm. SM2: a Chinese cryptographic algorithm.	SM2
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfmoiy****p2oq

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	19511B0D-5AE0-5600-BB8A-DC2C8345****
TotalCount	integer	The total number of entries returned.	8
Certs	array<object>	The certificate list.
	object	The certificate object.
Domain	string	The domain name supported by the certificate.	www.example.com
CertName	string	The certificate name.	waf1234
CertIdentifier	string	The global certificate ID, which is in the format of certificate ID + "-cn-hangzhou". For example, if the certificate ID is 123, the CertIdentifier is "123-cn-hangzhou".	12345-cn-hangzhou
CommonName	string	The common name.	*.example.com
IsChainCompleted	boolean	Indicates whether the certificate chain is complete. Valid values: true: The certificate chain is complete. false: The certificate chain is incomplete.	true
AfterDate	integer	The expiration time. The value is a UNIX timestamp in milliseconds.	1976256736582
BeforeDate	integer	The effective period. The value is a UNIX timestamp in the format of milliseconds (ms).	1976256836582

Examples

Success response

JSON format

{
  "RequestId": "19511B0D-5AE0-5600-BB8A-DC2C8345****",
  "TotalCount": 8,
  "Certs": [
    {
      "Domain": "www.example.com\t\n",
      "CertName": "waf1234",
      "CertIdentifier": "12345-cn-hangzhou",
      "CommonName": "*.example.com\t",
      "IsChainCompleted": true,
      "AfterDate": 1976256736582,
      "BeforeDate": 1976256836582
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.