All Products
Search
Document Center

Anti-DDoS:DescribeCerts

Last Updated:Apr 16, 2024

Queries information about all certificates that can be associated with the current domain name instead of the certificate currently in use. To query the information about the certificate that is currently in use, you can call the DescribeWebRules operation and view the values of the CertName and CertRegion response parameters.

Debugging

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

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-ddoscoo:DescribeCertsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

default
DomainstringNo

The domain name of the website.

Note A forwarding rule must be configured for the domain name. You can call the DescribeDomains operation to query all domain names.
www.aliyun.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc
Certsobject []

The certificate information about the website.

EndDatestring

The expiration date of the certificate. string

2021-09-12
DomainRelatedboolean

Indicates whether the certificate is associated with the domain name. Valid values:

  • true: The certificate is associated with the domain name.
  • false: The certificate is not associated with the domain name.
true
StartDatestring

The issuance date of the certificate. string

2019-09-12
Issuerstring

The certificate authority (CA) that issued the certificate.

Symantec
Namestring

The name of the certificate.

testcert
Commonstring

The domain name that is associated with the certificate.

www.aliyun.com
Idinteger

The ID of the certificate.

81

Examples

Sample success responses

JSONformat

{
  "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc",
  "Certs": [
    {
      "EndDate": "2021-09-12",
      "DomainRelated": true,
      "StartDate": "2019-09-12",
      "Issuer": "Symantec",
      "Name": "testcert",
      "Common": "www.aliyun.com",
      "Id": 81
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-07-18The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.