tencent cloud

文档反馈

ModifyHostsCertificate

最后更新时间:2023-03-09 17:41:56

1. API Description

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

This API is used to modify the certificate of a domain name.

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: ModifyHostsCertificate.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region No String Common Params. This parameter is not required for this API.
ZoneId Yes String ID of the site
Hosts.N Yes Array of String Domain name that the certificate will be attached to
CertInfo.N No Array of ServerCertInfo Certificate information. Note that only CertId is required. If it is not specified, the default certificate will be used.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the certificate configuration for domain names

Input Example

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

{
    "ZoneId": "zone-xxxx",
    "Hosts": [
        "xxx.test.com"
    ],
    "CertInfo": [
        {
            "CertId": "EO-xxxxxx"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "xx"
    }
}

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
FailedOperation.CertificateNotFound The certificate does not exist.
InternalError.GetRoleError Failed to get the role.
InternalError.SystemError Internal system error.
InvalidParameter.InvalidCertInfo Incorrect certificate information.
OperationDenied Operation denied.
ResourceUnavailable.HostNotFound The domain name does not exist or not use a proxy.