Class: TencentCloud::Mongodb::V20190725::DescribeDBInstancesRequest

Inherits:

Common::AbstractModel

Object
Common::AbstractModel
TencentCloud::Mongodb::V20190725::DescribeDBInstancesRequest

show all

Defined in:: lib/v20190725/models.rb

Overview

DescribeDBInstances请求参数结构体

Instance Attribute Summary collapse

#ClusterType ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#InstanceIds ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#InstanceType ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#Limit ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#Offset ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#OrderBy ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#OrderByType ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#PayMode ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#ProjectIds ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#SearchKey ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#Status ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#SubnetId ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#Tags ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.
#VpcId ⇒ Object
- 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。 - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。 - ASC：升序。 - DESC：降序。.

Instance Method Summary collapse

#deserialize(params) ⇒ Object
#initialize(instanceids = nil, instancetype = nil, clustertype = nil, status = nil, vpcid = nil, subnetid = nil, paymode = nil, limit = nil, offset = nil, orderby = nil, orderbytype = nil, projectids = nil, searchkey = nil, tags = nil) ⇒ DescribeDBInstancesRequest constructor
A new instance of DescribeDBInstancesRequest.

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, projectids = nil, searchkey = nil, tags = nil) ⇒ `DescribeDBInstancesRequest`

Returns a new instance of DescribeDBInstancesRequest.

# File 'lib/v20190725/models.rb', line 2500

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

Instance Attribute Details

#ClusterType ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def ClusterType
  @ClusterType
end

#InstanceIds ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def InstanceIds
  @InstanceIds
end

#InstanceType ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def InstanceType
  @InstanceType
end

#Limit ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def Limit
  @Limit
end

#Offset ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def Offset
  @Offset
end

#OrderBy ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def OrderBy
  @OrderBy
end

#OrderByType ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def OrderByType
  @OrderByType
end

#PayMode ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def PayMode
  @PayMode
end

#ProjectIds ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def ProjectIds
  @ProjectIds
end

#SearchKey ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def SearchKey
  @SearchKey
end

#Status ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def Status
  @Status
end

#SubnetId ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def SubnetId
  @SubnetId
end

#Tags ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def Tags
  @Tags
end

#VpcId ⇒ `Object`

0：所有实例。
1：正式实例。
2：临时实例
3：只读实例。
-1：查询同时包括正式实例、只读实例与灾备实例。
0：副本集实例。
1：分片实例。
-1：副本集与分片实例。
0：待初始化。
1：流程处理中，例如：变更规格、参数修改等。
2：实例正常运行中。
-2：已隔离（包年包月）。
-3：已隔离（按量计费）。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
基础网络则无需配置该参数。
请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
0：查询按量计费实例。
1：查询包年包月实例。
-1：查询按量计费与包年包月实例。
ASC：升序。
DESC：降序。

Parameters:

InstanceIds: —
实例 ID 列表。请登录 MongoDB 控制台在实例列表复制实例 ID。
InstanceType: —
指定查询的实例类型。取值范围如下：
ClusterType: —
指定所查询实例的集群类型，取值范围如下：
Status: —
指定所查询实例的当前状态，取值范围如下所示：
VpcId: —
私有网络的 ID。
SubnetId: —
私有网络的子网ID。
PayMode: —
指定所查询实例的付费类型。
Limit: —
单次请求返回的数量。默认值为20，取值范围为(1,100]。
Offset: —
偏移量，默认值为0。
OrderBy: —
配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
OrderByType: —
配置返回结果的排序方式。
ProjectIds: —
项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
SearchKey: —
指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
Tags: —
标签信息，包含标签键与标签值。



2498
2499
2500

# File 'lib/v20190725/models.rb', line 2498

def VpcId
  @VpcId
end

Instance Method Details

#deserialize(params) ⇒ `Object`

# File 'lib/v20190725/models.rb', line 2517

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']
  @ProjectIds = params['ProjectIds']
  @SearchKey = params['SearchKey']
  unless params['Tags'].nil?
    @Tags = []
    params['Tags'].each do |i|
      taginfo_tmp = TagInfo.new
      taginfo_tmp.deserialize(i)
      @Tags << taginfo_tmp
    end
  end
end

Class: TencentCloud::Mongodb::V20190725::DescribeDBInstancesRequest

Overview

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, projectids = nil, searchkey = nil, tags = nil) ⇒ DescribeDBInstancesRequest

Instance Attribute Details

#ClusterType ⇒ Object

#InstanceIds ⇒ Object

#InstanceType ⇒ Object

#Limit ⇒ Object

#Offset ⇒ Object

#OrderBy ⇒ Object

#OrderByType ⇒ Object

#PayMode ⇒ Object

#ProjectIds ⇒ Object

#SearchKey ⇒ Object

#Status ⇒ Object

#SubnetId ⇒ Object

#Tags ⇒ Object

#VpcId ⇒ Object

Instance Method Details

#deserialize(params) ⇒ Object

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

#ClusterType ⇒ `Object`

#InstanceIds ⇒ `Object`

#InstanceType ⇒ `Object`

#Limit ⇒ `Object`

#Offset ⇒ `Object`

#OrderBy ⇒ `Object`

#OrderByType ⇒ `Object`

#PayMode ⇒ `Object`

#ProjectIds ⇒ `Object`

#SearchKey ⇒ `Object`

#Status ⇒ `Object`

#SubnetId ⇒ `Object`

#Tags ⇒ `Object`

#VpcId ⇒ `Object`

#deserialize(params) ⇒ `Object`