Domain name for API request: gaap.tencentcloudapi.com.
This API (DeleteListeners) is used to batch delete the listeners of a connection or connection group, including layer-4/7 listeners.
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 parameter. The value used for this API: DeleteListeners. |
| 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. |
| ListenerIds.N | Yes | Array of String | ID list of listeners to be deleted |
| Force | Yes | Integer | Whether to allow a forced deletion of listeners that have been bound to origin servers. 1: allowed; 0: not allow. |
| GroupId | No | String | Connection group ID; Either this parameter or GroupId must be set, but you cannot set both. |
| ProxyId | No | String | Connection ID; Either this parameter or GroupId must be set, but you cannot set both. |
| Parameter Name | Type | Description |
|---|---|---|
| OperationFailedListenerSet | Array of String | ID list of listeners failed to be deleted |
| OperationSucceedListenerSet | Array of String | ID list of listeners deleted successfully |
| InvalidStatusListenerSet | Array of String | ID list of invalid listeners. For example: the listener does not exist, or the instance corresponding to the listener does not match. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Delete a listener.
https://gaap.tencentcloudapi.com/?Action=DeleteListeners
&ProxyId=link-3d85gh
&ListenerIds.0=listener-o0f3at99
&Force=1
&<Common request parameters>{
"Response": {
"OperationFailedListenerSet": [],
"OperationSucceedListenerSet": [
"listener-o0f3at99"
],
"InvalidStatusListenerSet": [],
"RequestId": "38fab584-8d14-4e2c-988c-4acdabbf2dff"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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.GroupStatusNotInRuning | Unable to operate: the connection group is not running. |
| 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 | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?