边缘计算机器查询负载均衡实例列表-负载均衡相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： ecm.tencentcloudapi.com 。

查询负载均衡实例列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeLoadBalancers。
Version	是	String	公共参数，本接口取值：2019-07-19。
Region	否	String	公共参数，本接口不需要传递此参数。
EcmRegion	否	String	区域。如果不传则默认查询所有区域。
LoadBalancerIds.N	否	Array of String	负载均衡实例 ID。
LoadBalancerName	否	String	负载均衡实例的名称。
LoadBalancerVips.N	否	Array of String	负载均衡实例的 VIP 地址，支持多个。
BackendPrivateIps.N	否	Array of String	负载均衡绑定的后端服务的内网 IP。
Offset	否	Integer	数据偏移量，默认为 0。
Limit	否	Integer	返回负载均衡实例的数量，默认为20，最大值为100。
WithBackend	否	Integer	负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。如果不传则默认查询全部。
VpcId	否	String	负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx。
Filters.N	否	Array of Filter	每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。详细的过滤条件如下： tag-key - String - 是否必填：否 - （过滤条件）按照标签的键过滤。
SecurityGroup	否	String	安全组。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	满足过滤条件的负载均衡实例总数。此数值与入参中的Limit无关。注意：此字段可能返回 null，表示取不到有效值。
LoadBalancerSet	Array of LoadBalancer	返回的负载均衡实例数组。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询负载均衡实例列表

输入示例

https://ecm.tencentcloudapi.com/?Action=DescribeLoadBalancers
&EcmRegion=ap-hangzhou-ecm
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "8d42288f-3fad-473a-93e6-cab5b219af8e",
        "LoadBalancerSet": [
            {
                "Status": 1,
                "StatusTime": "2020-07-28 10:58:08",
                "VpcId": "vpc-pugaiwf9",
                "LoadBalancerVips": [
                    "101.67.8.110"
                ],
                "VipIsp": "CUCC",
                "CreateTime": "2020-07-28 10:58:06",
                "LoadBalancerId": "lb-a8q643wj",
                "LoadBalancerName": "test",
                "LoadBalancerType": "OPEN",
                "Region": "xx",
                "Position": {
                    "Province": {
                        "ProvinceId": "xx",
                        "ProvinceName": "xx"
                    },
                    "City": {
                        "CityId": "xx",
                        "CityName": "xx"
                    },
                    "Area": {
                        "AreaId": "xx",
                        "AreaName": "xx"
                    },
                    "Country": {
                        "CountryName": "xx",
                        "CountryId": "xx"
                    },
                    "ZoneInfo": {
                        "ZoneName": "xx",
                        "Zone": "xx",
                        "ZoneId": 0
                    },
                    "RegionInfo": {
                        "Region": "xx",
                        "RegionId": 0,
                        "RegionName": "xx"
                    }
                },
                "Tags": [
                    {
                        "TagValue": "test",
                        "TagKey": "test"
                    }
                ],
                "NetworkAttributes": {
                    "InternetMaxBandwidthOut": 100
                }
            }
        ],
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure.UnauthorizedOperation	鉴权失败。
FailedOperation.InternalOperationFailure	内部操作错误。
InvalidParameter.FormatError	参数格式错误。
InvalidParameter.InvalidDataFormat	数据格式不正确。
InvalidParameter.RegionNotFound	地域无效。
InvalidParameterValue.InvalidFilter	无效过滤器。
InvalidParameterValue.InvalidPublicParam	公共参数不合法。
InvalidParameterValue.Length	参数长度错误。
InvalidParameterValue.Range	参数值不在指定范围。
UnauthorizedOperation.ForbiddenOperation	没有权限进行该操作。

查询负载均衡实例列表

本页目录：