tencent cloud

Feedback

DescribeApplicationProxyDetail

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

1. API Description

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

This API is used to obtain the details of an application proxy.

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: DescribeApplicationProxyDetail.
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 Yes String Site ID
ProxyId Yes String Instance ID

3. Output Parameters

Parameter Name Type Description
ProxyId String Instance ID
ProxyName String Name of the proxy:
Domain name or subdomain name when ProxyType=hostname
Instance name when ProxyType=instance
PlatType String Proxy mode. Valid values:
ip: Anycast IP
domain: CNAME
SecurityType Integer 0: Disable security protection; 1: Enable security protection.
AccelerateType Integer 0: Disable acceleration; 1: Enable acceleration.
ForwardClientIp String This field is moved to Rule.ForwardClientIp.
SessionPersist Boolean This field is moved to Rule.SessionPersist.
Rule Array of ApplicationProxyRule List of rules
Status String Status. Valid values:
online: Enable
offline: Disable
progress: Deploying
ScheduleValue Array of String Scheduling information
UpdateTime Timestamp ISO8601 Update time
ZoneId String Site ID
ZoneName String Site name
SessionPersistTime Integer Session persistence time
ProxyType String Specifies how a layer-4 proxy is created.
hostname: Create by subdomain name
instance: Create by instance
HostId String When ProxyType=hostname:
ProxyName indicates a specified domain name, such as test.123.com
HostId indicates a unique ID of the domain name.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the details of an application proxy

Input Example

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

{
    "ProxyId": "proxy-xxx",
    "ZoneId": "zone-xxx"
}

Output Example

{
    "Response": {
        "RequestId": "xx",
        "ProxyId": "xx",
        "ProxyName": "ins name",
        "ProxyType": "instance",
        "PlatType": "domain",
        "SecurityType": 1,
        "AccelerateType": 0,
        "ForwardClientIp": "OFF",
        "SessionPersist": false,
        "SessionPersistTime": 0,
        "Status": "xx",
        "ZoneId": "zone-xxx",
        "ZoneName": "123.com",
        "UpdateTime": "2020-09-22T00:00:00+00:00",
        "ScheduleValue": [
            "xx"
        ],
        "Rule": [],
        "HostId": ""
    }
}

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.
ResourceNotFound The resource doesn’t exist.
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