Class: TencentCloud::Mongodb::V20180408::DescribeDBInstancesRequest

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

Overview

DescribeDBInstances请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instanceids = nil, instancetype = nil, clustertype = nil, status = nil, vpcid = nil, subnetid = nil, paymode = nil, limit = nil, offset = nil, orderby = nil, orderbytype = nil) ⇒ DescribeDBInstancesRequest

Returns a new instance of DescribeDBInstancesRequest.



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/v20180408/models.rb', line 356

def initialize(instanceids=nil, instancetype=nil, clustertype=nil, status=nil, vpcid=nil, subnetid=nil, paymode=nil, limit=nil, offset=nil, orderby=nil, orderbytype=nil)
  @InstanceIds = instanceids
  @InstanceType = instancetype
  @ClusterType = clustertype
  @Status = status
  @VpcId = vpcid
  @SubnetId = subnetid
  @PayMode = paymode
  @Limit = limit
  @Offset = offset
  @OrderBy = orderby
  @OrderByType = orderbytype
end

Instance Attribute Details

#ClusterType ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def ClusterType
  @ClusterType
end

#InstanceIds ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def InstanceIds
  @InstanceIds
end

#InstanceType ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def InstanceType
  @InstanceType
end

#Limit ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def Limit
  @Limit
end

#Offset ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def Offset
  @Offset
end

#OrderBy ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def OrderBy
  @OrderBy
end

#OrderByType ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def OrderByType
  @OrderByType
end

#PayMode ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def PayMode
  @PayMode
end

#Status ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def Status
  @Status
end

#SubnetId ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def SubnetId
  @SubnetId
end

#VpcId ⇒ Object

  • 0： 所有实例
  • 1： 正式实例
  • 2： 临时实例
  • 3： 只读实例
  • -1： 正式实例+只读+灾备实例
  • 0： 副本集实例
  • 1： 正式实例
  • -1： 所有实例
  • 0： 待初始化
  • 1： 流程执行中
  • 2： 有效实例
  • -2： 已过期实例
  • 0： 按量计费
  • 1：包年包月
  • -1： 按量计费+包年包月
  • ProjectId： 按照项目ID排序
  • InstanceName：按照实例名称排序
  • CreateTime： 根据创建时间排序
  • ASC： 顺序取值
  • DESC：倒序取值

Parameters:

  • InstanceIds: —

    实例ID列表，格式如：cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。

  • InstanceType: —

    实例类型，取值范围：

  • ClusterType: —

    集群类型，取值范围：

  • Status: —

    实例状态，取值范围：

  • VpcId: —

    私有网络的ID，基础网络则不传该参数。

  • SubnetId: —

    私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId。

  • PayMode: —

    付费类型，取值范围：

  • Limit: —

    单次请求返回的数量，最小值为1，最大值为100，默认值为20。

  • Offset: —

    偏移量，默认值为0。

  • OrderBy: —

    返回结果集排序的字段，目前支持：

  • OrderByType: —

    返回结果集排序方式，目前支持："ASC"或者"DESC"。



354
355
356
 
# File 'lib/v20180408/models.rb', line 354

def VpcId
  @VpcId
end

Instance Method Details

#deserialize(params) ⇒ Object 



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/v20180408/models.rb', line 370

def deserialize(params)
  @InstanceIds = params['InstanceIds']
  @InstanceType = params['InstanceType']
  @ClusterType = params['ClusterType']
  @Status = params['Status']
  @VpcId = params['VpcId']
  @SubnetId = params['SubnetId']
  @PayMode = params['PayMode']
  @Limit = params['Limit']
  @Offset = params['Offset']
  @OrderBy = params['OrderBy']
  @OrderByType = params['OrderByType']
end