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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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.	cn-hangzhou
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	object []	The certificates.
Domain	string	The domain name that is added to WAF.	www.example.com
CertName	string	The name of the certificate.	waf1234
CertIdentifier	string	The globally unique ID of the certificate. The value is in the "Certificate ID-cn-hangzhou" format. For example, if the ID of the certificate is 123, the value of CertIdentifier is 123-cn-hangzhou.	1234567-cn-hangzhou
CommonName	string	The common name.	*.example.com
IsChainCompleted	boolean	Indicates whether the certificate chain is complete. Valid values: true false	true
AfterDate	long	The time when the certificate becomes valid.	1976256736582
BeforeDate	long	The time when the certificate expires.	1976256836582

Examples

Sample success responses

JSONformat

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

Error codes

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