tencent cloud

Feedback

DescribeProxies

Last updated: 2022-08-10 16:13:23

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.

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: DescribeProxies.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. 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 condition
The upper limit for Filters in each request is 10 and 5 for Filter.Values. You cannot specify both InstanceIds and Filters with this parameter.
ProjectId - String - Required: No - Filter by project ID.
AccessRegion - String - Required: No - Filter by access region.
RealServerRegion - String - Required: No - Filter by origin server region.
GroupId - String - Required: No - Filter by connection group ID.
IPAddressVersion - String - Required: No - Filter by IP version.
PackageType - String - Required: No - Filter by package type of connection groups.
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.
Order No String Specifies how connections are listed. Valid values:
asc: ascending order
desc: descending order
Default: desc
OrderField No String Sorting field. Valid values:
create_time: sort by the creation time
proxy_id: sort by the connection ID
bandwidth:sort by the bandwidth limit
concurrent_connections: sort by the number of concurrent connections
Default: create_time

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 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

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.
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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support