Queries the certificate information of a website.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCerts

The operation that you want to perform. Set the value to DescribeCerts.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance
ResourceGroupId String No default

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.

Domain String No www.aliyun.com

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.

Response parameters

Parameter Type Example Description
Certs Array

The certificate information of the website.
Common String www.aliyun.com

The domain name associated with the certificate.
DomainRelated Boolean true

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

  • true
  • false
EndDate String 2021-09-12

The expiration date of the certificate. This value is of the STRING type.
Id Integer 81

The ID of the certificate.
Issuer String Symantec

The authority that issues the certificate.
Name String testcert

The name of the certificate.
StartDate String 2019-09-12

The issuance date of the certificate. This value is of the STRING type.
RequestId String 0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeCerts
&<Common request parameters>

Sample success responses

XML format 

<DescribeCertsResponse>
        <RequestId>0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc</RequestId>
        <Certs>
                <Id>81</Id>
                <Name>testcert</Name>
                <Common>www.aliyun.com</Common>
                <DomainRelated>true</DomainRelated>
                <Issuer>Symantec</Issuer>
                <StartDate>2019-09-12</StartDate>
                <EndDate>2021-09-12</EndDate>
        </Certs>
</DescribeCertsResponse>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.