DescribeCerts - Web Application Firewall - Alibaba Cloud Documentation Center

Retrieves the list of certificates for 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 number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
RegionId	string	No	The region of the WAF instance. Valid values: cn-hangzhou: The Chinese mainland. ap-southeast-1: Outside the Chinese mainland.	cn-hangzhou
InstanceId	string	Yes	The ID of the WAF instance. Note Call the DescribeInstance operation to query the ID of your current WAF instance.	waf_v3prepaid_public_cn-5yd****tb02
Algorithm	string	No	The type of the encryption algorithm. Valid values: NotSM2 (default): Specifies a non-ShangMi (SM) cryptographic algorithm. SM2: Specifies an SM 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 ID of the request.	19511B0D-5AE0-5600-BB8A-DC2C8345****
TotalCount	integer	The total number of entries returned.	8
Certs	array<object>	The list of certificates.
	object	Information about the certificate.
Domain	string	The domain name for which the certificate is issued.	www.example.com
CertName	string	The name of the certificate.	waf1234
CertIdentifier	string	The globally unique ID of the certificate. The value follows a "<Certificate ID>-cn-hangzhou" format. For example, if the ID of the certificate is 123, the value of 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 time when the certificate expires.	1976256736582
BeforeDate	integer	The time when the certificate takes effect.	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.