DescribeCerts - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the certificates issued for your domain names that are added to Web Application Firewall (WAF).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-waf:DescribeCerts	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Domain	string	No	The domain name.	example.aliyun.com
PageNumber	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
RegionId	string	No	The region in which the WAF instance is deployed. Valid values: cn-hangzhou: Chinese mainland. ap-southeast-1: Outside the Chinese mainland.	ap-southeast-1
InstanceId	string	Yes	The ID of the WAF instance. Note You can call the DescribeInstance operation to query the ID of the WAF instance.	waf_v3prepaid_public_cn-5yd****tb02
Algorithm	string	No	The type of the encryption algorithm. Valid values: NotSM2: The encryption algorithm is not the SM2 algorithm. This is the default value. SM2: The encryption algorithm is the SM2 algorithm.	SM2
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfmoiy****p2oq

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	19511B0D-5AE0-5600-BB8A-DC2C8345****
TotalCount	long	The total number of entries returned.	8
Certs	array<object>	The certificates.
Cert	object	The information about the certificate.
Domain	string	The domain that is supported by the certificate.	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>-ap-southeast-1" format. For example, if the ID of the certificate is 123, the value of the CertIdentifier parameter is 123-ap-southeast-1.	123-ap-southeast-1
CommonName	string	The common name.	*.example.com
IsChainCompleted	boolean	Indicates whether the certificate chain is complete. Valid values: true false	true
AfterDate	long	The expiration time.	1976256736582
BeforeDate	long	The effective time.	1976256836582

Examples

Sample success responses

JSONformat

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

Error codes

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