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

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

Overview

DescribeInstances请求参数结构体

Instance Attribute Summary collapse

  • #InstanceIds ⇒ Object

    类型：String

    必选：否

  • creation-end-time

    • 按照【创建实例请求的截止时间】进行过滤。例如：2023-06-01 00:00:00。

    类型：String

    必选：否

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。.
  • #Limit ⇒ Object

    类型：String

    必选：否

  • creation-end-time

    • 按照【创建实例请求的截止时间】进行过滤。例如：2023-06-01 00:00:00。

    类型：String

    必选：否

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。.
  • #Offset ⇒ Object

    类型：String

    必选：否

  • creation-end-time

    • 按照【创建实例请求的截止时间】进行过滤。例如：2023-06-01 00:00:00。

    类型：String

    必选：否

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。.

    Instance Method Summary collapse

    Constructor Details

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

    Returns a new instance of DescribeInstancesRequest.

    

2898
2899
2900
2901
2902
2903
    		 
    # File 'lib/v20170312/models.rb', line 2898

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

    必选：否

  • creation-end-time

    • 按照【创建实例请求的截止时间】进行过滤。例如：2023-06-01 00:00:00。

    类型：String

    必选：否

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。

    Parameters:

    • InstanceIds: —

      按照一个或者多个实例ID查询。实例ID例如：ins-xxxxxxxx。（此参数的具体格式可参考API简介的ids.N一节）。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。

    • Filters: (li) —

      zone

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

      类型：String

      必选：否

      可选项：可用区列表

    • project-id

      • 按照【项目ID】进行过滤，可通过调用DescribeProjects查询已创建的项目列表或登录控制台进行查看；也可以调用AddProject创建新的项目。项目ID例如：1002189。

      类型：Integer

      必选：否

    • host-id

      • 按照【CDH ID】进行过滤。CDH ID例如：host-xxxxxxxx。

      类型：String

      必选：否

    • dedicated-cluster-id

      • 按照【CDC ID】进行过滤。CDC ID例如：cluster-xxxxxxx。

      类型：String

      必选：否

    • vpc-id

      • 按照【VPC ID】进行过滤。VPC ID例如：vpc-xxxxxxxx。

      类型：String

      必选：否

    • subnet-id

      • 按照【子网ID】进行过滤。子网ID例如：subnet-xxxxxxxx。

      类型：String

      必选：否

    • instance-id

      • 按照【实例ID】进行过滤。实例ID例如：ins-xxxxxxxx。

      类型：String

      必选：否

    • uuid

      • 按照【实例UUID】进行过滤。实例UUID例如：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。

      类型：String

      必选：否

    • security-group-id

      • 按照【安全组ID】进行过滤。安全组ID例如: sg-8jlk3f3r。

      类型：String

      必选：否

    • instance-name

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

      类型：String

      必选：否

    • instance-charge-type

      • 按照【实例计费模式】进行过滤。(PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费 | CDHPAID：表示CDH付费，即只对CDH计费，不对CDH上的实例计费。)

      类型：String

      必选：否

    • instance-state

      • 按照【实例状态】进行过滤。状态类型详见实例状态表

      类型：String

      必选：否

    • private-ip-address

      • 按照【实例主网卡的内网IP】进行过滤。

      类型：String

      必选：否

    • public-ip-address

      • 按照【实例主网卡的公网IP】进行过滤，包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。

      类型：String

      必选：否

    • ipv6-address

      • 按照【实例的IPv6地址】进行过滤。

      类型：String

      必选：否

    • tag-key

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

      类型：String

      必选：否

    • tag-value

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

      类型：String

      必选：否

    • tag:tag-key

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

      类型：String

      必选：否

    • creation-start-time

      • 按照【创建实例请求的起始时间】进行过滤。例如：2023-06-01 00:00:00。

  • Offset: —

    偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。

  • Limit: —

    返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

    • 

2896
2897
2898
    		 
    # File 'lib/v20170312/models.rb', line 2896

def Filters
  @Filters
end

    #InstanceIds ⇒ Object

    类型：String

    必选：否

  • creation-end-time

    • 按照【创建实例请求的截止时间】进行过滤。例如：2023-06-01 00:00:00。

    类型：String

    必选：否

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。

    Parameters:

  • Offset: —

    偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。

  • Limit: —

    返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

    • 

2896
2897
2898
    		 
    # File 'lib/v20170312/models.rb', line 2896

def InstanceIds
  @InstanceIds
end

    #Limit ⇒ Object

    类型：String

    必选：否

  • creation-end-time

    • 按照【创建实例请求的截止时间】进行过滤。例如：2023-06-01 00:00:00。

    类型：String

    必选：否

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。

    Parameters:

  • Offset: —

    偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。

  • Limit: —

    返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

    • 

2896
2897
2898
    		 
    # File 'lib/v20170312/models.rb', line 2896

def Limit
  @Limit
end

    #Offset ⇒ Object

    类型：String

    必选：否

  • creation-end-time

    • 按照【创建实例请求的截止时间】进行过滤。例如：2023-06-01 00:00:00。

    类型：String

    必选：否

    每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。

    Parameters:

  • Offset: —

    偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。

  • Limit: —

    返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

    • 

2896
2897
2898
    		 
    # File 'lib/v20170312/models.rb', line 2896

def Offset
  @Offset
end

    Instance Method Details

    #deserialize(params) ⇒ Object 

    

2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
    		 
    # File 'lib/v20170312/models.rb', line 2905

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