tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCertDomains

Last updated: 2023-12-01 16:40:38

    1. API Description

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

    This API is used to verify a SSL certificate and obtain its domain names.

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

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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 Params. The value used for this API: DescribeCertDomains.
    Version Yes String Common Params. The value used for this API: 2018-06-06.
    Region No String Common Params. This parameter is not required for this API.
    Cert No String Base64-encoded string of certificate in PEM format
    CertId No String Managed certificate ID. Cert and CertId cannot be both empty. If they’re both filled in, CerID prevails.
    Product No String Product of the domain name, either cdn (default) or ecdn.

    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 value 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 value 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

    POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertDomains
<Common request parameters>

{
    "Cert": "\"
}

    Output Example

    {
    "Response": {
        "RequestId": "1abbe623-4b0e-4727-ab51-7624902d47f4",
        "Domains": [
            "test.tencentyun.com",
            "httpstest.tencentyun.com"
        ],
        "CertifiedDomains": [
            "httpstest.tencentyun.com"
        ]
    }
}

    5. Developer Resources

    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.CdnCertNoCertInfo Invalid certificate. Please check and try again.
    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 project is not authorized for the sub-account.
    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.
    UnauthorizedOperation.OperationTooOften Too many calling attempts.
    UnsupportedOperation.ClsNotAllowed The operation is not allowed.
    UnsupportedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy