UnBindSubDomain

Last updated: 2022-01-20 14:23:45

1. API Description

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.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

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.

3. Output Parameters

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.

4. Example

Example1 Unbinding a custom domain name

Input Example

https://apigateway.tencentcloudapi.com/?Action=UnBindSubDomain
&ServiceId=service-19c5fnhy
&SubDomain=xxxxxxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": true,
    "RequestId": "b3197c48-53fb-46df-b721-df4424cf8be9"
  }
}

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.DomainNotBindService Failed to unbind the custom domain name, as the domain name is not bound to the service.
FailedOperation.ServiceError Service error.
FailedOperation.ServiceInOperation The service is in use. Please try again later.
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.