DestroyProxies

Last updated: 2020-04-17 15:10:27

1. API Description

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

This API (DestroyProxies) is used to terminate a connection. If terminated, no fees will be incurred.

A maximum of 20 requests can be initiated per second for this API.

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: DestroyProxies.
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.
Force Yes Integer The identifier for forced deletion
1: this connection list is deleted forcibly regardless of whether the origin server has been bound.
0: this connection list cannot be deleted if the origin server has been bound.
If this identifier is 0, the deletion can be performed only when all the connections have not been bound to any origin servers.
InstanceIds.N No Array of String List of connection instance IDs; It’s an old parameter, please switch to ProxyIds.
ClientToken No String A string used to ensure the idempotency of the request, which is generated by the user and must be unique to each request. The maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed.
For more information, please see How to Ensure Idempotence.
ProxyIds.N No Array of String List of connection instance IDs; It’s a new parameter.

3. Output Parameters

Parameter Name Type Description
InvalidStatusInstanceSet Array of String ID list of connection instances that cannot be terminated.
OperationFailedInstanceSet Array of String ID list of connection instances that failed to be terminated.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Terminating a Connection

Input Example

https://gaap.tencentcloudapi.com/?Action=DestroyProxies
&ProxyIds.0=link-11112222
&ProxyIds.1=link-11113333
&Force=1
&<Common request parameters>

Output Example

{
  "Response": {
    "OperationFailedInstanceSet": [],
    "RequestId": "d4228b1a-8b3b-43d6-a8e7-272d158ff332",
    "InvalidStatusInstanceSet": [
      "link-11112222"
    ]
  }
}

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.

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 Operation failed
FailedOperation.AccountBalanceInsufficient Unable to create this connection: insufficient account balance.
FailedOperation.ActionIsDoing The operation is being performed. Do not perform it again.
FailedOperation.BelongDifferentGroup Unable to operate in batches: the connections belong to different groups.
FailedOperation.DuplicatedRequest Repeated request. Please check the value of ClientToken.
FailedOperation.RealServerAlreadyBound Failed to delete: it’s bound to an origin server.
InternalError Internal error
InvalidParameter Parameter error
InvalidParameterValue Parameter value error
MissingParameter Parameter missing
ResourceNotFound Resource does not exist
ResourceUnavailable Resource is unavailable
UnauthorizedOperation Unauthorized operation
UnknownParameter Unknown parameter error
UnsupportedOperation This operation is not supported.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help