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.
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: DescribeProxiesStatus. |
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 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. |
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. |
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProxiesStatus
<Common request parameters>
{
"ProxyIds": [
"link-1234abcd"
]
}
{
"Response": {
"InstanceStatusSet": [
{
"InstanceId": "link-4ftf12sb",
"Status": "RUNNING"
}
],
"RequestId": "caac3323-bda3-4edc-b063-f584eb5936a2"
}
}
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.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. |
UnknownParameter | Unknown parameter. |
Was this page helpful?