DescribeDBInstancesRequest (tencentcloud-sdk-java 3.0.55 API)

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

public class DescribeDBInstancesRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description

DescribeDBInstancesRequest()

Constructors
Constructor and Description
`DescribeDBInstancesRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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()` 获取是否包含安全组详细信息，可取值：0-不包含，1-包含
`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)` 设置是否包含安全组详细信息，可取值：0-不包含，1-包含
`void`	`setZoneIds(Integer[] ZoneIds)` 设置可用区的ID
`void`	`toMap(HashMap<String,String> map, String prefix)` 内部实现，用户禁止调用

Methods inherited from class com.tencentcloudapi.common.AbstractModel
fromJsonString, getBinaryParams, getMultipartRequestParams, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class DescribeDBInstancesRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribeDBInstancesRequest

Method Detail

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