Documentation|Tencent Cloud

Recent Pages

DeleteDomain

Last updated: 2020-07-24 15:09:07

1. API Description

Domain name for API request: gaap.tencentcloudapi.com.

This API (DeleteDomain) is only applicable to layer-7 listeners. It is used to delete the domain names of this listener, and all the rules under the domain name. All rules bound to the origin server are unbound automatically.

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.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DeleteDomain.
Version	Yes	String	Common parameter. The value used for this API: 2018-05-29.
Region	No	String	Common parameter. This parameter is not required for this API.
ListenerId	Yes	String	Listener ID
Domain	Yes	String	Domain name to be deleted
Force	Yes	Integer	Whether to make a forced deletion of forwarding rules that have been bound to origin servers. 0: no; 1: yes. When not making a forced deletion, if there are rules bound to origin servers, they will not be deleted.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting a Forwarding Rule Based on Domain Names

Input Example

https://gaap.tencentcloudapi.com/?Action=DeleteDomain
&ListenerId=0
&Domain=a.a.com
&Force=1
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.InstanceStatusNotInRuning	Unable to operate: the connection is not running.
FailedOperation.ListenerHasTask	The listener is in operation. Do not repeat the operation.
FailedOperation.RealServerAlreadyBound	Failed to delete: it’s bound to an origin server.
InternalError	Internal error
InvalidParameter	Parameter error
InvalidParameterValue	Parameter value error
ResourceNotFound	Resource does not exist
UnauthorizedOperation	Unauthorized operation