tencent cloud

Feedback

DescribeApplicationProxy

Last updated: 2022-09-01 15:05:34

1. API Description

Domain name for API request: teo.tencentcloudapi.com.

This API is used to obtain a list of application proxies.

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: DescribeApplicationProxy.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ZoneId No String Site ID
Offset No Integer Pagination parameter
Limit No Integer Pagination parameter

3. Output Parameters

Parameter Name Type Description
Data Array of ApplicationProxy List of data
Note: This field may return null, indicating that no valid value can be obtained.
TotalCount Integer Total number of records
Note: This field may return null, indicating that no valid values can be obtained.
Quota Integer Disused
Note: This field may return null, indicating that no valid value can be obtained.
IpCount Integer When PlatType is ip, it indicates the number of proxies that schedule via Anycast IP.
Note: This field may return null, indicating that no valid values can be obtained.
DomainCount Integer When PlatType is domain, it indicates the number of proxies that schedule via CNAME.
Note: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining a list of application proxies

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationProxy
<Common request parameters>

{
    "Offset": 0,
    "Limit": 0,
    "ZoneId": "xx"
}

Output Example

{
    "Response": {
        "RequestId": "a84ae15a-aca5-4c24-a4f4-c419cf2c18af",
        "Data": [
            {
                "AccelerateType": 1,
                "PlatType": "domain",
                "ProxyId": "proxy-34c74aa7-9a9f-11ec-bcb0-52540015711d",
                "ProxyName": "zone-f835533b8998f",
                "ZoneId": "zone-xxx",
                "ZoneName": "123.com",
                "Rule": [
                    {
                        "OriginType": "custom",
                        "OriginValue": [
                            "81.69.174.153:80"
                        ],
                        "Port": [
                            "80"
                        ],
                        "Proto": "TCP",
                        "Status": "online",
                        "RuleId": "rule-34c74ab8-9a9f-11ec-bcb0-52540015711d"
                    },
                    {
                        "OriginType": "custom",
                        "OriginValue": [
                            "81.69.174.153:553"
                        ],
                        "Port": [
                            "553"
                        ],
                        "Proto": "UDP",
                        "Status": "online",
                        "RuleId": "rule-4bc1d3d6-9aa0-11ec-bcb0-52540015711d"
                    }
                ],
                "ScheduleValue": [],
                "SecurityType": 1,
                "SessionPersist": false,
                "Status": "progress",
                "UpdateTime": "2022-03-03T06:06:10Z"
            }
        ],
        "TotalCount": 1,
        "IpCount": 1,
        "DomainCount": 1,
        "Quota": 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.

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