Class: TencentCloud::Cvm::V20170312::DescribeInstancesRequest

Inherits:

TencentCloud::Common::AbstractModel

Object
TencentCloud::Common::AbstractModel
TencentCloud::Cvm::V20170312::DescribeInstancesRequest

show all

Defined in:: lib/v20170312/models.rb

Overview

DescribeInstances请求参数结构体

Instance Attribute Summary collapse

#Filters ⇒ Object

类型：String必选：否 <li>creation-end-time</li> 按照【实例创建截止时间】进行过滤。例如：2023-06-01 00:00:00。 类型：String必选：否 每次请求的‘Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。.
#InstanceIds ⇒ Object

类型：String必选：否 <li>creation-end-time</li> 按照【实例创建截止时间】进行过滤。例如：2023-06-01 00:00:00。 类型：String必选：否 每次请求的‘Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。.
#Limit ⇒ Object

类型：String必选：否 <li>creation-end-time</li> 按照【实例创建截止时间】进行过滤。例如：2023-06-01 00:00:00。 类型：String必选：否 每次请求的‘Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。.
#Offset ⇒ Object

类型：String必选：否 <li>creation-end-time</li> 按照【实例创建截止时间】进行过滤。例如：2023-06-01 00:00:00。 类型：String必选：否 每次请求的‘Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。.

Instance Method Summary collapse

#deserialize(params) ⇒ Object
#initialize(instanceids = nil, filters = nil, offset = nil, limit = nil) ⇒ DescribeInstancesRequest constructor

A new instance of DescribeInstancesRequest.

Constructor Details

#initialize(instanceids = nil, filters = nil, offset = nil, limit = nil) ⇒ `DescribeInstancesRequest`

Returns a new instance of DescribeInstancesRequest.

# File 'lib/v20170312/models.rb', line 2565

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

Instance Attribute Details

#Filters ⇒ `Object`

类型：String必选：否 <li>creation-end-time</li> 按照【实例创建截止时间】进行过滤。例如：2023-06-01 00:00:00。 类型：String必选：否 每次请求的‘Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。

Parameters:

InstanceIds: —

按照一个或者多个实例ID查询。实例ID例如：‘ins-xxxxxxxx`。（此参数的具体格式可参考API(cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
Filters: (li) —

zone</li> 按照【可用区】进行过滤。可用区例如：ap-guangzhou-1。类型：String必选：否可选项：<a href=“cloud.tencent.com/document/product/213/6091”>可用区列表</a> <li>project-id</li> 按照【项目ID】进行过滤，可通过调用(cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID例如：1002189。类型：Integer必选：否 <li>host-id</li> 按照【(cloud.tencent.com/document/product/416) ID】进行过滤。(cloud.tencent.com/document/product/416) ID例如：host-xxxxxxxx。类型：String必选：否 <li>dedicated-cluster-id</li> 按照【(cloud.tencent.com/document/product/1346) ID】进行过滤。(cloud.tencent.com/document/product/1346) ID例如：cluster-xxxxxxx。类型：String必选：否 <li>vpc-id</li> 按照【VPC ID】进行过滤。VPC ID例如：vpc-xxxxxxxx。类型：String必选：否 <li>subnet-id</li> 按照【子网ID】进行过滤。子网ID例如：subnet-xxxxxxxx。类型：String必选：否 <li>instance-id</li> 按照【实例ID】进行过滤。实例ID例如：ins-xxxxxxxx。类型：String必选：否 <li>uuid</li> 按照【实例UUID】进行过滤。实例UUID例如：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。类型：String必选：否 <li>security-group-id</li> 按照【安全组ID】进行过滤。安全组ID例如: sg-8jlk3f3r。类型：String必选：否 <li>instance-name</li> 按照【实例名称】进行过滤。类型：String必选：否 <li>instance-charge-type</li> 按照【实例计费模式】进行过滤。(PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费 | CDHPAID：表示(cloud.tencent.com/document/product/416)付费，即只对[CDH](cloud.tencent.com/document/product/416)计费，不对[CDH](cloud.tencent.com/document/product/416)上的实例计费。)类型：String必选：否 <li>instance-state</li> 按照【实例状态】进行过滤。状态类型详见(cloud.tencent.com/document/api/213/15753#InstanceStatus)类型：String必选：否 <li>private-ip-address</li> 按照【实例主网卡的内网IP】进行过滤。类型：String必选：否 <li>public-ip-address</li> 按照【实例主网卡的公网IP】进行过滤，包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。类型：String必选：否 <li>ipv6-address</li> 按照【实例的IPv6地址】进行过滤。类型：String必选：否 <li>tag-key</li> 按照【标签键】进行过滤。类型：String必选：否 <li>tag-value</li> 按照【标签值】进行过滤。类型：String必选：否 <li>tag:tag-key</li> 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。类型：String必选：否<li>creation-start-time</li> 按照【实例创建起始时间】进行过滤。例如：2023-06-01 00:00:00。
Offset: —

偏移量，默认为0。关于‘Offset`的更进一步介绍请参考 API [简介](cloud.tencent.com/document/api/213/15688)中的相关小节。
Limit: —

