tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

OpenProxies

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

1. API Description

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

This API (OpenProxies) is used to enable one or more connections.

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: OpenProxies.
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 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 The connection instance ID list cannot be enabled if it's not disabled.
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 Enabling connection

Input Example

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

{
    "ProxyIds": [
        "link-11113333",
        "link-11112222"
    ]
}

Output Example

{
    "Response": {
        "OperationFailedInstanceSet": [],
        "RequestId": "7daaa62c-7c4b-40d9-a22e-90de42bde58d",
        "InvalidStatusInstanceSet": []
    }
}

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.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.CrossBorderInIsolating The CUCC cross-MLC-border connection expired and is isolated.
UnknownParameter Unknown parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy