Documentation|Tencent Cloud

Recent Pages

CloseProxies

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

1. API Description

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

This API (CloseProxies) is used to disable connections. If disabled, no traffic will be generated, but the basic configuration fee will still be incurred.

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: CloseProxies.
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.
InstanceIds.N	No	Array of String	Connection instance ID; 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	Connection instance ID; It's a new parameter.

3. Output Parameters

Parameter Name	Type	Description
InvalidStatusInstanceSet	Array of String	Only the running connection instance ID lists can be enabled.
OperationFailedInstanceSet	Array of String	ID list of connection instances failed to be enabled.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Disabling a Connection

Input Example

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

Output Example

{
  "Response": {
    "OperationFailedInstanceSet": [],
    "RequestId": "888fe1bb-be58-4a80-90b9-24a0398633c6",
    "InvalidStatusInstanceSet": []
  }
}

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.AccountBalanceInsufficient	Unable to create this connection: insufficient account balance.
FailedOperation.DuplicatedRequest	Repeated request. Please check the value of ClientToken.
FailedOperation.NotSupportOldVersionProxy	Only connections of Version 2.0 are supported.
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