tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
全球应用加速
    文档
    Download PDF

    DescribeProxies

    最后更新时间：2023-07-13 15:25:39
    下载PDF

    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. 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 order
    desc: Descending order
    Default: desc
    OrderField No String Sorting field. Valid values:
    create_time: Sort by creation time
    proxy_id: Sort by connection ID
    bandwidth:Sort by bandwidth limit
    concurrent_connections: Sort by 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 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": [
            {
                "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"
    }
}

    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.
    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.
    联系我们

    联系我们，为您的业务提供专属服务。

    联系我们
    技术支持

    如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

    提交工单
    7x24 电话支持
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款