DescribeCerts - Anti-DDoS - Alibaba Cloud Documentation Center

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

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-ddoscoo:DescribeCerts	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	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
Domain	string	No	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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc
Certs	array<object>	The certificate information about the website.
CertItem	object
EndDate	string	The expiration date of the certificate. The value is a string.	2021-09-12
DomainRelated	boolean	Indicates whether the certificate is associated with the domain name. Valid values: true false	true
StartDate	string	The issuance date of the certificate. The value is a string.	2019-09-12
Issuer	string	The certificate authority (CA) that issued the certificate.	Symantec
Name	string	The name of the certificate.	testcert
Common	string	The domain name that is associated with the certificate.	www.aliyun.com
Id	integer	The certificate ID.	81
CertIdentifier	string	The global certificate ID, which is in the certificate ID-cn-hangzhou format. If the ID of the certificate is 123, CertIdentifier is 123-cn-hangzhou.	126345-ap-southeast-1

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,
      "CertIdentifier": "126345-ap-southeast-1"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-07-18	The response structure of the API has changed	View Change Details