tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteProxyGroup

Last updated: 2023-07-13 15:25:36

1. API Description

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

This API (DeleteProxyGroup) is used to delete a connection group.

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 Params. The value used for this API: DeleteProxyGroup.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required.
GroupId No String ID of the connection group to be deleted.
Force No Integer Whether to enable forced deletion. Valid values:
0: No;
1: Yes.
Default value: 0. If there is a connection or listener/rule bound to an origin server in the connection group and Force is 0, the operation will return a failure.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting a connection group

This example shows you how to delete a connection group by its group ID.

Input Example

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteProxyGroup
<Common request parameters>

{
    "Force": "0",
    "GroupId": "lg-b7h4d02f"
}

Output Example

{
    "Response": {
        "RequestId": "19a021f8-dff3-4890-8e7a-ed5054e22e49"
    }
}

5. Developer Resources

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
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.DeleteProxyGroupProxyRemained Unable to delete: the connection group contains groups.
FailedOperation.GroupStatusNotInRuning Unable to operate: the connection group is not running.
FailedOperation.RealServerAlreadyBound Failed to delete: it’s bound to an origin server.
FailedOperation.UnTagResourcesFailed Failed to unbind the tag.
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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy