Last updated: 2021-10-08 15:11:08

1. API Description

Domain name for API request:

This API is used to disable a connection group. Once disabled, the connection group will no longer generate traffic, but the basic connection configuration fees will still be incurred every day.

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: CloseProxyGroup.
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.
GroupId Yes String Connection group instance ID.

3. Output Parameters

Parameter Name Type Description
InvalidStatusInstanceSet Array of String List of IDs of the connection instances that are not running, which cannot be enabled.
OperationFailedInstanceSet Array of String List of IDs of the 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 group

Input Example
&<Common request parameters>

Output Example

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

5. Developer Resources


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.DuplicatedRequest Repeated request. Please check the value of ClientToken.
InternalError Internal error.
InvalidParameter Incorrect parameter.
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.