Package com.tencentcloudapi.clb.v20180317.models

Class DescribeLoadBalancersRequest

  • public class DescribeLoadBalancersRequest
extends AbstractModel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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 - String - 是否必填：否 - （过滤条件）按照 CLB 的实例计费模式过滤，包括"PREPAID","POSTPAID_BY_HOUR"。 internet-charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的网络计费模式过滤，包括"BANDWIDTH_PREPAID","TRAFFIC_POSTPAID_BY_HOUR","BANDWIDTH_POSTPAID_BY_HOUR","BANDWIDTH_PACKAGE"。 master-zone-id - String - 是否必填：否 - （过滤条件）按照 CLB 的主可用区ID过滤，如 ："100001" （对应的是广州一区）。 tag-key - String - 是否必填：否 - （过滤条件）按照 CLB 标签的键过滤。 tag:tag-key - String - 是否必填：否 - （过滤条件）按照CLB标签键值对进行过滤，tag-key使用具体的标签键进行替换。 function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。 function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。 vip-isp - String - 是否必填：否 - （过滤条件）按照 CLB VIP的运营商类型过滤，如："BGP","INTERNAL","CMCC","CTCC","CUCC"等。 sla-type - String - 是否必填：否 - （过滤条件）按照 CLB 的性能容量型规格过滤，包括"clb.c2.medium","clb.c3.small","clb.c3.medium","clb.c4.small","clb.c4.medium","clb.c4.large","clb.c4.xlarge"。
      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" （对应的是广州一区）。
      Long getOffset()
      Get 数据偏移量，默认为0。
      String getOrderBy()
      Get 排序参数，支持以下字段：LoadBalancerName，CreateTime，Domain，LoadBalancerType。
      Long getOrderType()
      Get 1：倒序，0：顺序，默认按照创建时间倒序。
      Long getProjectId()
      Get 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。
      String getSearchKey()
      Get 搜索字段，模糊匹配名称、域名、VIP。
      String getSecurityGroup()
      Get 安全组ID，如 sg-m1cc****。
      String getVpcId()
      Get 负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx， 基础网络可传入'0'。
      Long getWithRs()
      Get 负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。
      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 - String - 是否必填：否 - （过滤条件）按照 CLB 的实例计费模式过滤，包括"PREPAID","POSTPAID_BY_HOUR"。 internet-charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的网络计费模式过滤，包括"BANDWIDTH_PREPAID","TRAFFIC_POSTPAID_BY_HOUR","BANDWIDTH_POSTPAID_BY_HOUR","BANDWIDTH_PACKAGE"。 master-zone-id - String - 是否必填：否 - （过滤条件）按照 CLB 的主可用区ID过滤，如 ："100001" （对应的是广州一区）。 tag-key - String - 是否必填：否 - （过滤条件）按照 CLB 标签的键过滤。 tag:tag-key - String - 是否必填：否 - （过滤条件）按照CLB标签键值对进行过滤，tag-key使用具体的标签键进行替换。 function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。 function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。 vip-isp - String - 是否必填：否 - （过滤条件）按照 CLB VIP的运营商类型过滤，如："BGP","INTERNAL","CMCC","CTCC","CUCC"等。 sla-type - String - 是否必填：否 - （过滤条件）按照 CLB 的性能容量型规格过滤，包括"clb.c2.medium","clb.c3.small","clb.c3.medium","clb.c4.small","clb.c4.medium","clb.c4.large","clb.c4.xlarge"。
      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" （对应的是广州一区）。
      void setOffset​(Long Offset)
      Set 数据偏移量，默认为0。
      void setOrderBy​(String OrderBy)
      Set 排序参数，支持以下字段：LoadBalancerName，CreateTime，Domain，LoadBalancerType。
      void setOrderType​(Long OrderType)
      Set 1：倒序，0：顺序，默认按照创建时间倒序。
      void setProjectId​(Long ProjectId)
      Set 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。
      void setSearchKey​(String SearchKey)
      Set 搜索字段，模糊匹配名称、域名、VIP。
      void setSecurityGroup​(String SecurityGroup)
      Set 安全组ID，如 sg-m1cc****。
      void setVpcId​(String VpcId)
      Set 负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx， 基础网络可传入'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.

    • Constructor Detail

      • DescribeLoadBalancersRequest

        public DescribeLoadBalancersRequest()

      • DescribeLoadBalancersRequest

        public 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.

    • Method Detail

      • getLoadBalancerIds

        public String[] getLoadBalancerIds()
        Get 负载均衡实例ID。实例ID数量上限为20个。
        Returns:
        LoadBalancerIds 负载均衡实例ID。实例ID数量上限为20个。

      • setLoadBalancerIds

        public void setLoadBalancerIds​(String[] LoadBalancerIds)
        Set 负载均衡实例ID。实例ID数量上限为20个。
        Parameters:
        LoadBalancerIds - 负载均衡实例ID。实例ID数量上限为20个。

      • getLoadBalancerType

        public String getLoadBalancerType()
        Get 负载均衡实例的网络类型： OPEN：公网属性， INTERNAL：内网属性。
        Returns:
        LoadBalancerType 负载均衡实例的网络类型： OPEN：公网属性， INTERNAL：内网属性。

      • setLoadBalancerType

        public void setLoadBalancerType​(String LoadBalancerType)
        Set 负载均衡实例的网络类型： OPEN：公网属性， INTERNAL：内网属性。
        Parameters:
        LoadBalancerType - 负载均衡实例的网络类型： OPEN：公网属性， INTERNAL：内网属性。

      • getForward

        public Long getForward()
        Get 负载均衡实例的类型。1：通用的负载均衡实例，0：传统型负载均衡实例。如果不传此参数，则查询所有类型的负载均衡实例。
        Returns:
        Forward 负载均衡实例的类型。1：通用的负载均衡实例，0：传统型负载均衡实例。如果不传此参数，则查询所有类型的负载均衡实例。

      • setForward

        public void setForward​(Long Forward)
        Set 负载均衡实例的类型。1：通用的负载均衡实例，0：传统型负载均衡实例。如果不传此参数，则查询所有类型的负载均衡实例。
        Parameters:
        Forward - 负载均衡实例的类型。1：通用的负载均衡实例，0：传统型负载均衡实例。如果不传此参数，则查询所有类型的负载均衡实例。

      • getLoadBalancerName

        public String getLoadBalancerName()
        Get 负载均衡实例的名称。
        Returns:
        LoadBalancerName 负载均衡实例的名称。

      • setLoadBalancerName

        public void setLoadBalancerName​(String LoadBalancerName)
        Set 负载均衡实例的名称。
        Parameters:
        LoadBalancerName - 负载均衡实例的名称。

      • getDomain

        public String getDomain()
        Get 腾讯云为负载均衡实例分配的域名。
        Returns:
        Domain 腾讯云为负载均衡实例分配的域名。

      • setDomain

        public void setDomain​(String Domain)
        Set 腾讯云为负载均衡实例分配的域名。
        Parameters:
        Domain - 腾讯云为负载均衡实例分配的域名。

      • getLoadBalancerVips

        public String[] getLoadBalancerVips()
        Get 负载均衡实例的 VIP 地址，支持多个。
        Returns:
        LoadBalancerVips 负载均衡实例的 VIP 地址，支持多个。

      • setLoadBalancerVips

        public void setLoadBalancerVips​(String[] LoadBalancerVips)
        Set 负载均衡实例的 VIP 地址，支持多个。
        Parameters:
        LoadBalancerVips - 负载均衡实例的 VIP 地址，支持多个。

      • getBackendPublicIps

        public String[] getBackendPublicIps()
        Get 负载均衡绑定的后端服务的外网 IP，只支持查询云服务器的公网 IP。
        Returns:
        BackendPublicIps 负载均衡绑定的后端服务的外网 IP，只支持查询云服务器的公网 IP。

      • setBackendPublicIps

        public void setBackendPublicIps​(String[] BackendPublicIps)
        Set 负载均衡绑定的后端服务的外网 IP，只支持查询云服务器的公网 IP。
        Parameters:
        BackendPublicIps - 负载均衡绑定的后端服务的外网 IP，只支持查询云服务器的公网 IP。

      • getBackendPrivateIps

        public String[] getBackendPrivateIps()
        Get 负载均衡绑定的后端服务的内网 IP，只支持查询云服务器的内网 IP。
        Returns:
        BackendPrivateIps 负载均衡绑定的后端服务的内网 IP，只支持查询云服务器的内网 IP。

      • setBackendPrivateIps

        public void setBackendPrivateIps​(String[] BackendPrivateIps)
        Set 负载均衡绑定的后端服务的内网 IP，只支持查询云服务器的内网 IP。
        Parameters:
        BackendPrivateIps - 负载均衡绑定的后端服务的内网 IP，只支持查询云服务器的内网 IP。

      • getOffset

        public Long getOffset()
        Get 数据偏移量，默认为0。
        Returns:
        Offset 数据偏移量，默认为0。

      • setOffset

        public void setOffset​(Long Offset)
        Set 数据偏移量，默认为0。
        Parameters:
        Offset - 数据偏移量，默认为0。

      • getLimit

        public Long getLimit()
        Get 返回负载均衡实例的数量，默认为20，最大值为100。
        Returns:
        Limit 返回负载均衡实例的数量，默认为20，最大值为100。

      • setLimit

        public void setLimit​(Long Limit)
        Set 返回负载均衡实例的数量，默认为20，最大值为100。
        Parameters:
        Limit - 返回负载均衡实例的数量，默认为20，最大值为100。

      • getOrderBy

        public String getOrderBy()
        Get 排序参数，支持以下字段：LoadBalancerName，CreateTime，Domain，LoadBalancerType。
        Returns:
        OrderBy 排序参数，支持以下字段：LoadBalancerName，CreateTime，Domain，LoadBalancerType。

      • setOrderBy

        public void setOrderBy​(String OrderBy)
        Set 排序参数，支持以下字段：LoadBalancerName，CreateTime，Domain，LoadBalancerType。
        Parameters:
        OrderBy - 排序参数，支持以下字段：LoadBalancerName，CreateTime，Domain，LoadBalancerType。

      • getOrderType

        public Long getOrderType()
        Get 1：倒序，0：顺序，默认按照创建时间倒序。
        Returns:
        OrderType 1：倒序，0：顺序，默认按照创建时间倒序。

      • setOrderType

        public void setOrderType​(Long OrderType)
        Set 1：倒序，0：顺序，默认按照创建时间倒序。
        Parameters:
        OrderType - 1：倒序，0：顺序，默认按照创建时间倒序。

      • getSearchKey

        public String getSearchKey()
        Get 搜索字段，模糊匹配名称、域名、VIP。
        Returns:
        SearchKey 搜索字段，模糊匹配名称、域名、VIP。

      • setSearchKey

        public void setSearchKey​(String SearchKey)
        Set 搜索字段，模糊匹配名称、域名、VIP。
        Parameters:
        SearchKey - 搜索字段，模糊匹配名称、域名、VIP。

      • getProjectId

        public Long getProjectId()
        Get 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。
        Returns:
        ProjectId 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。

      • setProjectId

        public void setProjectId​(Long ProjectId)
        Set 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。
        Parameters:
        ProjectId - 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。

      • getWithRs

        public Long getWithRs()
        Get 负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。
        Returns:
        WithRs 负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。

      • setWithRs

        public void setWithRs​(Long WithRs)
        Set 负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。
        Parameters:
        WithRs - 负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。

      • getVpcId

        public String getVpcId()
        Get 负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx， 基础网络可传入'0'。
        Returns:
        VpcId 负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx， 基础网络可传入'0'。

      • setVpcId

        public void setVpcId​(String VpcId)
        Set 负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx， 基础网络可传入'0'。
        Parameters:
        VpcId - 负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx， 基础网络可传入'0'。

      • getSecurityGroup

        public String getSecurityGroup()
        Get 安全组ID，如 sg-m1cc****。
        Returns:
        SecurityGroup 安全组ID，如 sg-m1cc****。

      • setSecurityGroup

        public void setSecurityGroup​(String SecurityGroup)
        Set 安全组ID，如 sg-m1cc****。
        Parameters:
        SecurityGroup - 安全组ID，如 sg-m1cc****。

      • getMasterZone

        public String getMasterZone()
        Get 主可用区ID，如 ："100001" （对应的是广州一区）。
        Returns:
        MasterZone 主可用区ID，如 ："100001" （对应的是广州一区）。

      • setMasterZone

        public void setMasterZone​(String MasterZone)
        Set 主可用区ID，如 ："100001" （对应的是广州一区）。
        Parameters:
        MasterZone - 主可用区ID，如 ："100001" （对应的是广州一区）。

      • getFilters

        public Filter[] getFilters()
        Get 每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。
        `Filter.Name`和`Filter.Values`皆为必填项。详细的过滤条件如下：
      • charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的实例计费模式过滤，包括"PREPAID","POSTPAID_BY_HOUR"。
      • internet-charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的网络计费模式过滤，包括"BANDWIDTH_PREPAID","TRAFFIC_POSTPAID_BY_HOUR","BANDWIDTH_POSTPAID_BY_HOUR","BANDWIDTH_PACKAGE"。
      • master-zone-id - String - 是否必填：否 - （过滤条件）按照 CLB 的主可用区ID过滤，如 ："100001" （对应的是广州一区）。
      • tag-key - String - 是否必填：否 - （过滤条件）按照 CLB 标签的键过滤。
      • tag:tag-key - String - 是否必填：否 - （过滤条件）按照CLB标签键值对进行过滤，tag-key使用具体的标签键进行替换。
      • function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。
      • function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。
      • vip-isp - String - 是否必填：否 - （过滤条件）按照 CLB VIP的运营商类型过滤，如："BGP","INTERNAL","CMCC","CTCC","CUCC"等。
      • sla-type - String - 是否必填：否 - （过滤条件）按照 CLB 的性能容量型规格过滤，包括"clb.c2.medium","clb.c3.small","clb.c3.medium","clb.c4.small","clb.c4.medium","clb.c4.large","clb.c4.xlarge"。