返回数量，默认为20，最大值为100。关于‘Limit`的更进一步介绍请参考 API [简介](cloud.tencent.com/document/api/213/15688)中的相关小节。



2563
2564
2565

# File 'lib/v20170312/models.rb', line 2563

def Filters
  @Filters
end

#InstanceIds ⇒ `Object`

Parameters:

InstanceIds: —

按照一个或者多个实例ID查询。实例ID例如：‘ins-xxxxxxxx`。（此参数的具体格式可参考API(cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
Filters: (li) —

zone</li> 按照【可用区】进行过滤。可用区例如：ap-guangzhou-1。类型：String必选：否可选项：<a href=“cloud.tencent.com/document/product/213/6091”>可用区列表</a> <li>project-id</li> 按照【项目ID】进行过滤，可通过调用(cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID例如：1002189。类型：Integer必选：否 <li>host-id</li> 按照【(cloud.tencent.com/document/product/416) ID】进行过滤。(cloud.tencent.com/document/product/416) ID例如：host-xxxxxxxx。类型：String必选：否 <li>dedicated-cluster-id</li> 按照【(cloud.tencent.com/document/product/1346) ID】进行过滤。(cloud.tencent.com/document/product/1346) ID例如：cluster-xxxxxxx。类型：String必选：否 <li>vpc-id</li> 按照【VPC ID】进行过滤。VPC ID例如：vpc-xxxxxxxx。类型：String必选：否 <li>subnet-id</li> 按照【子网ID】进行过滤。子网ID例如：subnet-xxxxxxxx。类型：String必选：否 <li>instance-id</li> 按照【实例ID】进行过滤。实例ID例如：ins-xxxxxxxx。类型：String必选：否 <li>uuid</li> 按照【实例UUID】进行过滤。实例UUID例如：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。类型：String必选：否 <li>security-group-id</li> 按照【安全组ID】进行过滤。安全组ID例如: sg-8jlk3f3r。类型：String必选：否 <li>instance-name</li> 按照【实例名称】进行过滤。类型：String必选：否 <li>instance-charge-type</li> 按照【实例计费模式】进行过滤。(PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费 | CDHPAID：表示(cloud.tencent.com/document/product/416)付费，即只对[CDH](cloud.tencent.com/document/product/416)计费，不对[CDH](cloud.tencent.com/document/product/416)上的实例计费。)类型：String必选：否 <li>instance-state</li> 按照【实例状态】进行过滤。状态类型详见(cloud.tencent.com/document/api/213/15753#InstanceStatus)类型：String必选：否 <li>private-ip-address</li> 按照【实例主网卡的内网IP】进行过滤。类型：String必选：否 <li>public-ip-address</li> 按照【实例主网卡的公网IP】进行过滤，包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。类型：String必选：否 <li>ipv6-address</li> 按照【实例的IPv6地址】进行过滤。类型：String必选：否 <li>tag-key</li> 按照【标签键】进行过滤。类型：String必选：否 <li>tag-value</li> 按照【标签值】进行过滤。类型：String必选：否 <li>tag:tag-key</li> 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。类型：String必选：否<li>creation-start-time</li> 按照【实例创建起始时间】进行过滤。例如：2023-06-01 00:00:00。
Offset: —

偏移量，默认为0。关于‘Offset`的更进一步介绍请参考 API [简介](cloud.tencent.com/document/api/213/15688)中的相关小节。
Limit: —

返回数量，默认为20，最大值为100。关于‘Limit`的更进一步介绍请参考 API [简介](cloud.tencent.com/document/api/213/15688)中的相关小节。



2563
2564
2565

# File 'lib/v20170312/models.rb', line 2563

def InstanceIds
  @InstanceIds
end

#Limit ⇒ `Object`

Parameters:

InstanceIds: —

按照一个或者多个实例ID查询。实例ID例如：‘ins-xxxxxxxx`。（此参数的具体格式可参考API(cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
Filters: (li) —

zone</li> 按照【可用区】进行过滤。可用区例如：ap-guangzhou-1。类型：String必选：否可选项：<a href=“cloud.tencent.com/document/product/213/6091”>可用区列表</a> <li>project-id</li> 按照【项目ID】进行过滤，可通过调用(cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID例如：1002189。类型：Integer必选：否 <li>host-id</li> 按照【(cloud.tencent.com/document/product/416) ID】进行过滤。(cloud.tencent.com/document/product/416) ID例如：host-xxxxxxxx。类型：String必选：否 <li>dedicated-cluster-id</li> 按照【(cloud.tencent.com/document/product/1346) ID】进行过滤。(cloud.tencent.com/document/product/1346) ID例如：cluster-xxxxxxx。类型：String必选：否 <li>vpc-id</li> 按照【VPC ID】进行过滤。VPC ID例如：vpc-xxxxxxxx。类型：String必选：否 <li>subnet-id</li> 按照【子网ID】进行过滤。子网ID例如：subnet-xxxxxxxx。类型：String必选：否 <li>instance-id</li> 按照【实例ID】进行过滤。实例ID例如：ins-xxxxxxxx。类型：String必选：否 <li>uuid</li> 按照【实例UUID】进行过滤。实例UUID例如：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。类型：String必选：否 <li>security-group-id</li> 按照【安全组ID】进行过滤。安全组ID例如: sg-8jlk3f3r。类型：String必选：否 <li>instance-name</li> 按照【实例名称】进行过滤。类型：String必选：否 <li>instance-charge-type</li> 按照【实例计费模式】进行过滤。(PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费 | CDHPAID：表示(cloud.tencent.com/document/product/416)付费，即只对[CDH](cloud.tencent.com/document/product/416)计费，不对[CDH](cloud.tencent.com/document/product/416)上的实例计费。)类型：String必选：否 <li>instance-state</li> 按照【实例状态】进行过滤。状态类型详见(cloud.tencent.com/document/api/213/15753#InstanceStatus)类型：String必选：否 <li>private-ip-address</li> 按照【实例主网卡的内网IP】进行过滤。类型：String必选：否 <li>public-ip-address</li> 按照【实例主网卡的公网IP】进行过滤，包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。类型：String必选：否 <li>ipv6-address</li> 按照【实例的IPv6地址】进行过滤。类型：String必选：否 <li>tag-key</li> 按照【标签键】进行过滤。类型：String必选：否 <li>tag-value</li> 按照【标签值】进行过滤。类型：String必选：否 <li>tag:tag-key</li> 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。类型：String必选：否<li>creation-start-time</li> 按照【实例创建起始时间】进行过滤。例如：2023-06-01 00:00:00。
Offset: —

偏移量，默认为0。关于‘Offset`的更进一步介绍请参考 API [简介](cloud.tencent.com/document/api/213/15688)中的相关小节。
Limit: —

返回数量，默认为20，最大值为100。关于‘Limit`的更进一步介绍请参考 API [简介](cloud.tencent.com/document/api/213/15688)中的相关小节。



2563
2564
2565

# File 'lib/v20170312/models.rb', line 2563

def Limit
  @Limit
end

#Offset ⇒ `Object`

Parameters:

InstanceIds: —

按照一个或者多个实例ID查询。实例ID例如：‘ins-xxxxxxxx`。（此参数的具体格式可参考API(cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。
Filters: (li) —

zone</li> 按照【可用区】进行过滤。可用区例如：ap-guangzhou-1。类型：String必选：否可选项：<a href=“cloud.tencent.com/document/product/213/6091”>可用区列表</a> <li>project-id</li> 按照【项目ID】进行过滤，可通过调用(cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID例如：1002189。类型：Integer必选：否 <li>host-id</li> 按照【(cloud.tencent.com/document/product/416) ID】进行过滤。(cloud.tencent.com/document/product/416) ID例如：host-xxxxxxxx。类型：String必选：否 <li>dedicated-cluster-id</li> 按照【(cloud.tencent.com/document/product/1346) ID】进行过滤。(cloud.tencent.com/document/product/1346) ID例如：cluster-xxxxxxx。类型：String必选：否 <li>vpc-id</li> 按照【VPC ID】进行过滤。VPC ID例如：vpc-xxxxxxxx。类型：String必选：否 <li>subnet-id</li> 按照【子网ID】进行过滤。子网ID例如：subnet-xxxxxxxx。类型：String必选：否 <li>instance-id</li> 按照【实例ID】进行过滤。实例ID例如：ins-xxxxxxxx。类型：String必选：否 <li>uuid</li> 按照【实例UUID】进行过滤。实例UUID例如：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。类型：String必选：否 <li>security-group-id</li> 按照【安全组ID】进行过滤。安全组ID例如: sg-8jlk3f3r。类型：String必选：否 <li>instance-name</li> 按照【实例名称】进行过滤。类型：String必选：否 <li>instance-charge-type</li> 按照【实例计费模式】进行过滤。(PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费 | CDHPAID：表示(cloud.tencent.com/document/product/416)付费，即只对[CDH](cloud.tencent.com/document/product/416)计费，不对[CDH](cloud.tencent.com/document/product/416)上的实例计费。)类型：String必选：否 <li>instance-state</li> 按照【实例状态】进行过滤。状态类型详见(cloud.tencent.com/document/api/213/15753#InstanceStatus)类型：String必选：否 <li>private-ip-address</li> 按照【实例主网卡的内网IP】进行过滤。类型：String必选：否 <li>public-ip-address</li> 按照【实例主网卡的公网IP】进行过滤，包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。类型：String必选：否 <li>ipv6-address</li> 按照【实例的IPv6地址】进行过滤。类型：String必选：否 <li>tag-key</li> 按照【标签键】进行过滤。类型：String必选：否 <li>tag-value</li> 按照【标签值】进行过滤。类型：String必选：否 <li>tag:tag-key</li> 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。类型：String必选：否<li>creation-start-time</li> 按照【实例创建起始时间】进行过滤。例如：2023-06-01 00:00:00。
Offset: —

偏移量，默认为0。关于‘Offset`的更进一步介绍请参考 API [简介](cloud.tencent.com/document/api/213/15688)中的相关小节。
Limit: —

返回数量，默认为20，最大值为100。关于‘Limit`的更进一步介绍请参考 API [简介](cloud.tencent.com/document/api/213/15688)中的相关小节。



2563
2564
2565

# File 'lib/v20170312/models.rb', line 2563

def Offset
  @Offset
end

Instance Method Details

#deserialize(params) ⇒ `Object`

# File 'lib/v20170312/models.rb', line 2572

def deserialize(params)
  @InstanceIds = params['InstanceIds']
  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

Class: TencentCloud::Cvm::V20170312::DescribeInstancesRequest

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instanceids = nil, filters = nil, offset = nil, limit = nil) ⇒ DescribeInstancesRequest

Instance Attribute Details

#Filters ⇒ Object

#InstanceIds ⇒ Object

#Limit ⇒ Object

#Offset ⇒ Object

Instance Method Details

#deserialize(params) ⇒ Object

#initialize(instanceids = nil, filters = nil, offset = nil, limit = nil) ⇒ `DescribeInstancesRequest`

#Filters ⇒ `Object`

#InstanceIds ⇒ `Object`

#Limit ⇒ `Object`

#Offset ⇒ `Object`

#deserialize(params) ⇒ `Object`