All Products
Search
Document Center

Web Application Firewall:DescribeCerts

Last Updated:Nov 15, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:DescribeCertsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainstringNo

The domain name.

example.aliyun.com
PageNumberlongNo

The page number. Default value: 1.

1
PageSizelongNo

The number of entries per page. Valid values: 1 to 100. Default value: 10.

10
RegionIdstringNo

The region in which the WAF instance is deployed. Valid values:

  • cn-hangzhou: Chinese mainland.
  • ap-southeast-1: outside the Chinese mainland.
cn-hangzhou
InstanceIdstringYes

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
AlgorithmstringNo

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
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfmoiy****p2oq

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

19511B0D-5AE0-5600-BB8A-DC2C8345****
TotalCountlong

The total number of entries returned.

8
Certsarray<object>

The certificates.

Certobject
Domainstring

The domain name that is added to WAF.

www.example.com
CertNamestring

The name of the certificate.

waf1234
CertIdentifierstring

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
CommonNamestring

The common name.

*.example.com
IsChainCompletedboolean

Indicates whether the certificate chain is complete. Valid values:

  • true
  • false
true
AfterDatelong

The time when the certificate becomes valid.

1976256736582
BeforeDatelong

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.