DescribeProxiesStatus

Last updated: 2019-11-25 22:36:56

1. API Description

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

This API (DescribeProxiesStatus) is used to query the connection status list.

A maximum of 20 requests can be initiated per second for this API.

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: DescribeProxiesStatus
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 ID list; It’s an old parameter, please switch to ProxyIds.
ProxyIds.N No Array of String Connection ID list; It’s a new parameter.

3. Output Parameters

Parameter Name Type Description
InstanceStatusSet Array of ProxyStatus Connection status list.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying a Connection Status List

Input Example

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

Output Example

{
  "Response": {
    "InstanceStatusSet": [
      {
        "InstanceId": "link-4ftf12sb",
        "Status": "RUNNING"
      }
    ],
    "RequestId": "caac3323-bda3-4edc-b063-f584eb5936a2"
  }
}

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.

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.
InternalError Internal error
InvalidParameter Parameter error
InvalidParameterValue Parameter value error
MissingParameter Parameter missing
ResourceNotFound Resource does not exist
ResourceUnavailable Resource is unavailable
UnknownParameter Unknown parameter error