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.
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 Params. The value used for this API: CloseProxies. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
Region | No | String | Common Params. This parameter is not required. |
InstanceIds.N | No | Array of String | Connection instance ID; It’s an old parameter, please switch to ProxyIds. |
ClientToken | No | String | A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idem-potency 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. |
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. |
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CloseProxies
<Common request parameters>
{
"ProxyIds": [
"link-11112222"
]
}
{
"Response": {
"OperationFailedInstanceSet": [],
"RequestId": "888fe1bb-be58-4a80-90b9-24a0398633c6",
"InvalidStatusInstanceSet": []
}
}
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 |
---|---|
AuthFailure | CAM signature/authentication error. |
AuthFailure.NotEnterpriseAuthorization | Not an organizational customer. |
AuthFailure.UnauthorizedOperation | The sub-account is not authorized for this operation. |
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. |
FailedOperation.UserNotConfirmProtocol | Protocol not activated. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
MissingParameter | Missing parameter. |
ResourceNotFound | The resource does not exist. |
ResourceUnavailable | The resource is unavailable. |
ResourceUnavailable.AccountViolation | Restricted resources found in your account. Check your inbox and email for details. |
UnauthorizedOperation | Unauthorized operation. |
UnknownParameter | Unknown parameter. |
Was this page helpful?