DescribeProxies
Last updated: 2019-11-25 22:36:49
Contents：
1. API Description
Domain name for API request: gaap.tencentcloudapi.com.
This API (DescribeProxies) is used to query the connection instance 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: DescribeProxies |
| 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 | Queries by one or multiple instance IDs. The upper limit on the number of instances for each request is 100. This parameter does not support specifying InstanceIds and Filters at the same time. It’s an old parameter, please switch to ProxyIds. |
| Offset | No | Integer | Offset. The default value is 0. |
| Limit | No | Integer | Number of results to be returned. The default value is 20, and the maximum value is 100. |
| Filters.N | No | Array of Filter | Filter conditions. The upper limit on Filters for each request is 10, and the upper limit on Filter.Values is 5. This parameter does not support specifying InstanceIds and Filters at the same time. ProjectId - String - Required: No - Filter by a project ID. AccessRegion - String - Required: No - Filter by an access region. RealServerRegion - String - Required: No - Filter by an origin server region. GroupId - String - Required: No - Filter by a connection group ID. |
| ProxyIds.N | No | Array of String | Queries by one or multiple instance IDs. The upper limit on the number of instances for each request is 100. This parameter does not support specifying InstanceIds and Filters at the same time. It’s a new parameter, and replaces InstanceIds. |
| TagSet.N | No | Array of TagPair | Tag list. If this field exists, the list of the resources with the tag will be pulled. It supports up to 5 tags. If there are two or more tags, the connections tagged any of them will be pulled. |
| Independent | No | Integer | When this field is 1, only not-grouped connections are pulled. When this field is 0, only grouped connections are pulled. When this field does not exist, all connections are pulled, including both not-grouped and grouped connections. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of connections. |
| InstanceSet | Array of ProxyInfo | Connection instance information list; It’s an old parameter, please switch to ProxySet. |
| ProxySet | Array of ProxyInfo | Connection instance information list; It’s a new parameter. |
| 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 Instance List
Input Example
https://gaap.tencentcloudapi.com/?Action=DescribeProxies
&Offset=0
&Limit=1
&Filters.0.Name=AccessRegion
&Filters.0.Values.0=ap-hongkong
&<Common request parameters>Output Example
{
"Response": {
"InstanceSet": [
{
"Status": "CREATING",
"Domain": "",
"InstanceId": "link-01vm81tj",
"AccessRegion": "EastChina",
"ProxyId": "link-01vm81tj",
"ProjectId": 0,
"AccessRegionInfo": {
"RegionId": "EastChina",
"RegionName": "Mainland China - East China"
},
"RealServerRegion": "NorthChina",
"CreateTime": "2019-03-21 21:33:45",
"SupportProtocols": [
"TCP",
"UDP",
"HTTP",
"HTTPS"
],
"Concurrent": 2,
"Bandwidth": 10,
"Version": "2.0",
"PolicyId": null,
"Scalarable": 1,
"IP": "",
"ProxyName": "fff",
"TagSet": [],
"GroupId": null,
"RealServerRegionInfo": {
"RegionId": "NorthChina",
"RegionName": "Mainland China - North China"
}
}
],
"ProxySet": [
{
"Status": "CREATING",
"Domain": "",
"InstanceId": "link-01vm81tj",
"AccessRegion": "EastChina",
"ProxyId": "link-01vm81tj",
"ProjectId": 0,
"AccessRegionInfo": {
"RegionId": "EastChina",
"RegionName": "Mainland China - East China"
},
"RealServerRegion": "NorthChina",
"CreateTime": "2019-03-21 21:33:45",
"SupportProtocols": [
"TCP",
"UDP",
"HTTP",
"HTTPS"
],
"Concurrent": 2,
"Bandwidth": 10,
"Version": "2.0",
"PolicyId": null,
"Scalarable": 1,
"IP": "",
"ProxyName": "fff",
"GroupId": null,
"RealServerRegionInfo": {
"RegionId": "NorthChina",
"RegionName": "Mainland China - North China"
},
"TagSet": [
{
"TagKey": "gaaptest",
"TagValue": "www"
}
]
}
],
"TotalCount": 1,
"RequestId": "1c54137e-e4da-42e1-8565-1bc2d99794a3"
}
}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 |
| 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 |
