Class DescribeInstancesRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Filter[] getFilters()
      Get 过滤器列表。 instance-name按照【实例名称】进行过滤。 类型:String 必选:否 private-ip-address按照【实例主网卡的内网 IP】进行过滤。 类型:String 必选:否 public-ip-address按照【实例主网卡的公网 IP】进行过滤。 类型:String 必选:否 zone按照【可用区】进行过滤。 类型:String 必选:否 instance-state按照【实例状态】进行过滤。 类型:String 必选:否 tag-key按照【标签键】进行过滤。 类型:String 必选:否 tag-value按照【标签值】进行过滤。 类型:String 必选:否 tag:tag-key按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 类型:String 必选:否 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 InstanceIds 和 Filters。
      String[] getInstanceIds()
      Get 实例 ID 列表。每次请求批量实例的上限为 100。
      Long getLimit()
      Get 返回数量,默认为 20,最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
      Long getOffset()
      Get 偏移量,默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
      void setFilters​(Filter[] Filters)
      Set 过滤器列表。 instance-name按照【实例名称】进行过滤。 类型:String 必选:否 private-ip-address按照【实例主网卡的内网 IP】进行过滤。 类型:String 必选:否 public-ip-address按照【实例主网卡的公网 IP】进行过滤。 类型:String 必选:否 zone按照【可用区】进行过滤。 类型:String 必选:否 instance-state按照【实例状态】进行过滤。 类型:String 必选:否 tag-key按照【标签键】进行过滤。 类型:String 必选:否 tag-value按照【标签值】进行过滤。 类型:String 必选:否 tag:tag-key按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 类型:String 必选:否 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 InstanceIds 和 Filters。
      void setInstanceIds​(String[] InstanceIds)
      Set 实例 ID 列表。每次请求批量实例的上限为 100。
      void setLimit​(Long Limit)
      Set 返回数量,默认为 20,最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
      void setOffset​(Long Offset)
      Set 偏移量,默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • DescribeInstancesRequest

        public DescribeInstancesRequest()
      • DescribeInstancesRequest

        public DescribeInstancesRequest​(DescribeInstancesRequest 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

      • getInstanceIds

        public String[] getInstanceIds()
        Get 实例 ID 列表。每次请求批量实例的上限为 100。
        Returns:
        InstanceIds 实例 ID 列表。每次请求批量实例的上限为 100。
      • setInstanceIds

        public void setInstanceIds​(String[] InstanceIds)
        Set 实例 ID 列表。每次请求批量实例的上限为 100。
        Parameters:
        InstanceIds - 实例 ID 列表。每次请求批量实例的上限为 100。
      • getFilters

        public Filter[] getFilters()
        Get 过滤器列表。
      • instance-name
      • 按照【实例名称】进行过滤。 类型:String 必选:否
      • private-ip-address
      • 按照【实例主网卡的内网 IP】进行过滤。 类型:String 必选:否
      • public-ip-address
      • 按照【实例主网卡的公网 IP】进行过滤。 类型:String 必选:否
      • zone
      • 按照【可用区】进行过滤。 类型:String 必选:否
      • instance-state
      • 按照【实例状态】进行过滤。 类型:String 必选:否
      • tag-key
      • 按照【标签键】进行过滤。 类型:String 必选:否
      • tag-value
      • 按照【标签值】进行过滤。 类型:String 必选:否
      • tag:tag-key
      • 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 类型:String 必选:否 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 InstanceIds 和 Filters。
Returns:
Filters 过滤器列表。
  • instance-name
  • 按照【实例名称】进行过滤。 类型:String 必选:否
  • private-ip-address
  • 按照【实例主网卡的内网 IP】进行过滤。 类型:String 必选:否
  • public-ip-address
  • 按照【实例主网卡的公网 IP】进行过滤。 类型:String 必选:否
  • zone
  • 按照【可用区】进行过滤。 类型:String 必选:否
  • instance-state
  • 按照【实例状态】进行过滤。 类型:String 必选:否
  • tag-key
  • 按照【标签键】进行过滤。 类型:String 必选:否
  • tag-value
  • 按照【标签值】进行过滤。 类型:String 必选:否
  • tag:tag-key
  • 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 类型:String 必选:否 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 InstanceIds 和 Filters。
    Parameters:
    Filters - 过滤器列表。
  • instance-name
  • 按照【实例名称】进行过滤。 类型:String 必选:否
  • private-ip-address
  • 按照【实例主网卡的内网 IP】进行过滤。 类型:String 必选:否
  • public-ip-address
  • 按照【实例主网卡的公网 IP】进行过滤。 类型:String 必选:否
  • zone
  • 按照【可用区】进行过滤。 类型:String 必选:否
  • instance-state
  • 按照【实例状态】进行过滤。 类型:String 必选:否
  • tag-key
  • 按照【标签键】进行过滤。 类型:String 必选:否
  • tag-value
  • 按照【标签值】进行过滤。 类型:String 必选:否
  • tag:tag-key
  • 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 类型:String 必选:否 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 InstanceIds 和 Filters。