DescribeCertDomains

Last updated: 2020-04-23 18:42:46

PDF

1. API Description

Domain name for API request: cdn.tencentcloudapi.com.

This API is used to verify an SSL certificate and extract the domain names. It will then return the list of domain names connected to CDN and the list of domain names with the certificate configured.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeCertDomains.
Version Yes String Common parameter. The value used for this API: 2018-06-06.
Region No String Common parameter. This parameter is not required for this API.
Cert Yes String Base64-encoded string of certificate in PEM format

3. Output Parameters

Parameter Name Type Description
Domains Array of String List of domain names connected to CDN
Note: this field may return null, indicating that no valid values can be obtained.
CertifiedDomains Array of String List of CDN domain names with certificates configured
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting configurable domain names in an SSL certificate

Input Example

https://cdn.tencentcloudapi.com/?Action=DescribeCertDomains
&Cert=XXXXX
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "xxxxx-xxxxx-xxxxx-xxxxx-xxxxx",
    "Domains": [
      "test.tencentyun.com",
      "httpstest.tencentyun.com"
    ],
    "CertifiedDomains": [
      "httpstest.tencentyun.com"
    ]
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
InternalError.DataSystemError Error with the data query. Please submit a ticket for troubleshooting.
InvalidParameter.CdnCertNotPem Invalid HTTPS certificate.
InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
UnauthorizedOperation.CdnHostIsUsedByOther The domain name has been connected by another account. For more information, please submit a ticket.
UnauthorizedOperation.CdnHostUnauthorized The sub-account has no access to the CDN-accelerated domain name.
UnauthorizedOperation.CdnProjectUnauthorized The sub-account has no access to the project.
UnauthorizedOperation.CdnUserAuthFail Fail to authenticate the CDN user.
UnauthorizedOperation.CdnUserAuthWait The CDN user is pending authentication.
UnauthorizedOperation.CdnUserIsSuspended The CDN service has been suspended. Please restart it and try again.
UnauthorizedOperation.ClsInvalidAuthorization Invalid authorization.
UnauthorizedOperation.ClsUnauthorized Authorization failed.
UnauthorizedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.
UnsupportedOperation.ClsNotAllowed The operation is not allowed.
UnsupportedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.