Domain name for API request: teo.tencentcloudapi.com.
This API is used to create an alias domain name.
A maximum of 20 requests can be initiated per second for this API.
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: CreateAliasDomain. |
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 | The site ID. |
AliasName | Yes | String | The alias domain name. |
TargetName | Yes | String | The target domain name. |
CertType | No | String | Certificate configuration. Values:none : (Default) Do not configurehosting : Managed SSL certificate |
CertId.N | No | Array of String | The certificate ID. This field is required when CertType=hosting . |
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. |
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAliasDomain
<Common request parameters>
{
"TargetName": "aaa.example.com",
"AliasName": "bbb.test.com",
"CertType": "none",
"ZoneId": "zone-28569s6od5na"
}
{
"Response": {
"RequestId": "4dcgtb24-7dc5-46s2-9q3e-95825d53dcs3a"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.CertificateNotFound | The certificate does not exist. |
InternalError | Internal error. |
InternalError.ConfigLocked | The configuration is locked. Please unlock and try again. |
InvalidParameter.AliasDomainNotSupportSMCert | Chinese SM certificates are not supported for alias domain names. |
InvalidParameter.CertNotMatchDomain | Mismatch between the HTTPS certificate and the domain name. |
InvalidParameter.InvalidHttpsCertInfo | Invalid HTTPS certificate. |
InvalidParameter.InvalidParameter | Invalid parameter. |
InvalidParameter.InvalidRequestHeaderName | Invalid request header. |
InvalidParameterValue | Invalid parameter value. |
InvalidParameterValue.InvalidAliasDomainName | The alias domain name is invalid. It must contain numerics, English characters, and hyphens, but hyphen is not allowed at the beginning or the end. |
InvalidParameterValue.InvalidAliasNameSuffix | Invalid alias domain suffix. This domain is for internal usage and cannot be used as the alias domain. |
LimitExceeded | The quota limit has been reached. |
OperationDenied | Operation denied. |
OperationDenied.ConfigLocked | The configuration is locked. Please unlock and try again. |
OperationDenied.DomainIsBlocked | Unable to use the domain name when it’s blocked. |
OperationDenied.DomainNoICP | The domain name doesn't have an ICP filing number. |
OperationDenied.VersionControlLocked | The operation is not allowed because the version management mode is applied. |
ResourceInUse.AliasName | The alias domain name already exists. |
ResourceInUse.DuplicateName | Duplicate alias domain names. |
ResourceInUse.Zone | The alias domain name is already added. |
ResourceNotFound | The resource doesn’t exist. |
ResourceUnavailable.DomainAlreadyExists | The domain name is already connected to EdgeOne by another account. Please retrieve it first in order to add it. |
UnauthorizedOperation | Unauthorized operation. |
UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
UnsupportedOperation.TargetNameOriginTypeCos | The origin type of the target domain cannot be COS for an alias domain. |
Was this page helpful?