public class DescribeLoadBalancersRequest extends AbstractModel
header, skipSign
Constructor and Description |
---|
DescribeLoadBalancersRequest() |
DescribeLoadBalancersRequest(DescribeLoadBalancersRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
String[] |
getAdditionalFields()
Get 选择返回的扩充字段,不指定时,扩充字段默认不返回。详细支持的扩充字段如下:
TargetCount:绑定的后端服务数量
|
String[] |
getBackendPrivateIps()
Get 负载均衡绑定的后端服务的内网 IP,只支持查询云服务器的内网 IP。
|
String[] |
getBackendPublicIps()
Get 负载均衡绑定的后端服务的外网 IP,只支持查询云服务器的公网 IP。
|
String |
getDomain()
Get 腾讯云为负载均衡实例分配的域名,支持模糊查询。
|
Filter[] |
getFilters()
Get 每次请求的`Filters`的上限为10,`Filter.Values`的上限为100。
`Filter.Name`和`Filter.Values`皆为必填项。详细的过滤条件如下: - charge-type 按照【实例计费模式】进行过滤。实例计费模式例如:PREPAID。 类型:String 必选:否 可选项:PREPAID(预付费)、POSTPAID_BY_HOUR(后付费) - internet-charge-type 按照【网络计费模式】进行过滤。网络计费模式例如:BANDWIDTH_PREPAID。 类型:String 必选:否 可选项:BANDWIDTH_PREPAID(预付费按带宽结算)、 TRAFFIC_POSTPAID_BY_HOUR(流量按小时后付费)、BANDWIDTH_POSTPAID_BY_HOUR(带宽按小时后付费)、BANDWIDTH_PACKAGE(带宽包用户) - master-zone-id 按照【CLB主可用区ID】进行过滤。例如:100001(对应的是广州一区)。 类型:String 必选:否 获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707) - tag-key 按照【CLB 标签的键】进行过滤,例如:tag-key。 类型:String 必选:否 获取方式:[DescribeTags](https://cloud.tencent.com/document/api/651/35316) - tag:tag-key 按照【CLB标签键值】进行过滤,例如:tag-test。 类型:String 必选:否 获取方式:[DescribeTagKeys](https://cloud.tencent.com/document/api/651/35318) - function-name 按照【后端绑定SCF云函数的函数名称】进行过滤,例如:helloworld-1744958255。 类型:String 必选:否 获取方式:[ListFunctions](https://cloud.tencent.com/document/api/583/18582) - vip-isp 按照【CLB VIP的运营商类型】进行过滤,例如:BGP。 类型:String 必选:否 公网类型可选项:BGP(多线)、CMCC(中国移动)、CTCC(中国电信)、CUCC(中国联通) 内网类型可选项:INTERNAL(内网) - sla-type 按照【CLB 的性能容量型规格】进行过滤,例如:clb.c4.xlarge。 类型:String 必选:否 可选项:clb.c2.medium(标准型)、clb.c3.small(高阶型1)、clb.c3.medium(高阶型2)、clb.c4.small(超强型1)、clb.c4.medium(超强型2)、clb.c4.large(超强型3)、clb.c4.xlarge(超强型4) 具体规格参数参考: - exclusive 按照【独占实例】进行过滤。例如:1,代表筛选独占型实例。 类型:String 必选:否 可选项:0、1 |
Long |
getForward()
Get 负载均衡实例的类型。1:通用的负载均衡实例,0:传统型负载均衡实例。如果不传此参数,则查询所有类型的负载均衡实例。
|
Long |
getLimit()
Get 返回负载均衡实例的数量,默认为20,最大值为100。
|
String[] |
getLoadBalancerIds()
Get 负载均衡实例ID。实例ID数量上限为20个。
|
String |
getLoadBalancerName()
Get 负载均衡实例的名称,支持模糊查询。
|
String |
getLoadBalancerType()
Get 负载均衡实例的网络类型:
OPEN:公网属性, INTERNAL:内网属性。
|
String[] |
getLoadBalancerVips()
Get 负载均衡实例的 VIP 地址,支持多个。
|
String |
getMasterZone()
Get 主可用区ID,如 :"100001" (对应的是广州一区)。可通过[DescribeZones](https://cloud.tencent.com/document/product/213/15707)获取可用区列表。
|
Long |
getOffset()
Get 数据偏移量,默认为0。
|
String |
getOrderBy()
Get 排序参数,支持以下字段:
- LoadBalancerName
- CreateTime
- Domain
- LoadBalancerType
默认为 CreateTime。
|
Long |
getOrderType()
Get 1:倒序,0:顺序,默认为1,按照创建时间倒序。
|
Long |
getProjectId()
Get 负载均衡实例所属的项目 ID,可以通过[DescribeProject](https://cloud.tencent.com/document/api/651/78725)接口获取,不传默认所有项目。
|
String |
getSearchKey()
Get 模糊搜索字段,模糊匹配负载均衡实例的名称、域名、负载均衡实例的 VIP 地址,负载均衡实例ID。
|
String |
getSecurityGroup()
Get 安全组ID,如 sg-m1cc****,可以通过接口[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)获取。
|
String |
getVpcId()
Get 负载均衡实例所属私有网络唯一ID,如 vpc-bhqkbhdx,可以通过[DescribeVpcs](https://cloud.tencent.com/document/api/215/15778)接口获取。
查找基础网络类型的负载均衡可传入'0'。
|
Long |
getWithRs()
Get 负载均衡是否绑定后端服务,0:没有绑定后端服务,1:绑定后端服务,-1:查询全部。
|
void |
setAdditionalFields(String[] AdditionalFields)
Set 选择返回的扩充字段,不指定时,扩充字段默认不返回。详细支持的扩充字段如下:
TargetCount:绑定的后端服务数量
|
void |
setBackendPrivateIps(String[] BackendPrivateIps)
Set 负载均衡绑定的后端服务的内网 IP,只支持查询云服务器的内网 IP。
|
void |
setBackendPublicIps(String[] BackendPublicIps)
Set 负载均衡绑定的后端服务的外网 IP,只支持查询云服务器的公网 IP。
|
void |
setDomain(String Domain)
Set 腾讯云为负载均衡实例分配的域名,支持模糊查询。
|
void |
setFilters(Filter[] Filters)
Set 每次请求的`Filters`的上限为10,`Filter.Values`的上限为100。
`Filter.Name`和`Filter.Values`皆为必填项。详细的过滤条件如下: - charge-type 按照【实例计费模式】进行过滤。实例计费模式例如:PREPAID。 类型:String 必选:否 可选项:PREPAID(预付费)、POSTPAID_BY_HOUR(后付费) - internet-charge-type 按照【网络计费模式】进行过滤。网络计费模式例如:BANDWIDTH_PREPAID。 类型:String 必选:否 可选项:BANDWIDTH_PREPAID(预付费按带宽结算)、 TRAFFIC_POSTPAID_BY_HOUR(流量按小时后付费)、BANDWIDTH_POSTPAID_BY_HOUR(带宽按小时后付费)、BANDWIDTH_PACKAGE(带宽包用户) - master-zone-id 按照【CLB主可用区ID】进行过滤。例如:100001(对应的是广州一区)。 类型:String 必选:否 获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707) - tag-key 按照【CLB 标签的键】进行过滤,例如:tag-key。 类型:String 必选:否 获取方式:[DescribeTags](https://cloud.tencent.com/document/api/651/35316) - tag:tag-key 按照【CLB标签键值】进行过滤,例如:tag-test。 类型:String 必选:否 获取方式:[DescribeTagKeys](https://cloud.tencent.com/document/api/651/35318) - function-name 按照【后端绑定SCF云函数的函数名称】进行过滤,例如:helloworld-1744958255。 类型:String 必选:否 获取方式:[ListFunctions](https://cloud.tencent.com/document/api/583/18582) - vip-isp 按照【CLB VIP的运营商类型】进行过滤,例如:BGP。 类型:String 必选:否 公网类型可选项:BGP(多线)、CMCC(中国移动)、CTCC(中国电信)、CUCC(中国联通) 内网类型可选项:INTERNAL(内网) - sla-type 按照【CLB 的性能容量型规格】进行过滤,例如:clb.c4.xlarge。 类型:String 必选:否 可选项:clb.c2.medium(标准型)、clb.c3.small(高阶型1)、clb.c3.medium(高阶型2)、clb.c4.small(超强型1)、clb.c4.medium(超强型2)、clb.c4.large(超强型3)、clb.c4.xlarge(超强型4) 具体规格参数参考: - exclusive 按照【独占实例】进行过滤。例如:1,代表筛选独占型实例。 类型:String 必选:否 可选项:0、1 |
void |
setForward(Long Forward)
Set 负载均衡实例的类型。1:通用的负载均衡实例,0:传统型负载均衡实例。如果不传此参数,则查询所有类型的负载均衡实例。
|
void |
setLimit(Long Limit)
Set 返回负载均衡实例的数量,默认为20,最大值为100。
|
void |
setLoadBalancerIds(String[] LoadBalancerIds)
Set 负载均衡实例ID。实例ID数量上限为20个。
|
void |
setLoadBalancerName(String LoadBalancerName)
Set 负载均衡实例的名称,支持模糊查询。
|
void |
setLoadBalancerType(String LoadBalancerType)
Set 负载均衡实例的网络类型:
OPEN:公网属性, INTERNAL:内网属性。
|
void |
setLoadBalancerVips(String[] LoadBalancerVips)
Set 负载均衡实例的 VIP 地址,支持多个。
|
void |
setMasterZone(String MasterZone)
Set 主可用区ID,如 :"100001" (对应的是广州一区)。可通过[DescribeZones](https://cloud.tencent.com/document/product/213/15707)获取可用区列表。
|
void |
setOffset(Long Offset)
Set 数据偏移量,默认为0。
|
void |
setOrderBy(String OrderBy)
Set 排序参数,支持以下字段:
- LoadBalancerName
- CreateTime
- Domain
- LoadBalancerType
默认为 CreateTime。
|
void |
setOrderType(Long OrderType)
Set 1:倒序,0:顺序,默认为1,按照创建时间倒序。
|
void |
setProjectId(Long ProjectId)
Set 负载均衡实例所属的项目 ID,可以通过[DescribeProject](https://cloud.tencent.com/document/api/651/78725)接口获取,不传默认所有项目。
|
void |
setSearchKey(String SearchKey)
Set 模糊搜索字段,模糊匹配负载均衡实例的名称、域名、负载均衡实例的 VIP 地址,负载均衡实例ID。
|
void |
setSecurityGroup(String SecurityGroup)
Set 安全组ID,如 sg-m1cc****,可以通过接口[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)获取。
|
void |
setVpcId(String VpcId)
Set 负载均衡实例所属私有网络唯一ID,如 vpc-bhqkbhdx,可以通过[DescribeVpcs](https://cloud.tencent.com/document/api/215/15778)接口获取。
查找基础网络类型的负载均衡可传入'0'。
|
void |
setWithRs(Long WithRs)
Set 负载均衡是否绑定后端服务,0:没有绑定后端服务,1:绑定后端服务,-1:查询全部。
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public DescribeLoadBalancersRequest()
public DescribeLoadBalancersRequest(DescribeLoadBalancersRequest source)
public String[] getLoadBalancerIds()
public void setLoadBalancerIds(String[] LoadBalancerIds)
LoadBalancerIds
- 负载均衡实例ID。实例ID数量上限为20个。public String getLoadBalancerType()
public void setLoadBalancerType(String LoadBalancerType)
LoadBalancerType
- 负载均衡实例的网络类型:
OPEN:公网属性, INTERNAL:内网属性。public Long getForward()
public void setForward(Long Forward)
Forward
- 负载均衡实例的类型。1:通用的负载均衡实例,0:传统型负载均衡实例。如果不传此参数,则查询所有类型的负载均衡实例。public String getLoadBalancerName()
public void setLoadBalancerName(String LoadBalancerName)
LoadBalancerName
- 负载均衡实例的名称,支持模糊查询。public String getDomain()
public void setDomain(String Domain)
Domain
- 腾讯云为负载均衡实例分配的域名,支持模糊查询。public String[] getLoadBalancerVips()
public void setLoadBalancerVips(String[] LoadBalancerVips)
LoadBalancerVips
- 负载均衡实例的 VIP 地址,支持多个。public String[] getBackendPublicIps()
public void setBackendPublicIps(String[] BackendPublicIps)
BackendPublicIps
- 负载均衡绑定的后端服务的外网 IP,只支持查询云服务器的公网 IP。public String[] getBackendPrivateIps()
public void setBackendPrivateIps(String[] BackendPrivateIps)
BackendPrivateIps
- 负载均衡绑定的后端服务的内网 IP,只支持查询云服务器的内网 IP。public Long getOffset()
public void setOffset(Long Offset)
Offset
- 数据偏移量,默认为0。public Long getLimit()
public void setLimit(Long Limit)
Limit
- 返回负载均衡实例的数量,默认为20,最大值为100。public String getOrderBy()
public void setOrderBy(String OrderBy)
OrderBy
- 排序参数,支持以下字段:
- LoadBalancerName
- CreateTime
- Domain
- LoadBalancerType
默认为 CreateTime。public Long getOrderType()
public void setOrderType(Long OrderType)
OrderType
- 1:倒序,0:顺序,默认为1,按照创建时间倒序。public String getSearchKey()
public void setSearchKey(String SearchKey)
SearchKey
- 模糊搜索字段,模糊匹配负载均衡实例的名称、域名、负载均衡实例的 VIP 地址,负载均衡实例ID。public Long getProjectId()
public void setProjectId(Long ProjectId)
ProjectId
- 负载均衡实例所属的项目 ID,可以通过[DescribeProject](https://cloud.tencent.com/document/api/651/78725)接口获取,不传默认所有项目。public Long getWithRs()
public void setWithRs(Long WithRs)
WithRs
- 负载均衡是否绑定后端服务,0:没有绑定后端服务,1:绑定后端服务,-1:查询全部。public String getVpcId()
public void setVpcId(String VpcId)
VpcId
- 负载均衡实例所属私有网络唯一ID,如 vpc-bhqkbhdx,可以通过[DescribeVpcs](https://cloud.tencent.com/document/api/215/15778)接口获取。
查找基础网络类型的负载均衡可传入'0'。public String getSecurityGroup()
public void setSecurityGroup(String SecurityGroup)
SecurityGroup
- 安全组ID,如 sg-m1cc****,可以通过接口[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)获取。public String getMasterZone()
public void setMasterZone(String MasterZone)
MasterZone
- 主可用区ID,如 :"100001" (对应的是广州一区)。可通过[DescribeZones](https://cloud.tencent.com/document/product/213/15707)获取可用区列表。public Filter[] getFilters()
public void setFilters(Filter[] Filters)
Filters
- 每次请求的`Filters`的上限为10,`Filter.Values`的上限为100。public String[] getAdditionalFields()
public void setAdditionalFields(String[] AdditionalFields)
AdditionalFields
- 选择返回的扩充字段,不指定时,扩充字段默认不返回。详细支持的扩充字段如下:
Copyright © 2025. All rights reserved.