调用DescribeLoadBalancers接口查询已创建的传统型负载均衡实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLoadBalancers |
系统规定参数。取值:DescribeLoadBalancers。 |
RegionId | String | 是 | cn-hangzhou |
传统型负载均衡实例的地域ID。 您可以通过调用DescribeRegions接口查询地域ID。 |
ServerId | String | 否 | vm-server-23**** |
添加的后端服务器ID。 |
AddressIPVersion | String | 否 | ipv4 |
IP版本,可以设置为ipv4或者ipv6。 |
LoadBalancerStatus | String | 否 | active |
实例状态。取值:
|
LoadBalancerId | String | 否 | lb-bp1b6c719dfa**** |
传统型负载均衡实例ID。 支持多值查询,最多可输入10个ID,以半角逗号(,)分隔。 |
LoadBalancerName | String | 否 | test |
传统型负载均衡实例名称。 长度为1~80个英文或中文字符,必须以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。 支持多值查询,最多可输入10个名称,以半角逗号(,)分隔。 |
ServerIntranetAddress | String | 否 | 10.XX.XX.102 |
添加的后端服务器的内网地址。 支持多值查询,以半角逗号(,)分隔。 |
AddressType | String | 否 | intranet |
传统型负载均衡实例的网络类型。取值:
|
InternetChargeType | String | 否 | paybytraffic |
公网计费方式。取值:
当PayType参数的值为PrePay时,只支持按带宽计费。当InstanceChargeType参数的值为PayByCLCU时,只支持按流量计费。 |
VpcId | String | 否 | vpc-bp1aevy8sof**** |
传统型负载均衡实例所属的VPC ID。 |
VSwitchId | String | 否 | vsw-bp12mw1f8k3**** |
传统型负载均衡实例所属的交换机ID。 |
NetworkType | String | 否 | vpc |
私网实例的网络类型。取值:
|
Address | String | 否 | 192.168.XX.XX |
传统型负载均衡实例的服务地址。 |
MasterZoneId | String | 否 | cn-hangzhou-b |
负载均衡实例的主可用区ID。 |
SlaveZoneId | String | 否 | cn-hangzhou-d |
传统型负载均衡实例的备可用区ID。 目前对金融云用户暂时不支持多可用区功能。 |
Tags | String | 否 | [{"tagKey":"Key1","tagValue":"Value1"}] |
传统型负载均衡实例绑定的标签列表,其结构是一个JSON dictionary,包含标签键和标签值。 一次请求中,绑定的标签列表中最多支持10个标签。 |
PayType | String | 否 | PayOnDemand |
传统型负载均衡实例付费模式。取值:
|
ResourceGroupId | String | 否 | rg-acfmxazb4p**** |
企业资源组ID。 |
PageNumber | Integer | 否 | 1 |
分页查询时的页码。 |
PageSize | Integer | 否 | 50 |
分页查询时设置的每页行数。 取值范围:1~100。 说明 如果设置了PageSize,则需要同时设置PageNumber。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E |
请求ID。 |
PageNumber | Integer | 1 |
实例列表页码。 |
PageSize | Integer | 50 |
当前分页的行数。 |
TotalCount | Integer | 1 |
根据过滤条件得到的实例总个数。 |
LoadBalancers | Array of LoadBalancer |
数组格式,返回负载均衡实例列表。 |
|
LoadBalancer | |||
VpcId | String | vpc-25dvzy9f8**** |
私网负载均衡实例的专有网络ID。 |
CreateTimeStamp | Long | 1504147745000 |
实例创建时间戳。 |
LoadBalancerId | String | lb-bp1b6c719dfa**** |
负载均衡实例ID。 |
CreateTime | String | 2021-12-02T02:49:05Z |
实例创建时间,格式为: |
PayType | String | PayOnDemand |
负载均衡实例付费模式,取值:
|
AddressType | String | intranet |
实例的网络类型。取值:
|
NetworkType | String | vpc |
私网负载均衡实例的网络类型,取值:
|
AddressIPVersion | String | ipv4 |
IP版本,可以设置为ipv4或者ipv6。 |
LoadBalancerName | String | lb-bp1o94dp5i6ea**** |
负载均衡实例的名称。 |
Bandwidth | Integer | -1 |
监听的带宽峰值,单位:Mbps。取值:
|
Address | String | 100.XX.XX.28 |
负载均衡实例服务地址。 |
SlaveZoneId | String | cn-hangzhou-d |
实例的备可用区ID。 |
MasterZoneId | String | cn-hangzhou-b |
实例的主可用区ID。 |
InternetChargeTypeAlias | String | paybybandwidth |
公网计费方式。取值:
当PayType参数的值为PrePay时,只支持按带宽计费。当InstanceChargeType参数的值为PayByCLCU时,只支持按流量计费。 |
LoadBalancerSpec | String | slb.s1.small |
负载均衡实例的性能规格。 |
RegionId | String | cn-hangzhou |
负载均衡实例的地域ID。 |
ModificationProtectionReason | String | 托管实例 |
设置修改保护状态的原因,长度为1~80个字符,必须以字母或中文开头,支持数字、半角句号(.)、下划线(_)和短划线(-)。 说明 仅在
ModificationProtectionStatus 为ConsoleProtection时有效。
|
ModificationProtectionStatus | String | ConsoleProtection |
负载均衡修改保护状态:
|
VSwitchId | String | vsw-255ecr**** |
私网负载均衡实例的交换机ID。 |
LoadBalancerStatus | String | active |
负载均衡实例状态。取值:
|
ResourceGroupId | String | rg-atstuj3r**** |
企业资源组ID。 |
InternetChargeType | String | 3 |
公网类型实例付费方式。取值:
当PayType参数的值为PrePay时,只支持按带宽计费。当InstanceChargeType参数的值为PayByCLCU时,只支持按流量计费。 |
DeleteProtection | String | off |
负载均衡删除保护状态。取值:
|
RegionIdAlias | String | hangzhou |
传统型负载均衡实例的地域名称。 |
Tags | Array of Tag |
标签列表 |
|
Tag | |||
TagValue | String | FinanceJoshua |
标签值。 |
TagKey | String | FinanceDept |
标签键。 |
InstanceChargeType | String | PayBySpec |
实例计费方式,取值:
说明 该参数仅适用于中国站且当PayType(实例付费模式)取值为PayOnDemand(按量付费)时,该参数生效。
|
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeLoadBalancers
&RegionId=cn-hangzhou
&ServerId=vm-server-23****
&AddressIPVersion=ipv4
&LoadBalancerStatus=active
&LoadBalancerId=lb-bp1b6c719dfa****
&LoadBalancerName=test
&ServerIntranetAddress=10.XX.XX.102
&AddressType=intranet
&InternetChargeType=paybytraffic
&VpcId=vpc-bp1aevy8sof****
&VSwitchId=vsw-bp12mw1f8k3****
&NetworkType=vpc
&Address=192.168.XX.XX
&MasterZoneId=cn-hangzhou-b
&SlaveZoneId=cn-hangzhou-d
&Tags=[{"tagKey":"Key1","tagValue":"Value1"}]
&PayType=PayOnDemand
&ResourceGroupId=rg-acfmxazb4p****
&PageNumber=1
&PageSize=50
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeLoadBalancersResponse>
<RequestId>8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E</RequestId>
<PageNumber>1</PageNumber>
<PageSize>50</PageSize>
<TotalCount>1</TotalCount>
<LoadBalancers>
<VpcId>vpc-25dvzy9f8****</VpcId>
<CreateTimeStamp>1504147745000</CreateTimeStamp>
<LoadBalancerId>lb-bp1b6c719dfa****</LoadBalancerId>
<CreateTime>2021-12-02T02:49:05Z</CreateTime>
<PayType>PayOnDemand</PayType>
<AddressType>intranet</AddressType>
<NetworkType>vpc</NetworkType>
<AddressIPVersion>ipv4</AddressIPVersion>
<LoadBalancerName>lb-bp1o94dp5i6ea****</LoadBalancerName>
<Bandwidth>-1</Bandwidth>
<Address>100.XX.XX.28</Address>
<SlaveZoneId>cn-hangzhou-d</SlaveZoneId>
<MasterZoneId>cn-hangzhou-b</MasterZoneId>
<InternetChargeTypeAlias>paybybandwidth</InternetChargeTypeAlias>
<LoadBalancerSpec>slb.s1.small</LoadBalancerSpec>
<RegionId>cn-hangzhou</RegionId>
<ModificationProtectionReason>托管实例</ModificationProtectionReason>
<ModificationProtectionStatus>ConsoleProtection</ModificationProtectionStatus>
<VSwitchId>vsw-255ecr****</VSwitchId>
<LoadBalancerStatus>active</LoadBalancerStatus>
<ResourceGroupId>rg-atstuj3r****</ResourceGroupId>
<InternetChargeType>3</InternetChargeType>
<DeleteProtection>off</DeleteProtection>
<RegionIdAlias>hangzhou</RegionIdAlias>
<Tags>
<TagValue>FinanceJoshua</TagValue>
<TagKey>FinanceDept</TagKey>
</Tags>
<InstanceChargeType>PayBySpec</InstanceChargeType>
</LoadBalancers>
</DescribeLoadBalancersResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E",
"PageNumber" : 1,
"PageSize" : 50,
"TotalCount" : 1,
"LoadBalancers" : [ {
"VpcId" : "vpc-25dvzy9f8****",
"CreateTimeStamp" : 1504147745000,
"LoadBalancerId" : "lb-bp1b6c719dfa****",
"CreateTime" : "2021-12-02T02:49:05Z",
"PayType" : "PayOnDemand",
"AddressType" : "intranet",
"NetworkType" : "vpc",
"AddressIPVersion" : "ipv4",
"LoadBalancerName" : "lb-bp1o94dp5i6ea****",
"Bandwidth" : -1,
"Address" : "100.XX.XX.28",
"SlaveZoneId" : "cn-hangzhou-d",
"MasterZoneId" : "cn-hangzhou-b",
"InternetChargeTypeAlias" : "paybybandwidth",
"LoadBalancerSpec" : "slb.s1.small",
"RegionId" : "cn-hangzhou",
"ModificationProtectionReason" : "托管实例",
"ModificationProtectionStatus" : "ConsoleProtection",
"VSwitchId" : "vsw-255ecr****",
"LoadBalancerStatus" : "active",
"ResourceGroupId" : "rg-atstuj3r****",
"InternetChargeType" : "3",
"DeleteProtection" : "off",
"RegionIdAlias" : "hangzhou",
"Tags" : [ {
"TagValue" : "FinanceJoshua",
"TagKey" : "FinanceDept"
} ],
"InstanceChargeType" : "PayBySpec"
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidTag | The specified tags is invalid. | 指定的TagKey无效。请检查参数约束,并在修改后重试。 |
400 | TooManyResult | fuzzy query retrieve too many instances. | 检索到的实例数量过多,请提供更具体的查询条件。 |
访问错误中心查看更多错误码。