Domain name for API request: gaap.tencentcloudapi.com.
This API (ModifyDomain) is used to modify domain names of listeners. For connections of version 3.0, it supports modifying certificates of the domain names.
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: ModifyDomain. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
Region | No | String | Common Params. This parameter is not required. |
ListenerId | Yes | String | Layer-7 listener ID |
OldDomain | Yes | String | Original domain name information |
NewDomain | Yes | String | New domain name information |
CertificateId | No | String | Server SSL certificate ID. It's only applicable to the connections of version 3.0: If this field is not passed in, the original certificate will be used; If this field is passed in, and CertificateId=default, the listener certificate will be used; For other cases, the certificate specified by CertificateId will be used. |
ClientCertificateId | No | String | Client CA certificate ID. It's only applicable to the connections of version 3.0: If this field is not passed in, the original certificate will be used; If this field is passed in, and ClientCertificateId=default, the listener certificate will be used; For other cases, the certificate specified by ClientCertificateId will be used. |
PolyClientCertificateIds.N | No | Array of String | Client CA certificate ID. It is only applicable to connections on version 3.0, where: If this field and ClientCertificateId are not included, the original certificate will be used;If this field is included, and ClientCertificateId=default, then the listener certificate will be used; In other cases, the certificate specified by ClientCertificateId or PolyClientCertificateIds will be used. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to modify the forwarding rule domain name of a layer-7 listener.
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDomain
<Common request parameters>
{
"OldDomain": "a.a.com",
"CertificateId": "default",
"ListenerId": "0",
"NewDomain": "b.b.com"
}
{
"Response": {
"RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
}
}
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 |
---|---|
AuthFailure | CAM signature/authentication error. |
AuthFailure.NotEnterpriseAuthorization | Not an organizational customer. |
AuthFailure.UnauthorizedOperation | The sub-account is not authorized for this operation. |
FailedOperation | Operation failed. |
FailedOperation.DomainAlreadyExisted | The domain name is used by a listener. |
FailedOperation.DomainStatusNotInRunning | Operation unavailable: the domain name is not running. |
FailedOperation.InstanceStatusNotInRuning | Unable to operate: the connection is not running. |
FailedOperation.InvalidListenerProtocol | Invalid listener protocol. |
FailedOperation.ListenerHasTask | The listener is in operation. Do not repeat the operation. |
FailedOperation.NonStandardProxy | This connection is non-standard and write operations are not allowed. |
FailedOperation.ProxyStatusNotInRuning | Unable to add listeners: the connection is not running. |
FailedOperation.UserNotConfirmProtocol | Protocol not activated. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.CertificateNotMatchDomain | The HTTP certificate does not match the domain name. |
InvalidParameterValue.DomainInIcpBlacklist | The domain name is blocked for ICP issues. |
InvalidParameterValue.DomainNotRegister | The domain name does not have an ICP filing. |
ResourceNotFound | The resource does not exist. |
ResourceUnavailable.AccountViolation | Restricted resources found in your account. Check your inbox and email for details. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?