Class: TencentCloud::Cvm::V20170312::DescribeHostsRequest

Inherits:
TencentCloud::Common::AbstractModel
  • Object
show all
Defined in:
lib/v20170312/models.rb

Overview

DescribeHosts请求参数结构体

Instance Attribute Summary collapse

  • #Limit ⇒ Object

    按照【可用区】进行过滤。可用区形如：ap-guangzhou-6。

    类型：String

    必选：否

    可选项：可用区列表

  • project-id

    • 按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID形如：1002189。

    类型：Integer

    必选：否

  • host-id

    • 按照【[CDH](https://cloud.tencent.com/document/product/416) ID】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID形如：host-xxxxxxxx。

    类型：String

    必选：否

  • host-name

    • 按照【CDH实例名称】进行过滤。

    类型：String

    必选：否

  • host-state

    • 按照【CDH实例状态】进行过滤。（PENDING：创建中 | LAUNCH_FAILURE：创建失败 | RUNNING：运行中 | EXPIRED：已过期）

    类型：String

    必选：否

  • host-type

    • 按照【CDH机型】进行过滤。

    类型：String

    必选：否

  • tag-key

    • 按照【标签键】进行过滤。

    类型：String

    必选：否

  • tag-value

    • 按照【标签值】进行过滤。

    类型：String

    必选：否

  • tag:tag-key

    • 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例。

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。.
  • #Offset ⇒ Object

    按照【可用区】进行过滤。可用区形如：ap-guangzhou-6。

    类型：String

    必选：否

    可选项：可用区列表

  • project-id

    • 按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID形如：1002189。

    类型：Integer

    必选：否

  • host-id

    • 按照【[CDH](https://cloud.tencent.com/document/product/416) ID】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID形如：host-xxxxxxxx。

    类型：String

    必选：否

  • host-name

    • 按照【CDH实例名称】进行过滤。

    类型：String

    必选：否

  • host-state

    • 按照【CDH实例状态】进行过滤。（PENDING：创建中 | LAUNCH_FAILURE：创建失败 | RUNNING：运行中 | EXPIRED：已过期）

    类型：String

    必选：否

  • host-type

    • 按照【CDH机型】进行过滤。

    类型：String

    必选：否

  • tag-key

    • 按照【标签键】进行过滤。

    类型：String

    必选：否

  • tag-value

    • 按照【标签值】进行过滤。

    类型：String

    必选：否

  • tag:tag-key

    • 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例。

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。.

    Instance Method Summary collapse

    Constructor Details

    #initialize(filters = nil, offset = nil, limit = nil) ⇒ DescribeHostsRequest

    Returns a new instance of DescribeHostsRequest.

    

2124
2125
2126
2127
2128
    		 
    # File 'lib/v20170312/models.rb', line 2124

def initialize(filters=nil, offset=nil, limit=nil)
  @Filters = filters
  @Offset = offset
  @Limit = limit
end

    Instance Attribute Details

    #Filters ⇒ Object

    按照【可用区】进行过滤。可用区形如：ap-guangzhou-6。

    类型：String

    必选：否

    可选项：可用区列表

  • project-id

    • 按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID形如：1002189。

    类型：Integer

    必选：否

  • host-id

    • 按照【[CDH](https://cloud.tencent.com/document/product/416) ID】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID形如：host-xxxxxxxx。

    类型：String

    必选：否

  • host-name

    • 按照【CDH实例名称】进行过滤。

    类型：String

    必选：否

  • host-state

    • 按照【CDH实例状态】进行过滤。（PENDING：创建中 | LAUNCH_FAILURE：创建失败 | RUNNING：运行中 | EXPIRED：已过期）

    类型：String

    必选：否

  • host-type

    • 按照【CDH机型】进行过滤。

    类型：String

    必选：否

  • tag-key

    • 按照【标签键】进行过滤。

    类型：String

    必选：否

  • tag-value

    • 按照【标签值】进行过滤。

    类型：String

    必选：否

  • tag:tag-key

    • 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例。

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。

    Parameters:

    • Filters: (li) —

      zone

  • Offset: —

    偏移量，默认为0。

  • Limit: —

    返回数量，默认为20，最大值为100。

    • 

2122
2123
2124
    		 
    # File 'lib/v20170312/models.rb', line 2122

def Filters
  @Filters
end

    #Limit ⇒ Object

    按照【可用区】进行过滤。可用区形如：ap-guangzhou-6。

    类型：String

    必选：否

    可选项：可用区列表

  • project-id

    • 按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID形如：1002189。

    类型：Integer

    必选：否

  • host-id

    • 按照【[CDH](https://cloud.tencent.com/document/product/416) ID】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID形如：host-xxxxxxxx。

    类型：String

    必选：否

  • host-name

    • 按照【CDH实例名称】进行过滤。

    类型：String

    必选：否

  • host-state

    • 按照【CDH实例状态】进行过滤。（PENDING：创建中 | LAUNCH_FAILURE：创建失败 | RUNNING：运行中 | EXPIRED：已过期）

    类型：String

    必选：否

  • host-type

    • 按照【CDH机型】进行过滤。

    类型：String

    必选：否

  • tag-key

    • 按照【标签键】进行过滤。

    类型：String

    必选：否

  • tag-value

    • 按照【标签值】进行过滤。

    类型：String

    必选：否

  • tag:tag-key

    • 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例。

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。

    Parameters:

  • Offset: —

    偏移量，默认为0。

  • Limit: —

    返回数量，默认为20，最大值为100。

    • 

2122
2123
2124
    		 
    # File 'lib/v20170312/models.rb', line 2122

def Limit
  @Limit
end

    #Offset ⇒ Object

    按照【可用区】进行过滤。可用区形如：ap-guangzhou-6。

    类型：String

    必选：否

    可选项：可用区列表

  • project-id

    • 按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID形如：1002189。

    类型：Integer

    必选：否

  • host-id

    • 按照【[CDH](https://cloud.tencent.com/document/product/416) ID】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID形如：host-xxxxxxxx。

    类型：String

    必选：否

  • host-name

    • 按照【CDH实例名称】进行过滤。

    类型：String

    必选：否

  • host-state

    • 按照【CDH实例状态】进行过滤。（PENDING：创建中 | LAUNCH_FAILURE：创建失败 | RUNNING：运行中 | EXPIRED：已过期）

    类型：String

    必选：否

  • host-type

    • 按照【CDH机型】进行过滤。

    类型：String

    必选：否

  • tag-key

    • 按照【标签键】进行过滤。

    类型：String

    必选：否

  • tag-value

    • 按照【标签值】进行过滤。

    类型：String

    必选：否

  • tag:tag-key

    • 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例。

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。

    Parameters:

  • Offset: —

    偏移量，默认为0。

  • Limit: —

    返回数量，默认为20，最大值为100。

    • 

2122
2123
2124
    		 
    # File 'lib/v20170312/models.rb', line 2122

def Offset
  @Offset
end

    Instance Method Details

    #deserialize(params) ⇒ Object 

    

2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
    		 
    # File 'lib/v20170312/models.rb', line 2130

def deserialize(params)
  unless params['Filters'].nil?
    @Filters = []
    params['Filters'].each do |i|
      filter_tmp = Filter.new
      filter_tmp.deserialize(i)
      @Filters << filter_tmp
    end
  end
  @Offset = params['Offset']
  @Limit = params['Limit']
end