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.
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. Default value: 0. |
Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
Filters.N | No | Array of Filter | Filters 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. 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 orderdesc : Descending orderDefault: desc |
OrderField | No | String | Sorting field. Valid values:create_time : Sort by creation timeproxy_id : Sort by connection IDbandwidth :Sort by bandwidth limitconcurrent_connections : Sort by number of concurrent connectionsDefault: create_time |
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. |
https://gaap.tencentcloudapi.com/?Action=DescribeProxies
&Offset=0
&Limit=1
&Filters.0.Name=AccessRegion
&Filters.0.Values.0=ap-hongkong
&<Common request parameters>
{
"Response": {
"InstanceSet": [
{
"AccessRegionInfo": {
"RegionId": "xx",
"RegionAreaName": "xx",
"IDCType": "xx",
"FeatureBitmap": 1,
"RegionArea": "xx",
"RegionName": "xx"
},
"RelatedGlobalDomains": [
"xx"
],
"Version": "xx",
"PolicyId": "xx",
"Scalarable": 1,
"IPList": [
{
"IP": "xx",
"Bandwidth": 0,
"Provider": "xx"
}
],
"Status": "xx",
"ProxyType": 1,
"ForwardIP": "xx",
"ProxyId": "xx",
"RealServerRegion": "xx",
"Concurrent": 2,
"RealServerRegionInfo": {
"RegionId": "xx",
"RegionAreaName": "xx",
"IDCType": "xx",
"FeatureBitmap": 1,
"RegionArea": "xx",
"RegionName": "xx"
},
"IP": "xx",
"Http3Supported": 0,
"InBanBlacklist": 0,
"AccessRegion": "xx",
"ProjectId": 0,
"BillingType": 0,
"SupportProtocols": [
"TCP",
"UDP",
"HTTP",
"HTTPS"
],
"PackageType": "xx",
"Domain": "xx",
"IPAddressVersion": "xx",
"BanStatus": "xx",
"CreateTime": 1,
"InstanceId": "xx",
"Bandwidth": 10,
"SupportSecurity": 0,
"TagSet": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"ClientIPMethod": [
0
],
"ProxyName": "xx",
"NetworkType": "xx",
"ModifyConfigTime": 1,
"GroupId": "xx"
}
],
"TotalCount": 1,
"ProxySet": [
{
"AccessRegionInfo": {
"RegionId": "xx",
"RegionAreaName": "xx",
"IDCType": "xx",
"FeatureBitmap": 1,
"RegionArea": "xx",
"RegionName": "xx"
},
"RelatedGlobalDomains": [
"xx"
],
"Version": "xx",
"PolicyId": "xx",
"Scalarable": 1,
"IPList": [
{
"IP": "xx",
"Bandwidth": 0,
"Provider": "xx"
}
],
"Status": "xx",
"ProxyType": 1,
"ForwardIP": "xx",
"ProxyId": "xx",
"RealServerRegion": "xx",
"Concurrent": 2,
"RealServerRegionInfo": {
"RegionId": "xx",
"RegionAreaName": "xx",
"IDCType": "xx",
"FeatureBitmap": 1,
"RegionArea": "xx",
"RegionName": "xx"
},
"IP": "xx",
"Http3Supported": 0,
"InBanBlacklist": 0,
"AccessRegion": "xx",
"ProjectId": 0,
"BillingType": 0,
"SupportProtocols": [
"TCP",
"UDP",
"HTTP",
"HTTPS"
],
"PackageType": "xx",
"Domain": "xx",
"IPAddressVersion": "xx",
"BanStatus": "xx",
"CreateTime": 1,
"InstanceId": "xx",
"Bandwidth": 10,
"SupportSecurity": 0,
"TagSet": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"ClientIPMethod": [
0
],
"ProxyName": "xx",
"NetworkType": "xx",
"ModifyConfigTime": 1,
"GroupId": "xx"
}
],
"RequestId": "xx"
}
}
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.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?