Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to unbind a custom domain name.
After binding a custom domain name to a service by using API Gateway, you can use this API to unbind it.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: UnBindSubDomain. |
Version | Yes | String | Common parameter. The value used for this API: 2018-08-08. |
Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
ServiceId | Yes | String | Unique service ID. |
SubDomain | Yes | String | Custom domain name to be unbound. |
Parameter Name | Type | Description |
---|---|---|
Result | Boolean | Whether the custom domain name is successfully unbound. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://apigateway.tencentcloudapi.com/?Action=UnBindSubDomain
&ServiceId=service-19c5fnhy
&SubDomain=xxxxxxxx
&<Common request parameters>
{
"Response": {
"Result": true,
"RequestId": "b3197c48-53fb-46df-b721-df4424cf8be9"
}
}
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.DomainNotBindService | Failed to unbind the custom domain name, as the domain name is not bound to the service. |
FailedOperation.ServiceNotExist | The service does not exist. |
FailedOperation.SubDomainFormatError | The custom domain name format is incorrect. |
UnsupportedOperation.InvalidStatus | The current key status does not support this operation. |
Was this page helpful?