DescribeDcdnDomainCertificateInfo - Edge Security Acceleration

Call the DescribeDcdnDomainCertificateInfo operation to query the certificate information for a specified domain name.

Operation description

Note

The call frequency limit for a single user is 100 calls per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dcdn:DescribeDcdnDomainCertificateInfo

get

domain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can query only one domain name at a time.	example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5C1E43DC-9E51-4771-82C0-7D5ECEB547A1
CertInfos	object
CertInfo	array<object>	The certificate information.
	object
Status	string	The status of the certificate. success: The certificate is active. checking: The system is checking whether the domain name is accelerated by Alibaba Cloud DCDN. cname_error: The domain name is not mapped to Alibaba Cloud DCDN. domain_invalid: The domain name contains invalid characters. unsupport_wildcard: Wildcard domain names are not supported. applying: The certificate is being applied for. get_token_timeout: The Certificate Signing Request (CSR) timed out. check_token_timeout: The verification timed out. get_cert_timeout: The request to obtain the certificate timed out. failed: The certificate application failed.	success
CertLife	string	The validity period of the certificate. The unit can be months or years.	3 months
CertExpireTime	string	The expiration time of the certificate.	2018-06-03T22:03:39Z
SSLPub	string	The public key of the certificate.	xxxx
SSLProtocol	string	The HTTPS status. on: Enabled. off: Disabled.	on
CertType	string	The type of the certificate. cas: An Alibaba Cloud Security certificate. upload: A custom certificate that you uploaded.	cas
CertDomainName	string	The domain name that is associated with the certificate.	example.com
CertName	string	The name of the certificate.	cert-example.com
CertOrg	string	The certificate authority (CA) that issued the certificate.	Let's Encrypt
DomainName	string	The accelerated domain name.	example.com
CertId	string	The ID of the certificate.	9002448
CertRegion	string	The region where the certificate is used.	cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "5C1E43DC-9E51-4771-82C0-7D5ECEB547A1",
  "CertInfos": {
    "CertInfo": [
      {
        "Status": "success",
        "CertLife": "3 months",
        "CertExpireTime": "2018-06-03T22:03:39Z",
        "SSLPub": "xxxx",
        "SSLProtocol": "on",
        "CertType": "cas",
        "CertDomainName": "example.com",
        "CertName": "cert-example.com",
        "CertOrg": "Let's Encrypt",
        "DomainName": "example.com",
        "CertId": "9002448",
        "CertRegion": "cn-hangzhou"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.