DescribeDBInstancesRequest (tencentcloud-sdk-java 3.0.112 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.cdb.v20170320.models.DescribeDBInstancesRequest

public class DescribeDBInstancesRequest
extends AbstractModel

构造器概要

构造器
构造器和说明

DescribeDBInstancesRequest()

构造器
构造器和说明
`DescribeDBInstancesRequest()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Integer[]`	`getCdbErrors()` 获取是否锁定标记。
`String[]`	`getEngineVersions()` 获取实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
`String`	`getExClusterId()` 获取独享集群 ID。
`Integer`	`getInitFlag()` 获取初始化标记，可取值：0 - 未初始化，1 - 初始化。
`String[]`	`getInstanceIds()` 获取实例 ID。
`String[]`	`getInstanceNames()` 获取实例名称。
`Integer[]`	`getInstanceTypes()` 获取实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
`Integer`	`getLimit()` 获取单次请求返回的数量，默认值为 20，最大值为 2000。
`Integer`	`getOffset()` 获取偏移量，默认值为 0。
`String`	`getOrderBy()` 获取返回结果集排序的字段，目前支持："InstanceId"，"InstanceName"，"CreateTime"，"DeadlineTime"。
`String`	`getOrderDirection()` 获取返回结果集排序方式，目前支持："ASC" 或者 "DESC"。
`Integer[]`	`getPayTypes()` 获取付费类型，可取值：0 - 包年包月，1 - 小时计费。
`Integer`	`getProjectId()` 获取项目 ID，可使用 [查询项目列表](https://cloud.tencent.com/document/product/378/4400) 接口查询项目 ID。
`String`	`getSecurityGroupId()` 获取安全组 ID。
`Integer[]`	`getStatus()` 获取实例状态，可取值： 0 - 创建中 1 - 运行中 4 - 正在进行隔离操作 5 - 隔离中（可在回收站恢复开机）
`Integer[]`	`getSubnetIds()` 获取子网 ID。
`Integer[]`	`getTaskStatus()` 获取实例任务状态，可能取值： 0 - 没有任务 1 - 升级中 2 - 数据导入中 3 - 开放Slave中 4 - 外网访问开通中 5 - 批量操作执行中 6 - 回档中 7 - 外网访问关闭中 8 - 密码修改中 9 - 实例名修改中 10 - 重启中 12 - 自建迁移中 13 - 删除库表中 14 - 灾备实例创建同步中 15 - 升级待切换 16 - 升级切换中 17 - 升级切换完成
`String[]`	`getVips()` 获取实例的内网 IP 地址。
`Integer[]`	`getVpcIds()` 获取私有网络的 ID。
`Integer`	`getWithDr()` 获取是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。
`Integer`	`getWithExCluster()` 获取是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
`Integer`	`getWithMaster()` 获取是否包含主实例，可取值：0 - 不包含，1 - 包含。
`Integer`	`getWithRo()` 获取是否包含只读实例，可取值：0 - 不包含，1 - 包含。
`Integer`	`getWithSecurityGroup()` 获取是否以安全组 ID 为过滤条件。
`Integer[]`	`getZoneIds()` 获取可用区的 ID。
`void`	`setCdbErrors(Integer[] CdbErrors)` 设置是否锁定标记。
`void`	`setEngineVersions(String[] EngineVersions)` 设置实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
`void`	`setExClusterId(String ExClusterId)` 设置独享集群 ID。
`void`	`setInitFlag(Integer InitFlag)` 设置初始化标记，可取值：0 - 未初始化，1 - 初始化。
`void`	`setInstanceIds(String[] InstanceIds)` 设置实例 ID。
`void`	`setInstanceNames(String[] InstanceNames)` 设置实例名称。
`void`	`setInstanceTypes(Integer[] InstanceTypes)` 设置实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
`void`	`setLimit(Integer Limit)` 设置单次请求返回的数量，默认值为 20，最大值为 2000。
`void`	`setOffset(Integer Offset)` 设置偏移量，默认值为 0。
`void`	`setOrderBy(String OrderBy)` 设置返回结果集排序的字段，目前支持："InstanceId"，"InstanceName"，"CreateTime"，"DeadlineTime"。
`void`	`setOrderDirection(String OrderDirection)` 设置返回结果集排序方式，目前支持："ASC" 或者 "DESC"。
`void`	`setPayTypes(Integer[] PayTypes)` 设置付费类型，可取值：0 - 包年包月，1 - 小时计费。
`void`	`setProjectId(Integer ProjectId)` 设置项目 ID，可使用 [查询项目列表](https://cloud.tencent.com/document/product/378/4400) 接口查询项目 ID。
`void`	`setSecurityGroupId(String SecurityGroupId)` 设置安全组 ID。
`void`	`setStatus(Integer[] Status)` 设置实例状态，可取值： 0 - 创建中 1 - 运行中 4 - 正在进行隔离操作 5 - 隔离中（可在回收站恢复开机）
`void`	`setSubnetIds(Integer[] SubnetIds)` 设置子网 ID。
`void`	`setTaskStatus(Integer[] TaskStatus)` 设置实例任务状态，可能取值： 0 - 没有任务 1 - 升级中 2 - 数据导入中 3 - 开放Slave中 4 - 外网访问开通中 5 - 批量操作执行中 6 - 回档中 7 - 外网访问关闭中 8 - 密码修改中 9 - 实例名修改中 10 - 重启中 12 - 自建迁移中 13 - 删除库表中 14 - 灾备实例创建同步中 15 - 升级待切换 16 - 升级切换中 17 - 升级切换完成
`void`	`setVips(String[] Vips)` 设置实例的内网 IP 地址。
`void`	`setVpcIds(Integer[] VpcIds)` 设置私有网络的 ID。
`void`	`setWithDr(Integer WithDr)` 设置是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。
`void`	`setWithExCluster(Integer WithExCluster)` 设置是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
`void`	`setWithMaster(Integer WithMaster)` 设置是否包含主实例，可取值：0 - 不包含，1 - 包含。
`void`	`setWithRo(Integer WithRo)` 设置是否包含只读实例，可取值：0 - 不包含，1 - 包含。
`void`	`setWithSecurityGroup(Integer WithSecurityGroup)` 设置是否以安全组 ID 为过滤条件。
`void`	`setZoneIds(Integer[] ZoneIds)` 设置可用区的 ID。
`void`	`toMap(HashMap<String,String> map, String prefix)` 内部实现，用户禁止调用

从类继承的方法 com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - DescribeDBInstancesRequest
```
public DescribeDBInstancesRequest()
```
- 方法详细资料
  - getProjectId
```
public Integer getProjectId()
```
    获取项目 ID，可使用 [查询项目列表](https://cloud.tencent.com/document/product/378/4400) 接口查询项目 ID。
    
    返回:
    
    ProjectId 项目 ID，可使用 [查询项目列表](https://cloud.tencent.com/document/product/378/4400) 接口查询项目 ID。
  - setProjectId
```
public void setProjectId(Integer ProjectId)
```
    设置项目 ID，可使用 [查询项目列表](https://cloud.tencent.com/document/product/378/4400) 接口查询项目 ID。
    
    参数:
    
    ProjectId - 项目 ID，可使用 [查询项目列表](https://cloud.tencent.com/document/product/378/4400) 接口查询项目 ID。
  - getInstanceTypes
```
public Integer[] getInstanceTypes()
```
    获取实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
    
    返回:
    
    InstanceTypes 实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
  - setInstanceTypes
```
public void setInstanceTypes(Integer[] InstanceTypes)
```
    设置实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
    
    参数:
    
    InstanceTypes - 实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
  - getVips
```
public String[] getVips()
```
    获取实例的内网 IP 地址。
    
    返回:
    
    Vips 实例的内网 IP 地址。
  - setVips
```
public void setVips(String[] Vips)
```
    设置实例的内网 IP 地址。
    
    参数:
    
    Vips - 实例的内网 IP 地址。
  - getStatus
```
public Integer[] getStatus()
```
    获取实例状态，可取值：
    0 - 创建中
    1 - 运行中
    4 - 正在进行隔离操作
    5 - 隔离中（可在回收站恢复开机）
    
    返回:
    
    Status 实例状态，可取值：
    0 - 创建中
    1 - 运行中
    4 - 正在进行隔离操作
    5 - 隔离中（可在回收站恢复开机）
  - setStatus
```
public void setStatus(Integer[] Status)
```
    设置实例状态，可取值：
    0 - 创建中
    1 - 运行中
    4 - 正在进行隔离操作
    5 - 隔离中（可在回收站恢复开机）
    
    参数:
    
    Status - 实例状态，可取值：
    0 - 创建中
    1 - 运行中
    4 - 正在进行隔离操作
    5 - 隔离中（可在回收站恢复开机）
  - getOffset
```
public Integer getOffset()
```
    获取偏移量，默认值为 0。
    
    返回:
    
    Offset 偏移量，默认值为 0。
  - setOffset
```
public void setOffset(Integer Offset)
```
    设置偏移量，默认值为 0。
    
    参数:
    
    Offset - 偏移量，默认值为 0。
  - getLimit
```
public Integer getLimit()
```
    获取单次请求返回的数量，默认值为 20，最大值为 2000。
    
    返回:
    
    Limit 单次请求返回的数量，默认值为 20，最大值为 2000。
  - setLimit
```
public void setLimit(Integer Limit)
```
    设置单次请求返回的数量，默认值为 20，最大值为 2000。
    
    参数:
    
    Limit - 单次请求返回的数量，默认值为 20，最大值为 2000。
  - getSecurityGroupId
```
public String getSecurityGroupId()
```
    获取安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
    
    返回:
    
    SecurityGroupId 安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
  - setSecurityGroupId
```
public void setSecurityGroupId(String SecurityGroupId)
```
    设置安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
    
    参数:
    
    SecurityGroupId - 安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
  - getPayTypes
```
public Integer[] getPayTypes()
```
    获取付费类型，可取值：0 - 包年包月，1 - 小时计费。
    
    返回:
    
    PayTypes 付费类型，可取值：0 - 包年包月，1 - 小时计费。
  - setPayTypes
```
public void setPayTypes(Integer[] PayTypes)
```
    设置付费类型，可取值：0 - 包年包月，1 - 小时计费。
    
    参数:
    
    PayTypes - 付费类型，可取值：0 - 包年包月，1 - 小时计费。
  - getInstanceNames
```
public String[] getInstanceNames()
```
    获取实例名称。
    
    返回:
    
    InstanceNames 实例名称。
  - setInstanceNames
```
public void setInstanceNames(String[] InstanceNames)
```
    设置实例名称。
    
    参数:
    
    InstanceNames - 实例名称。
  - getTaskStatus
```
public Integer[] getTaskStatus()
```
    获取实例任务状态，可能取值：
    0 - 没有任务
    1 - 升级中
    2 - 数据导入中
    3 - 开放Slave中
    4 - 外网访问开通中
    5 - 批量操作执行中
    6 - 回档中
    7 - 外网访问关闭中
    8 - 密码修改中
    9 - 实例名修改中
    10 - 重启中
    12 - 自建迁移中
    13 - 删除库表中
    14 - 灾备实例创建同步中
    15 - 升级待切换
    16 - 升级切换中
    17 - 升级切换完成
    
    返回:
    
    TaskStatus 实例任务状态，可能取值：
    0 - 没有任务
    1 - 升级中
    2 - 数据导入中
    3 - 开放Slave中
    4 - 外网访问开通中
    5 - 批量操作执行中
    6 - 回档中
    7 - 外网访问关闭中
    8 - 密码修改中
    9 - 实例名修改中
    10 - 重启中
    12 - 自建迁移中
    13 - 删除库表中
    14 - 灾备实例创建同步中
    15 - 升级待切换
    16 - 升级切换中
    17 - 升级切换完成
  - setTaskStatus
```
public void setTaskStatus(Integer[] TaskStatus)
```
    设置实例任务状态，可能取值：
    0 - 没有任务
    1 - 升级中
    2 - 数据导入中
    3 - 开放Slave中
    4 - 外网访问开通中
    5 - 批量操作执行中
    6 - 回档中
    7 - 外网访问关闭中
    8 - 密码修改中
    9 - 实例名修改中
    10 - 重启中
    12 - 自建迁移中
    13 - 删除库表中
    14 - 灾备实例创建同步中
    15 - 升级待切换
    16 - 升级切换中
    17 - 升级切换完成
    
    参数:
    
    TaskStatus - 实例任务状态，可能取值：
    0 - 没有任务
    1 - 升级中
    2 - 数据导入中
    3 - 开放Slave中
    4 - 外网访问开通中
    5 - 批量操作执行中
    6 - 回档中
    7 - 外网访问关闭中
    8 - 密码修改中
    9 - 实例名修改中
    10 - 重启中
    12 - 自建迁移中
    13 - 删除库表中
    14 - 灾备实例创建同步中
    15 - 升级待切换
    16 - 升级切换中
    17 - 升级切换完成
  - getEngineVersions
```
public String[] getEngineVersions()
```
    获取实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
    
    返回:
    
    EngineVersions 实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
  - setEngineVersions
```
public void setEngineVersions(String[] EngineVersions)
```
    设置实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
    
    参数:
    
    EngineVersions - 实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
  - getVpcIds
```
public Integer[] getVpcIds()
```
    获取私有网络的 ID。
    
    返回:
    
    VpcIds 私有网络的 ID。
  - setVpcIds
```
public void setVpcIds(Integer[] VpcIds)
```
    设置私有网络的 ID。
    
    参数:
    
    VpcIds - 私有网络的 ID。
  - getZoneIds
```
public Integer[] getZoneIds()
```
    获取可用区的 ID。
    
    返回:
    
    ZoneIds 可用区的 ID。
  - setZoneIds
```
public void setZoneIds(Integer[] ZoneIds)
```
    设置可用区的 ID。
    
    参数:
    
    ZoneIds - 可用区的 ID。
  - getSubnetIds
```
public Integer[] getSubnetIds()
```
    获取子网 ID。
    
    返回:
    
    SubnetIds 子网 ID。
  - setSubnetIds
```
public void setSubnetIds(Integer[] SubnetIds)
```
    设置子网 ID。
    
    参数:
    
    SubnetIds - 子网 ID。
  - getCdbErrors
```
public Integer[] getCdbErrors()
```
    获取是否锁定标记。
    
    返回:
    
    CdbErrors 是否锁定标记。
  - setCdbErrors
```
public void setCdbErrors(Integer[] CdbErrors)
```
    设置是否锁定标记。
    
    参数:
    
    CdbErrors - 是否锁定标记。
  - getOrderBy
```
public String getOrderBy()
```
    获取返回结果集排序的字段，目前支持："InstanceId"，"InstanceName"，"CreateTime"，"DeadlineTime"。
    
    返回:
    
    OrderBy 返回结果集排序的字段，目前支持："InstanceId"，"InstanceName"，"CreateTime"，"DeadlineTime"。
  - setOrderBy
```
public void setOrderBy(String OrderBy)
```
    设置返回结果集排序的字段，目前支持："InstanceId"，"InstanceName"，"CreateTime"，"DeadlineTime"。
    
    参数:
    
    OrderBy - 返回结果集排序的字段，目前支持："InstanceId"，"InstanceName"，"CreateTime"，"DeadlineTime"。
  - getOrderDirection
```
public String getOrderDirection()
```
    获取返回结果集排序方式，目前支持："ASC" 或者 "DESC"。
    
    返回:
    
    OrderDirection 返回结果集排序方式，目前支持："ASC" 或者 "DESC"。
  - setOrderDirection
```
public void setOrderDirection(String OrderDirection)
```
    设置返回结果集排序方式，目前支持："ASC" 或者 "DESC"。
    
    参数:
    
    OrderDirection - 返回结果集排序方式，目前支持："ASC" 或者 "DESC"。
  - getWithSecurityGroup
```
public Integer getWithSecurityGroup()
```
    获取是否以安全组 ID 为过滤条件。
    
    返回:
    
    WithSecurityGroup 是否以安全组 ID 为过滤条件。
  - setWithSecurityGroup
```
public void setWithSecurityGroup(Integer WithSecurityGroup)
```
    设置是否以安全组 ID 为过滤条件。
    
    参数:
    
    WithSecurityGroup - 是否以安全组 ID 为过滤条件。
  - getWithExCluster
```
public Integer getWithExCluster()
```
    获取是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
    
    返回:
    
    WithExCluster 是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
  - setWithExCluster
```
public void setWithExCluster(Integer WithExCluster)
```
    设置是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
    
    参数:
    
    WithExCluster - 是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
  - getExClusterId
```
public String getExClusterId()
```
    获取独享集群 ID。
    
    返回:
    
    ExClusterId 独享集群 ID。
  - setExClusterId
```
public void setExClusterId(String ExClusterId)
```
    设置独享集群 ID。
    
    参数:
    
    ExClusterId - 独享集群 ID。
  - getInstanceIds
```
public String[] getInstanceIds()
```
    获取实例 ID。
    
    返回:
    
    InstanceIds 实例 ID。
  - setInstanceIds
```
public void setInstanceIds(String[] InstanceIds)
```
    设置实例 ID。
    
    参数:
    
    InstanceIds - 实例 ID。
  - getInitFlag
```
public Integer getInitFlag()
```
    获取初始化标记，可取值：0 - 未初始化，1 - 初始化。
    
    返回:
    
    InitFlag 初始化标记，可取值：0 - 未初始化，1 - 初始化。
  - setInitFlag
```
public void setInitFlag(Integer InitFlag)
```
    设置初始化标记，可取值：0 - 未初始化，1 - 初始化。
    
    参数:
    
    InitFlag - 初始化标记，可取值：0 - 未初始化，1 - 初始化。
  - getWithDr
```
public Integer getWithDr()
```
    获取是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
    
    返回:
    
    WithDr 是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
  - setWithDr
```
public void setWithDr(Integer WithDr)
```
    设置是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
    
    参数:
    
    WithDr - 是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中，如果拉取灾备实例，则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
  - getWithRo
```
public Integer getWithRo()
```
    获取是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
    
    返回:
    
    WithRo 是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
  - setWithRo
```
public void setWithRo(Integer WithRo)
```
    设置是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
    
    参数:
    
    WithRo - 是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
  - getWithMaster
```
public Integer getWithMaster()
```
    获取是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
    
    返回:
    
    WithMaster 是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
  - setWithMaster
```
public void setWithMaster(Integer WithMaster)
```
    设置是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
    
    参数:
    
    WithMaster - 是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    内部实现，用户禁止调用
    
    指定者:
    
    toMap 在类中 AbstractModel

类 DescribeDBInstancesRequest

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractModel

从类继承的方法 java.lang.Object

构造器详细资料

DescribeDBInstancesRequest

方法详细资料

getProjectId

setProjectId

getInstanceTypes

setInstanceTypes

getVips

setVips

getStatus

setStatus

getOffset

setOffset

getLimit

setLimit

getSecurityGroupId

setSecurityGroupId

getPayTypes

setPayTypes

getInstanceNames

setInstanceNames

getTaskStatus

setTaskStatus

getEngineVersions

setEngineVersions

getVpcIds

setVpcIds

getZoneIds

setZoneIds

getSubnetIds

setSubnetIds

getCdbErrors

setCdbErrors

getOrderBy

setOrderBy

getOrderDirection

setOrderDirection

getWithSecurityGroup

setWithSecurityGroup

getWithExCluster

setWithExCluster

getExClusterId

setExClusterId

getInstanceIds

setInstanceIds

getInitFlag

setInitFlag

getWithDr

setWithDr

getWithRo

setWithRo

getWithMaster

setWithMaster

toMap