Package com.tencentcloudapi.ecm.v20190719.models

Class DescribeInstancesRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Filter[] getFilters()
      Get 过滤条件。 zone String 是否必填：否 （过滤条件）按照可用区英文标识符过滤。 zone-name String 是否必填：否 （过滤条件）按照可用区中文名过滤,支持模糊匹配。 module-id String 是否必填：否 （过滤条件）按照模块ID过滤。 instance-id String 是否必填：否 （过滤条件）按照实例ID过滤。 instance-name String 是否必填：否 （过滤条件）按照实例名称过滤,支持模糊匹配。 ip-address String 是否必填：否 （过滤条件）按照实例的内网/公网IP过滤。 instance-uuid string 是否必填：否 （过滤条件）按照uuid过滤实例列表。 instance-state string 是否必填：否 （过滤条件）按照实例状态更新实例列表。 internet-service-provider String 是否必填：否 （过滤条件）按照实例公网IP所属的运营商进行过滤。 tag-key String 是否必填：否 （过滤条件）按照标签键进行过滤。 tag:tag-key String 是否必填：否 （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 instance-family String 是否必填：否 （过滤条件）按照机型family过滤。 module-name String 是否必填：否 （过滤条件）按照模块名称过滤,支持模糊匹配。 image-id String 是否必填：否 （过滤条件）按照实例的镜像ID过滤。 vpc-id String 是否必填：否 （过滤条件）按照实例的vpc id过滤。 subnet-id String 是否必填：否 （过滤条件）按照实例的subnet id过滤。 若不传Filters参数则表示查询所有相关的实例信息。 单次请求的Filter.Values的上限为5。
      Long getLimit()
      Get 返回数量，默认为20(如果查询结果数目大于等于20)，最大值为100。
      Long getOffset()
      Get 偏移量，默认为0。
      String getOrderByField()
      Get 指定排序字段。目前支持的可选值如下 timestamp 按实例创建时间排序。 注意：目前仅支持按创建时间排序，后续可能会有扩展。 如果不传，默认按实例创建时间排序
      Long getOrderDirection()
      Get 指定排序是降序还是升序。0表示降序； 1表示升序。如果不传默认为降序
      void setFilters​(Filter[] Filters)
      Set 过滤条件。 zone String 是否必填：否 （过滤条件）按照可用区英文标识符过滤。 zone-name String 是否必填：否 （过滤条件）按照可用区中文名过滤,支持模糊匹配。 module-id String 是否必填：否 （过滤条件）按照模块ID过滤。 instance-id String 是否必填：否 （过滤条件）按照实例ID过滤。 instance-name String 是否必填：否 （过滤条件）按照实例名称过滤,支持模糊匹配。 ip-address String 是否必填：否 （过滤条件）按照实例的内网/公网IP过滤。 instance-uuid string 是否必填：否 （过滤条件）按照uuid过滤实例列表。 instance-state string 是否必填：否 （过滤条件）按照实例状态更新实例列表。 internet-service-provider String 是否必填：否 （过滤条件）按照实例公网IP所属的运营商进行过滤。 tag-key String 是否必填：否 （过滤条件）按照标签键进行过滤。 tag:tag-key String 是否必填：否 （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 instance-family String 是否必填：否 （过滤条件）按照机型family过滤。 module-name String 是否必填：否 （过滤条件）按照模块名称过滤,支持模糊匹配。 image-id String 是否必填：否 （过滤条件）按照实例的镜像ID过滤。 vpc-id String 是否必填：否 （过滤条件）按照实例的vpc id过滤。 subnet-id String 是否必填：否 （过滤条件）按照实例的subnet id过滤。 若不传Filters参数则表示查询所有相关的实例信息。 单次请求的Filter.Values的上限为5。
      void setLimit​(Long Limit)
      Set 返回数量，默认为20(如果查询结果数目大于等于20)，最大值为100。
      void setOffset​(Long Offset)
      Set 偏移量，默认为0。
      void setOrderByField​(String OrderByField)
      Set 指定排序字段。目前支持的可选值如下 timestamp 按实例创建时间排序。 注意：目前仅支持按创建时间排序，后续可能会有扩展。 如果不传，默认按实例创建时间排序
      void setOrderDirection​(Long OrderDirection)
      Set 指定排序是降序还是升序。0表示降序； 1表示升序。如果不传默认为降序
      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

      • getFilters

        public Filter[] getFilters()
        Get 过滤条件。 zone String 是否必填：否 （过滤条件）按照可用区英文标识符过滤。 zone-name String 是否必填：否 （过滤条件）按照可用区中文名过滤,支持模糊匹配。 module-id String 是否必填：否 （过滤条件）按照模块ID过滤。 instance-id String 是否必填：否 （过滤条件）按照实例ID过滤。 instance-name String 是否必填：否 （过滤条件）按照实例名称过滤,支持模糊匹配。 ip-address String 是否必填：否 （过滤条件）按照实例的内网/公网IP过滤。 instance-uuid string 是否必填：否 （过滤条件）按照uuid过滤实例列表。 instance-state string 是否必填：否 （过滤条件）按照实例状态更新实例列表。 internet-service-provider String 是否必填：否 （过滤条件）按照实例公网IP所属的运营商进行过滤。 tag-key String 是否必填：否 （过滤条件）按照标签键进行过滤。 tag:tag-key String 是否必填：否 （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 instance-family String 是否必填：否 （过滤条件）按照机型family过滤。 module-name String 是否必填：否 （过滤条件）按照模块名称过滤,支持模糊匹配。 image-id String 是否必填：否 （过滤条件）按照实例的镜像ID过滤。 vpc-id String 是否必填：否 （过滤条件）按照实例的vpc id过滤。 subnet-id String 是否必填：否 （过滤条件）按照实例的subnet id过滤。 若不传Filters参数则表示查询所有相关的实例信息。 单次请求的Filter.Values的上限为5。
        Returns:
        Filters 过滤条件。 zone String 是否必填：否 （过滤条件）按照可用区英文标识符过滤。 zone-name String 是否必填：否 （过滤条件）按照可用区中文名过滤,支持模糊匹配。 module-id String 是否必填：否 （过滤条件）按照模块ID过滤。 instance-id String 是否必填：否 （过滤条件）按照实例ID过滤。 instance-name String 是否必填：否 （过滤条件）按照实例名称过滤,支持模糊匹配。 ip-address String 是否必填：否 （过滤条件）按照实例的内网/公网IP过滤。 instance-uuid string 是否必填：否 （过滤条件）按照uuid过滤实例列表。 instance-state string 是否必填：否 （过滤条件）按照实例状态更新实例列表。 internet-service-provider String 是否必填：否 （过滤条件）按照实例公网IP所属的运营商进行过滤。 tag-key String 是否必填：否 （过滤条件）按照标签键进行过滤。 tag:tag-key String 是否必填：否 （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 instance-family String 是否必填：否 （过滤条件）按照机型family过滤。 module-name String 是否必填：否 （过滤条件）按照模块名称过滤,支持模糊匹配。 image-id String 是否必填：否 （过滤条件）按照实例的镜像ID过滤。 vpc-id String 是否必填：否 （过滤条件）按照实例的vpc id过滤。 subnet-id String 是否必填：否 （过滤条件）按照实例的subnet id过滤。 若不传Filters参数则表示查询所有相关的实例信息。 单次请求的Filter.Values的上限为5。

      • setFilters

        public void setFilters​(Filter[] Filters)
        Set 过滤条件。 zone String 是否必填：否 （过滤条件）按照可用区英文标识符过滤。 zone-name String 是否必填：否 （过滤条件）按照可用区中文名过滤,支持模糊匹配。 module-id String 是否必填：否 （过滤条件）按照模块ID过滤。 instance-id String 是否必填：否 （过滤条件）按照实例ID过滤。 instance-name String 是否必填：否 （过滤条件）按照实例名称过滤,支持模糊匹配。 ip-address String 是否必填：否 （过滤条件）按照实例的内网/公网IP过滤。 instance-uuid string 是否必填：否 （过滤条件）按照uuid过滤实例列表。 instance-state string 是否必填：否 （过滤条件）按照实例状态更新实例列表。 internet-service-provider String 是否必填：否 （过滤条件）按照实例公网IP所属的运营商进行过滤。 tag-key String 是否必填：否 （过滤条件）按照标签键进行过滤。 tag:tag-key String 是否必填：否 （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 instance-family String 是否必填：否 （过滤条件）按照机型family过滤。 module-name String 是否必填：否 （过滤条件）按照模块名称过滤,支持模糊匹配。 image-id String 是否必填：否 （过滤条件）按照实例的镜像ID过滤。 vpc-id String 是否必填：否 （过滤条件）按照实例的vpc id过滤。 subnet-id String 是否必填：否 （过滤条件）按照实例的subnet id过滤。 若不传Filters参数则表示查询所有相关的实例信息。 单次请求的Filter.Values的上限为5。
        Parameters:
        Filters - 过滤条件。 zone String 是否必填：否 （过滤条件）按照可用区英文标识符过滤。 zone-name String 是否必填：否 （过滤条件）按照可用区中文名过滤,支持模糊匹配。 module-id String 是否必填：否 （过滤条件）按照模块ID过滤。 instance-id String 是否必填：否 （过滤条件）按照实例ID过滤。 instance-name String 是否必填：否 （过滤条件）按照实例名称过滤,支持模糊匹配。 ip-address String 是否必填：否 （过滤条件）按照实例的内网/公网IP过滤。 instance-uuid string 是否必填：否 （过滤条件）按照uuid过滤实例列表。 instance-state string 是否必填：否 （过滤条件）按照实例状态更新实例列表。 internet-service-provider String 是否必填：否 （过滤条件）按照实例公网IP所属的运营商进行过滤。 tag-key String 是否必填：否 （过滤条件）按照标签键进行过滤。 tag:tag-key String 是否必填：否 （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 instance-family String 是否必填：否 （过滤条件）按照机型family过滤。 module-name String 是否必填：否 （过滤条件）按照模块名称过滤,支持模糊匹配。 image-id String 是否必填：否 （过滤条件）按照实例的镜像ID过滤。 vpc-id String 是否必填：否 （过滤条件）按照实例的vpc id过滤。 subnet-id String 是否必填：否 （过滤条件）按照实例的subnet id过滤。 若不传Filters参数则表示查询所有相关的实例信息。 单次请求的Filter.Values的上限为5。

      • 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(如果查询结果数目大于等于20)，最大值为100。
        Returns:
        Limit 返回数量，默认为20(如果查询结果数目大于等于20)，最大值为100。

      • setLimit

        public void setLimit​(Long Limit)
        Set 返回数量，默认为20(如果查询结果数目大于等于20)，最大值为100。
        Parameters:
        Limit - 返回数量，默认为20(如果查询结果数目大于等于20)，最大值为100。

      • getOrderByField

        public String getOrderByField()
        Get 指定排序字段。目前支持的可选值如下 timestamp 按实例创建时间排序。 注意：目前仅支持按创建时间排序，后续可能会有扩展。 如果不传，默认按实例创建时间排序
        Returns:
        OrderByField 指定排序字段。目前支持的可选值如下 timestamp 按实例创建时间排序。 注意：目前仅支持按创建时间排序，后续可能会有扩展。 如果不传，默认按实例创建时间排序

      • setOrderByField

        public void setOrderByField​(String OrderByField)
        Set 指定排序字段。目前支持的可选值如下 timestamp 按实例创建时间排序。 注意：目前仅支持按创建时间排序，后续可能会有扩展。 如果不传，默认按实例创建时间排序
        Parameters:
        OrderByField - 指定排序字段。目前支持的可选值如下 timestamp 按实例创建时间排序。 注意：目前仅支持按创建时间排序，后续可能会有扩展。 如果不传，默认按实例创建时间排序

      • getOrderDirection

        public Long getOrderDirection()
        Get 指定排序是降序还是升序。0表示降序； 1表示升序。如果不传默认为降序
        Returns:
        OrderDirection 指定排序是降序还是升序。0表示降序； 1表示升序。如果不传默认为降序

      • setOrderDirection

        public void setOrderDirection​(Long OrderDirection)
        Set 指定排序是降序还是升序。0表示降序； 1表示升序。如果不传默认为降序
        Parameters:
        OrderDirection - 指定排序是降序还是升序。0表示降序； 1表示升序。如果不传默认为降序