DescribeDBInstancesRequest (tencentcloud-sdk-java 3.1.1151 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.mongodb.v20190725.models.DescribeDBInstancesRequest

public class DescribeDBInstancesRequest
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`DescribeDBInstancesRequest()`
`DescribeDBInstancesRequest(DescribeDBInstancesRequest source)` NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getClusterType()` Get 指定所查询实例的集群类型，取值范围如下：0：副本集实例。1：分片实例。-1：副本集与分片实例。
`String[]`	`getInstanceIds()` Get 实例 ID 列表。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
`Long`	`getInstanceType()` Get 指定查询的实例类型。取值范围如下：0：所有实例。1：正式实例。3：只读实例。4：灾备实例。
`Long`	`getLimit()` Get 单次请求返回的数量。默认值为20，取值范围为[1,100]。
`Long`	`getOffset()` Get 偏移量，默认值为0。
`String`	`getOrderBy()` Get 配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
`String`	`getOrderByType()` Get 配置返回结果的排序方式。 - ASC：升序。 - DESC：降序。
`Long`	`getPayMode()` Get 指定所查询实例的付费类型，取值范围如下：0：查询按量计费实例。1：查询包年包月实例。-1：查询按量计费与包年包月实例。
`Long[]`	`getProjectIds()` Get 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
`String`	`getSearchKey()` Get 指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
`Long[]`	`getStatus()` Get 指定所查询实例的当前状态，取值范围如下所示：0：待初始化。1：流程处理中，例如：变更规格、参数修改等。2：实例正常运行中。-2：实例已过期。
`String`	`getSubnetId()` Get 私有网络的子网ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
`TagInfo[]`	`getTags()` Get 标签信息，包含标签键与标签值。
`String`	`getVpcId()` Get 私有网络的 ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
`void`	`setClusterType(Long ClusterType)` Set 指定所查询实例的集群类型，取值范围如下：0：副本集实例。1：分片实例。-1：副本集与分片实例。
`void`	`setInstanceIds(String[] InstanceIds)` Set 实例 ID 列表。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
`void`	`setInstanceType(Long InstanceType)` Set 指定查询的实例类型。取值范围如下：0：所有实例。1：正式实例。3：只读实例。4：灾备实例。
`void`	`setLimit(Long Limit)` Set 单次请求返回的数量。默认值为20，取值范围为[1,100]。
`void`	`setOffset(Long Offset)` Set 偏移量，默认值为0。
`void`	`setOrderBy(String OrderBy)` Set 配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
`void`	`setOrderByType(String OrderByType)` Set 配置返回结果的排序方式。 - ASC：升序。 - DESC：降序。
`void`	`setPayMode(Long PayMode)` Set 指定所查询实例的付费类型，取值范围如下：0：查询按量计费实例。1：查询包年包月实例。-1：查询按量计费与包年包月实例。
`void`	`setProjectIds(Long[] ProjectIds)` Set 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
`void`	`setSearchKey(String SearchKey)` Set 指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
`void`	`setStatus(Long[] Status)` Set 指定所查询实例的当前状态，取值范围如下所示：0：待初始化。1：流程处理中，例如：变更规格、参数修改等。2：实例正常运行中。-2：实例已过期。
`void`	`setSubnetId(String SubnetId)` Set 私有网络的子网ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。
`void`	`setTags(TagInfo[] Tags)` Set 标签信息，包含标签键与标签值。
`void`	`setVpcId(String VpcId)` Set 私有网络的 ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。
`void`	`toMap(HashMap<String,String> map, String prefix)` Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

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

- Constructor Detail
  - DescribeDBInstancesRequest
```
public DescribeDBInstancesRequest()
```
  - DescribeDBInstancesRequest
```
public DescribeDBInstancesRequest(DescribeDBInstancesRequest source)
```
    NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
- Method Detail
  - getInstanceIds
```
public String[] getInstanceIds()
```
    Get 实例 ID 列表。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
    
    Returns:
    
    InstanceIds 实例 ID 列表。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
  - setInstanceIds
```
public void setInstanceIds(String[] InstanceIds)
```
    Set 实例 ID 列表。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
    
    Parameters:
    
    InstanceIds - 实例 ID 列表。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
  - getInstanceType
```
public Long getInstanceType()
```
    Get 指定查询的实例类型。取值范围如下：
    - 0：所有实例。
    - 1：正式实例。
    - 3：只读实例。
    - 4：灾备实例。
    Returns:
    InstanceType 指定查询的实例类型。取值范围如下：
    0：所有实例。
    1：正式实例。
    3：只读实例。
    4：灾备实例。
  - setInstanceType
```
public void setInstanceType(Long InstanceType)
```
    Set 指定查询的实例类型。取值范围如下：
    - 0：所有实例。
    - 1：正式实例。
    - 3：只读实例。
    - 4：灾备实例。
    Parameters:
    InstanceType - 指定查询的实例类型。取值范围如下：
    0：所有实例。
    1：正式实例。
    3：只读实例。
    4：灾备实例。
  - getClusterType
```
public Long getClusterType()
```
    Get 指定所查询实例的集群类型，取值范围如下：
    - 0：副本集实例。
    - 1：分片实例。
    - -1：副本集与分片实例。
    Returns:
    ClusterType 指定所查询实例的集群类型，取值范围如下：
    0：副本集实例。
    1：分片实例。
    -1：副本集与分片实例。
  - setClusterType
```
public void setClusterType(Long ClusterType)
```
    Set 指定所查询实例的集群类型，取值范围如下：
    - 0：副本集实例。
    - 1：分片实例。
    - -1：副本集与分片实例。
    Parameters:
    ClusterType - 指定所查询实例的集群类型，取值范围如下：
    0：副本集实例。
    1：分片实例。
    -1：副本集与分片实例。
  - getStatus
```
public Long[] getStatus()
```
    Get 指定所查询实例的当前状态，取值范围如下所示：
    - 0：待初始化。
    - 1：流程处理中，例如：变更规格、参数修改等。
    - 2：实例正常运行中。
    - -2：实例已过期。
    Returns:
    Status 指定所查询实例的当前状态，取值范围如下所示：
    0：待初始化。
    1：流程处理中，例如：变更规格、参数修改等。
    2：实例正常运行中。
    -2：实例已过期。
  - setStatus
```
public void setStatus(Long[] Status)
```
    Set 指定所查询实例的当前状态，取值范围如下所示：
    - 0：待初始化。
    - 1：流程处理中，例如：变更规格、参数修改等。
    - 2：实例正常运行中。
    - -2：实例已过期。
    Parameters:
    Status - 指定所查询实例的当前状态，取值范围如下所示：
    0：待初始化。
    1：流程处理中，例如：变更规格、参数修改等。
    2：实例正常运行中。
    -2：实例已过期。
  - getVpcId
```
public String getVpcId()
```
    Get 私有网络的 ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其 ID。
    
    Returns:
    
    VpcId 私有网络的 ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其 ID。
  - setVpcId
```
public void setVpcId(String VpcId)
```
    Set 私有网络的 ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其 ID。
    
    Parameters:
    
    VpcId - 私有网络的 ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其 ID。
  - getSubnetId
```
public String getSubnetId()
```
    Get 私有网络的子网ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其子网 ID。
    
    Returns:
    
    SubnetId 私有网络的子网ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其子网 ID。
  - setSubnetId
```
public void setSubnetId(String SubnetId)
```
    Set 私有网络的子网ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其子网 ID。
    
    Parameters:
    
    SubnetId - 私有网络的子网ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其子网 ID。
  - getPayMode
```
public Long getPayMode()
```
    Get 指定所查询实例的付费类型，取值范围如下：
    - 0：查询按量计费实例。
    - 1：查询包年包月实例。
    - -1：查询按量计费与包年包月实例。
    Returns:
    PayMode 指定所查询实例的付费类型，取值范围如下：
    0：查询按量计费实例。
    1：查询包年包月实例。
    -1：查询按量计费与包年包月实例。
  - setPayMode
```
public void setPayMode(Long PayMode)
```
    Set 指定所查询实例的付费类型，取值范围如下：
    - 0：查询按量计费实例。
    - 1：查询包年包月实例。
    - -1：查询按量计费与包年包月实例。
    Parameters:
    PayMode - 指定所查询实例的付费类型，取值范围如下：
    0：查询按量计费实例。
    1：查询包年包月实例。
    -1：查询按量计费与包年包月实例。
  - getLimit
```
public Long getLimit()
```
    Get 单次请求返回的数量。默认值为20，取值范围为[1,100]。
    
    Returns:
    
    Limit 单次请求返回的数量。默认值为20，取值范围为[1,100]。
  - setLimit
```
public void setLimit(Long Limit)
```
    Set 单次请求返回的数量。默认值为20，取值范围为[1,100]。
    
    Parameters:
    
    Limit - 单次请求返回的数量。默认值为20，取值范围为[1,100]。
  - getOffset
```
public Long getOffset()
```
    Get 偏移量，默认值为0。
    
    Returns:
    
    Offset 偏移量，默认值为0。
  - setOffset
```
public void setOffset(Long Offset)
```
    Set 偏移量，默认值为0。
    
    Parameters:
    
    Offset - 偏移量，默认值为0。
  - getOrderBy
```
public String getOrderBy()
```
    Get 配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
    
    Returns:
    
    OrderBy 配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
  - setOrderBy
```
public void setOrderBy(String OrderBy)
```
    Set 配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
    
    Parameters:
    
    OrderBy - 配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
  - getOrderByType
```
public String getOrderByType()
```
    Get 配置返回结果的排序方式。 - ASC：升序。 - DESC：降序。
    
    Returns:
    
    OrderByType 配置返回结果的排序方式。 - ASC：升序。 - DESC：降序。
  - setOrderByType
```
public void setOrderByType(String OrderByType)
```
    Set 配置返回结果的排序方式。 - ASC：升序。 - DESC：降序。
    
    Parameters:
    
    OrderByType - 配置返回结果的排序方式。 - ASC：升序。 - DESC：降序。
  - getProjectIds
```
public Long[] getProjectIds()
```
    Get 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
    
    Returns:
    
    ProjectIds 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
  - setProjectIds
```
public void setProjectIds(Long[] ProjectIds)
```
    Set 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
    
    Parameters:
    
    ProjectIds - 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
  - getSearchKey
```
public String getSearchKey()
```
    Get 指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
    
    Returns:
    
    SearchKey 指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
  - setSearchKey
```
public void setSearchKey(String SearchKey)
```
    Set 指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
    
    Parameters:
    
    SearchKey - 指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
  - getTags
```
public TagInfo[] getTags()
```
    Get 标签信息，包含标签键与标签值。
    
    Returns:
    
    Tags 标签信息，包含标签键与标签值。
  - setTags
```
public void setTags(TagInfo[] Tags)
```
    Set 标签信息，包含标签键与标签值。
    
    Parameters:
    
    Tags - 标签信息，包含标签键与标签值。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class DescribeDBInstancesRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribeDBInstancesRequest

DescribeDBInstancesRequest

Method Detail

getInstanceIds

setInstanceIds

getInstanceType

setInstanceType

getClusterType

setClusterType

getStatus

setStatus

getVpcId

setVpcId

getSubnetId

setSubnetId

getPayMode

setPayMode

getLimit

setLimit

getOffset

setOffset

getOrderBy

setOrderBy

getOrderByType

setOrderByType

getProjectIds

setProjectIds

getSearchKey

setSearchKey

getTags

setTags

toMap