Returns:
Filters 每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。
`Filter.Name`和`Filter.Values`皆为必填项。详细的过滤条件如下：
  • charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的实例计费模式过滤，包括"PREPAID","POSTPAID_BY_HOUR"。
  • internet-charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的网络计费模式过滤，包括"BANDWIDTH_PREPAID","TRAFFIC_POSTPAID_BY_HOUR","BANDWIDTH_POSTPAID_BY_HOUR","BANDWIDTH_PACKAGE"。
  • master-zone-id - String - 是否必填：否 - （过滤条件）按照 CLB 的主可用区ID过滤，如 ："100001" （对应的是广州一区）。
  • tag-key - String - 是否必填：否 - （过滤条件）按照 CLB 标签的键过滤。
  • tag:tag-key - String - 是否必填：否 - （过滤条件）按照CLB标签键值对进行过滤，tag-key使用具体的标签键进行替换。
  • function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。
  • function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。
  • vip-isp - String - 是否必填：否 - （过滤条件）按照 CLB VIP的运营商类型过滤，如："BGP","INTERNAL","CMCC","CTCC","CUCC"等。
  • sla-type - String - 是否必填：否 - （过滤条件）按照 CLB 的性能容量型规格过滤，包括"clb.c2.medium","clb.c3.small","clb.c3.medium","clb.c4.small","clb.c4.medium","clb.c4.large","clb.c4.xlarge"。
    • Parameters:
    Filters - 每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。
    `Filter.Name`和`Filter.Values`皆为必填项。详细的过滤条件如下：
  • charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的实例计费模式过滤，包括"PREPAID","POSTPAID_BY_HOUR"。
  • internet-charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的网络计费模式过滤，包括"BANDWIDTH_PREPAID","TRAFFIC_POSTPAID_BY_HOUR","BANDWIDTH_POSTPAID_BY_HOUR","BANDWIDTH_PACKAGE"。
  • master-zone-id - String - 是否必填：否 - （过滤条件）按照 CLB 的主可用区ID过滤，如 ："100001" （对应的是广州一区）。
  • tag-key - String - 是否必填：否 - （过滤条件）按照 CLB 标签的键过滤。
  • tag:tag-key - String - 是否必填：否 - （过滤条件）按照CLB标签键值对进行过滤，tag-key使用具体的标签键进行替换。
  • function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。
  • function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。
  • vip-isp - String - 是否必填：否 - （过滤条件）按照 CLB VIP的运营商类型过滤，如："BGP","INTERNAL","CMCC","CTCC","CUCC"等。
  • sla-type - String - 是否必填：否 - （过滤条件）按照 CLB 的性能容量型规格过滤，包括"clb.c2.medium","clb.c3.small","clb.c3.medium","clb.c4.small","clb.c4.medium","clb.c4.large","clb.c4.xlarge"。