DescribeApplicationProxies
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is on an earlier version. If you want to call it, please switch to the latest version. In the latest version, this API has been split into two APIs: one for querying the Layer 4 proxy instance list and the other for querying Layer 4 forwarding rules. For details, see [DescribeL4Proxy] (https://intl.cloud.tencent.com/document/product/1552/103413?from_cn_redirect=1) and [DescribeL4ProxyRules] (https://intl.cloud.tencent.com/document/product/1552/103412?from_cn_redirect=1).
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 Params. The value used for this API: DescribeApplicationProxies. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | No | String | Zone ID. This parameter is required. |
| Filters.N | No | Array of Filter | Filters. Each filter can have up to 20 entries. Details: Filter by the Proxy ID, such as: proxy-ev2sawbwfd. Type: String Required: No Filter by the Site ID, such as zone-vawer2vadg. Type: String Required: No Filter by the Rule tag, such as rule-service-1. Type: String Required: No |
| Offset | No | Integer | The paginated query offset. Default value: 0 |
| Limit | No | Integer | The paginated query limit. Default value: 20. Maximum value: 1000. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| ApplicationProxies | Array of ApplicationProxy | List of application proxies. |
| TotalCount | Integer | Total number of records. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying the list of application proxies
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationProxies
<Common request parameters>
{
"Offset": 0,
"Limit": 10
}
Output Example
{
"Response": {
"RequestId": "a84ae15a-aca5-4c24-a4f4-c419cf2c18af",
"ApplicationProxies": [
{
"HostId": "",
"ProxyType": "instance",
"Area": "mainland",
"AccelerateType": 1,
"SessionPersistTime": 100,
"PlatType": "domain",
"ProxyId": "proxy-34c74aa7-9a9f-11ec-bcb0-52540015711d",
"ProxyName": "zone-f835533b8998f",
"ZoneId": "zone-21xfqlh4qjee",
"ZoneName": "123.com",
"ApplicationProxyRules": [
{
"OriginType": "custom",
"OriginValue": [
"81.69.174.153:80"
],
"Port": [
"80"
],
"OriginPort": "8080",
"SessionPersistTime": 100,
"Proto": "TCP",
"Status": "online",
"ForwardClientIp": "off",
"SessionPersist": true,
"RuleId": "rule-34c74ab8-9a9f-11ec-bcb0-52540015711d",
"RuleTag": "rule-for-cgi"
},
{
"OriginType": "custom",
"OriginValue": [
"81.69.174.153:553"
],
"Port": [
"553"
],
"Proto": "UDP",
"Status": "online",
"ForwardClientIp": "off",
"SessionPersist": true,
"OriginPort": "8080",
"SessionPersistTime": 100,
"RuleId": "rule-4bc1d3d6-9aa0-11ec-bcb0-52540015711d",
"RuleTag": "rule-for-logic"
}
],
"AccelerateMainland": {
"Switch": "off"
},
"ScheduleValue": [],
"SecurityType": 1,
"Ipv6": {
"Switch": "on"
},
"Status": "progress",
"BanStatus": "recover",
"UpdateTime": "2022-03-03T06:06:10Z"
}
],
"TotalCount": 1
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| InternalError.ProxyServer | An unknown error occurred in the backend server. |
| OperationDenied | Operation denied. |
| UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
| UnauthorizedOperation.NoPermission | The sub-account is not authorized for the operation. Please get permissions first. |
| UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |