Class: TencentCloud::Cdb::V20170320::DescribeDBInstancesRequest

Inherits:

TencentCloud::Common::AbstractModel

Object
TencentCloud::Common::AbstractModel
TencentCloud::Cdb::V20170320::DescribeDBInstancesRequest

show all

Defined in:: lib/v20170320/models.rb

Overview

DescribeDBInstances请求参数结构体

Instance Attribute Summary collapse

#CageIds ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#CdbErrors ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#DeployGroupIds ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#EngineTypes ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#EngineVersions ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#ExClusterId ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#InitFlag ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#InstanceIds ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#InstanceNames ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#InstanceTypes ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#Limit ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#Offset ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#OrderBy ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#OrderDirection ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#PayTypes ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#ProjectId ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#ProxyIds ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#ProxyVips ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#QueryClusterInfo ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#SecurityGroupId ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#Status ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#SubnetIds ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#TagKeysForSearch ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#Tags ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#TagValues ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#TaskStatus ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#UniqSubnetIds ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#UniqueVpcIds ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#Vips ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#VpcIds ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#WithDr ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#WithExCluster ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#WithMaster ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#WithRo ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#WithSecurityGroup ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.
#ZoneIds ⇒ Object

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。.

Instance Method Summary collapse

Constructor Details

#initialize(projectid = nil, instancetypes = nil, vips = nil, status = nil, offset = nil, limit = nil, securitygroupid = nil, paytypes = nil, instancenames = nil, taskstatus = nil, engineversions = nil, vpcids = nil, zoneids = nil, subnetids = nil, cdberrors = nil, orderby = nil, orderdirection = nil, withsecuritygroup = nil, withexcluster = nil, exclusterid = nil, instanceids = nil, initflag = nil, withdr = nil, withro = nil, withmaster = nil, deploygroupids = nil, tagkeysforsearch = nil, cageids = nil, tagvalues = nil, uniquevpcids = nil, uniqsubnetids = nil, tags = nil, proxyvips = nil, proxyids = nil, enginetypes = nil, queryclusterinfo = nil) ⇒ `DescribeDBInstancesRequest`

Returns a new instance of DescribeDBInstancesRequest.

# File 'lib/v20170320/models.rb', line 6420

def initialize(projectid=nil, instancetypes=nil, vips=nil, status=nil, offset=nil, limit=nil, securitygroupid=nil, paytypes=nil, instancenames=nil, taskstatus=nil, engineversions=nil, vpcids=nil, zoneids=nil, subnetids=nil, cdberrors=nil, orderby=nil, orderdirection=nil, withsecuritygroup=nil, withexcluster=nil, exclusterid=nil, instanceids=nil, initflag=nil, withdr=nil, withro=nil, withmaster=nil, deploygroupids=nil, tagkeysforsearch=nil, cageids=nil, tagvalues=nil, uniquevpcids=nil, uniqsubnetids=nil, tags=nil, proxyvips=nil, proxyids=nil, enginetypes=nil, queryclusterinfo=nil)
  @ProjectId = projectid
  @InstanceTypes = instancetypes
  @Vips = vips
  @Status = status
  @Offset = offset
  @Limit = limit
  @SecurityGroupId = securitygroupid
  @PayTypes = paytypes
  @InstanceNames = instancenames
  @TaskStatus = taskstatus
  @EngineVersions = engineversions
  @VpcIds = vpcids
  @ZoneIds = zoneids
  @SubnetIds = subnetids
  @CdbErrors = cdberrors
  @OrderBy = orderby
  @OrderDirection = orderdirection
  @WithSecurityGroup = withsecuritygroup
  @WithExCluster = withexcluster
  @ExClusterId = exclusterid
  @InstanceIds = instanceids
  @InitFlag = initflag
  @WithDr = withdr
  @WithRo = withro
  @WithMaster = withmaster
  @DeployGroupIds = deploygroupids
  @TagKeysForSearch = tagkeysforsearch
  @CageIds = cageids
  @TagValues = tagvalues
  @UniqueVpcIds = uniquevpcids
  @UniqSubnetIds = uniqsubnetids
  @Tags = tags
  @ProxyVips = proxyvips
  @ProxyIds = proxyids
  @EngineTypes = enginetypes
  @QueryClusterInfo = queryclusterinfo
end

Instance Attribute Details

#CageIds ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def CageIds
  @CageIds
end

#CdbErrors ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def CdbErrors
  @CdbErrors
end

#DeployGroupIds ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def DeployGroupIds
  @DeployGroupIds
end

#EngineTypes ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def EngineTypes
  @EngineTypes
end

#EngineVersions ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def EngineVersions
  @EngineVersions
end

#ExClusterId ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def ExClusterId
  @ExClusterId
end

#InitFlag ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def InitFlag
  @InitFlag
end

#InstanceIds ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def InstanceIds
  @InstanceIds
end

#InstanceNames ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def InstanceNames
  @InstanceNames
end

#InstanceTypes ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def InstanceTypes
  @InstanceTypes
end

#Limit ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def Limit
  @Limit
end

#Offset ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def Offset
  @Offset
end

#OrderBy ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def OrderBy
  @OrderBy
end

#OrderDirection ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def OrderDirection
  @OrderDirection
end

#PayTypes ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def PayTypes
  @PayTypes
end

#ProjectId ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def ProjectId
  @ProjectId
end

#ProxyIds ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def ProxyIds
  @ProxyIds
end

#ProxyVips ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def ProxyVips
  @ProxyVips
end

#QueryClusterInfo ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def QueryClusterInfo
  @QueryClusterInfo
end

#SecurityGroupId ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def SecurityGroupId
  @SecurityGroupId
end

#Status ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def Status
  @Status
end

#SubnetIds ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def SubnetIds
  @SubnetIds
end

#TagKeysForSearch ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def TagKeysForSearch
  @TagKeysForSearch
end

#Tags ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def Tags
  @Tags
end

#TagValues ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def TagValues
  @TagValues
end

#TaskStatus ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def TaskStatus
  @TaskStatus
end

#UniqSubnetIds ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def UniqSubnetIds
  @UniqSubnetIds
end

#UniqueVpcIds ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def UniqueVpcIds
  @UniqueVpcIds
end

#Vips ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def Vips
  @Vips
end

#VpcIds ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def VpcIds
  @VpcIds
end

#WithDr ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def WithDr
  @WithDr
end

#WithExCluster ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def WithExCluster
  @WithExCluster
end

#WithMaster ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def WithMaster
  @WithMaster
end

#WithRo ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def WithRo
  @WithRo
end

#WithSecurityGroup ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def WithSecurityGroup
  @WithSecurityGroup
end

#ZoneIds ⇒ `Object`

说明：0表示否，1表示是。请注意，创建中的实例无法查询到标签。

Parameters:

ProjectId: —

项目 ID。
InstanceTypes: —

实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
Vips: —

实例的内网 IP 地址。
Status: —

实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 已隔离（可在回收站恢复开机）
Offset: —

偏移量，默认值为 0。
Limit: —

单次请求返回的数量，默认值为 20，最大值为 2000。
SecurityGroupId: —

安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
PayTypes: —

付费类型，可取值：0 - 包年包月，1 - 小时计费。
InstanceNames: —

实例名称。
TaskStatus: —

实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
19 - 参数设置待执行
34 - 原地升级待执行
EngineVersions: —

实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
VpcIds: —

私有网络的 ID。
ZoneIds: —

可用区的 ID。
SubnetIds: —

子网 ID。
CdbErrors: —

是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。
OrderBy: —

返回结果集排序的字段，目前支持：“InstanceId”，“InstanceName”，“CreateTime”，“DeadlineTime”。
OrderDirection: —

返回结果集排序方式。目前支持值：“ASC” - 表示升序，“DESC” - 表示降序，默认为 “DESC”。
WithSecurityGroup: —

是否以安全组 ID 为过滤条件。
WithExCluster: —

是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
ExClusterId: —

独享集群 ID。
InstanceIds: —

实例 ID。
InitFlag: —

初始化标记，可取值：0 - 未初始化，1 - 初始化。
WithDr: —

是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
WithRo: —

是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
WithMaster: —

是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
DeployGroupIds: —

置放群组ID列表。
TagKeysForSearch: —

是否以标签键为过滤条件。
CageIds: —

金融围拢 ID 。
TagValues: —

标签值
UniqueVpcIds: —

私有网络字符型vpcId
UniqSubnetIds: —

私有网络字符型subnetId
Tags: —

标签键值
ProxyVips: —

数据库代理 IP 。
ProxyIds: —

数据库代理 ID 。
EngineTypes: —

数据库引擎类型。可选值为：InnoDB、RocksDB。
QueryClusterInfo: —

是否获取集群版实例节点信息，可填：true 或 false。默认为 false。



6418
6419
6420

# File 'lib/v20170320/models.rb', line 6418

def ZoneIds
  @ZoneIds
end

Instance Method Details

#deserialize(params) ⇒ `Object`

# File 'lib/v20170320/models.rb', line 6459

def deserialize(params)
  @ProjectId = params['ProjectId']
  @InstanceTypes = params['InstanceTypes']
  @Vips = params['Vips']
  @Status = params['Status']
  @Offset = params['Offset']
  @Limit = params['Limit']
  @SecurityGroupId = params['SecurityGroupId']
  @PayTypes = params['PayTypes']
  @InstanceNames = params['InstanceNames']
  @TaskStatus = params['TaskStatus']
  @EngineVersions = params['EngineVersions']
  @VpcIds = params['VpcIds']
  @ZoneIds = params['ZoneIds']
  @SubnetIds = params['SubnetIds']
  @CdbErrors = params['CdbErrors']
  @OrderBy = params['OrderBy']
  @OrderDirection = params['OrderDirection']
  @WithSecurityGroup = params['WithSecurityGroup']
  @WithExCluster = params['WithExCluster']
  @ExClusterId = params['ExClusterId']
  @InstanceIds = params['InstanceIds']
  @InitFlag = params['InitFlag']
  @WithDr = params['WithDr']
  @WithRo = params['WithRo']
  @WithMaster = params['WithMaster']
  @DeployGroupIds = params['DeployGroupIds']
  @TagKeysForSearch = params['TagKeysForSearch']
  @CageIds = params['CageIds']
  @TagValues = params['TagValues']
  @UniqueVpcIds = params['UniqueVpcIds']
  @UniqSubnetIds = params['UniqSubnetIds']
  unless params['Tags'].nil?
    @Tags = []
    params['Tags'].each do |i|
      tag_tmp = Tag.new
      tag_tmp.deserialize(i)
      @Tags << tag_tmp
    end
  end
  @ProxyVips = params['ProxyVips']
  @ProxyIds = params['ProxyIds']
  @EngineTypes = params['EngineTypes']
  @QueryClusterInfo = params['QueryClusterInfo']
end

Class: TencentCloud::Cdb::V20170320::DescribeDBInstancesRequest

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

Instance Attribute Details

#CageIds ⇒ Object

#CdbErrors ⇒ Object

#DeployGroupIds ⇒ Object

#EngineTypes ⇒ Object

#EngineVersions ⇒ Object

#ExClusterId ⇒ Object

#InitFlag ⇒ Object

#InstanceIds ⇒ Object

#InstanceNames ⇒ Object

#InstanceTypes ⇒ Object

#Limit ⇒ Object

#Offset ⇒ Object

#OrderBy ⇒ Object

#OrderDirection ⇒ Object

#PayTypes ⇒ Object

#ProjectId ⇒ Object

#ProxyIds ⇒ Object

#ProxyVips ⇒ Object

#QueryClusterInfo ⇒ Object

#SecurityGroupId ⇒ Object

#Status ⇒ Object

#SubnetIds ⇒ Object

#TagKeysForSearch ⇒ Object

#Tags ⇒ Object

#TagValues ⇒ Object

#TaskStatus ⇒ Object

#UniqSubnetIds ⇒ Object

#UniqueVpcIds ⇒ Object

#Vips ⇒ Object

#VpcIds ⇒ Object

#WithDr ⇒ Object

#WithExCluster ⇒ Object

#WithMaster ⇒ Object

#WithRo ⇒ Object

#WithSecurityGroup ⇒ Object

#ZoneIds ⇒ Object

Instance Method Details

#deserialize(params) ⇒ Object

#CageIds ⇒ `Object`

#CdbErrors ⇒ `Object`

#DeployGroupIds ⇒ `Object`

#EngineTypes ⇒ `Object`

#EngineVersions ⇒ `Object`

#ExClusterId ⇒ `Object`

#InitFlag ⇒ `Object`

#InstanceIds ⇒ `Object`

#InstanceNames ⇒ `Object`

#InstanceTypes ⇒ `Object`

#Limit ⇒ `Object`

#Offset ⇒ `Object`

#OrderBy ⇒ `Object`

#OrderDirection ⇒ `Object`

#PayTypes ⇒ `Object`

#ProjectId ⇒ `Object`

#ProxyIds ⇒ `Object`

#ProxyVips ⇒ `Object`

#QueryClusterInfo ⇒ `Object`

#SecurityGroupId ⇒ `Object`

#Status ⇒ `Object`

#SubnetIds ⇒ `Object`

#TagKeysForSearch ⇒ `Object`

#Tags ⇒ `Object`

#TagValues ⇒ `Object`

#TaskStatus ⇒ `Object`

#UniqSubnetIds ⇒ `Object`

#UniqueVpcIds ⇒ `Object`

#Vips ⇒ `Object`

#VpcIds ⇒ `Object`

#WithDr ⇒ `Object`

#WithExCluster ⇒ `Object`

#WithMaster ⇒ `Object`

#WithRo ⇒ `Object`

#WithSecurityGroup ⇒ `Object`

#ZoneIds ⇒ `Object`

#deserialize(params) ⇒ `Object`