ModifyHostsCertificate
1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to configure the certificate of a site. You can use your own certificate or apply for a free certificate.
To use an external certificate, upload the certificate to SSL Certificates Console first, and then input the certificate ID in this API. For details, see Deploying Own Certificates to EdgeOne Domains.
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 Params. The value used for this API: ModifyHostsCertificate. |
Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
Region | No | String | Common Params. This parameter is not required. |
ZoneId | Yes | String | ID of the site. |
Hosts.N | Yes | Array of String | Domain names that you need to modify the certificate configuration |
Mode | No | String | Certificate configuration mode. Values:disable : (Default) Do not configure the certificateeofreecert : Use a free certificate provided by EdgeOnesslcert : Configure an SSL certificate. |
ServerCertInfo.N | No | Array of ServerCertInfo | ID of the SSL certificate. It takes effect when mode=sslcert . To check the certificate ID, go to the SSL Certificate console. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Configuring an SSL certificate
Add the certificate cert-244ffgv 7m17xw
to the domain name abc.test.com
under the site zone-2fgd 17m17xw
.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyHostsCertificate
<Common request parameters>
{
"ZoneId": "zone-2fgd17m17xw",
"Hosts": [
"abc.test.com"
],
"Mode": "sslcert",
"ServerCertInfo": [
{
"CertId": "cert-244ffgv7m17xw"
}
]
}
Output Example
{
"Response": {
"RequestId": "5e5a0d0f-52f3-4bad-9bd3-dcf1d5c954e7"
}
}
Example2 Configuring a free certificate
Configure a free certificate for the domain name abc.test.com
under the site zone-2fgd17m17xw
.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyHostsCertificate
<Common request parameters>
{
"ZoneId": "zone-2fgd17m17xw",
"Hosts": [
"abc.test.com"
],
"Mode": "eofreecert"
}
Output Example
{
"Response": {
"RequestId": "084d5612-67a7-4aca-aac9-827aa3662b2d"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 | Operation failed. |
FailedOperation.CertificateHasExpired | Failed to publish: The certificate has expired. |
FailedOperation.CertificateNotFound | The certificate does not exist. |
FailedOperation.InvalidZoneStatus | The site status is invalid. |
FailedOperation.ModifyFailed | Operation failed. |
InternalError.ConfigLocked | The configuration is locked. Please unlock and try again. |
InternalError.GetRoleError | Failed to get the role. |
InternalError.ProxyServer | An unknown error occurred in the backend server. |
InternalError.RouteError | The backend routing address is incorrect. |
InternalError.SystemError | Internal system error. |
InternalError.UnknowError | Unknown error. |
InvalidParameter.ActionInProgress | Too many attempts. Please try again later. |
InvalidParameter.CertNotMatchDomain | Mismatch between the HTTPS certificate and the domain name. |
InvalidParameter.CertToExpire | The HTTPS certificate is about to expire. |
InvalidParameter.CertTooShortKeySize | Certificate error. |
InvalidParameter.CnameWildHostNotAllowApplyCertificate | Unable to apply for a wildcard certificate under CNAME mode. |
InvalidParameter.HostStatusNotAllowApplyCertificate | CNAME is not switched or the origin is not routed to the EdgeOne server. |
InvalidParameter.InvalidCertInfo | Incorrect certificate information. |
InvalidParameter.InvalidHttpsCertInfo | Invalid HTTPS certificate. |
InvalidParameter.InvalidHttpsTlsVersion | Invalid HTTPS TLS version. |
InvalidParameter.ZoneIsGrayPublishing | The site is being upgraded. Changing is not supported. Please try again later. |
LimitExceeded.RateLimitExceeded | Reached the API rate limit. |
OperationDenied | Operation denied. |
OperationDenied.ConfigLocked | The configuration is locked. Please unlock and try again. |
OperationDenied.DisableZoneNotCompleted | The EdgeOne service of the site is being disabled. Please try again later. |
OperationDenied.ErrZoneIsAlreadyPaused | The EdgeOne service of the site is disabled. Please enable it and try again. |
OperationDenied.VersionControlIsGraying | There is a test version in use. Please release the test version to the live environment, or roll back the test version and try again. |
ResourceInUse | The resource is occupied. |
ResourceUnavailable.CertNotFound | The certificate does not exist or is not authorized. |
ResourceUnavailable.HostNotFound | The domain name does not exist or not use a proxy. |
UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |