com.tencentcloudapi.cdb.v20170320.models

Class DescribeDBInstancesRequest

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()
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

Modifier and Type	Method and Description
String[]	getCageIds() Get Financial cage IDs.
Long[]	getCdbErrors() Get Whether to lock disk write.
String[]	getDeployGroupIds() Get Placement group ID list.
String[]	getEngineTypes() Get Database engine type
String[]	getEngineVersions() Get Version of the instance database engine.
String	getExClusterId() Get Exclusive cluster ID.
Long	getInitFlag() Get Initialization flag.
String[]	getInstanceIds() Get Instance ID.
String[]	getInstanceNames() Get Instance name.
Long[]	getInstanceTypes() Get Instance type.
Long	getLimit() Get Number of results to be returned for a single request.
Long	getOffset() Get Offset.
String	getOrderBy() Get Sort by field of the returned result set.
String	getOrderDirection() Get Sorting method of the returned result set.
Long[]	getPayTypes() Get Billing method.
Long	getProjectId() Get Project ID.
String[]	getProxyIds() Get Database proxy ID
String[]	getProxyVips() Get Database proxy IP
String	getSecurityGroupId() Get Security group ID.
Long[]	getStatus() Get Instance status.
Long[]	getSubnetIds() Get Subnet ID.
String[]	getTagKeysForSearch() Get Whether to use the tag key as a filter condition
Tag[]	getTags() Get Tag key value
String[]	getTagValues() Get Tag value
Long[]	getTaskStatus() Get Instance task status.
String[]	getUniqSubnetIds() Get VPC character subnetId
String[]	getUniqueVpcIds() Get VPC character vpcId
String[]	getVips() Get Private IP address of the instance.
Long[]	getVpcIds() Get VPC ID.
Long	getWithDr() Get Whether instances corresponding to the disaster recovery relationship are included.
Long	getWithExCluster() Get Whether dedicated cluster details are included.
Long	getWithMaster() Get Whether primary instances are included.
Long	getWithRo() Get Whether read-only instances are included.
Long	getWithSecurityGroup() Get Whether security group ID is used as a filter
Long[]	getZoneIds() Get AZ ID.
void	setCageIds(String[] CageIds) Set Financial cage IDs.
void	setCdbErrors(Long[] CdbErrors) Set Whether to lock disk write.
void	setDeployGroupIds(String[] DeployGroupIds) Set Placement group ID list.
void	setEngineTypes(String[] EngineTypes) Set Database engine type
void	setEngineVersions(String[] EngineVersions) Set Version of the instance database engine.
void	setExClusterId(String ExClusterId) Set Exclusive cluster ID.
void	setInitFlag(Long InitFlag) Set Initialization flag.
void	setInstanceIds(String[] InstanceIds) Set Instance ID.
void	setInstanceNames(String[] InstanceNames) Set Instance name.
void	setInstanceTypes(Long[] InstanceTypes) Set Instance type.
void	setLimit(Long Limit) Set Number of results to be returned for a single request.
void	setOffset(Long Offset) Set Offset.
void	setOrderBy(String OrderBy) Set Sort by field of the returned result set.
void	setOrderDirection(String OrderDirection) Set Sorting method of the returned result set.
void	setPayTypes(Long[] PayTypes) Set Billing method.
void	setProjectId(Long ProjectId) Set Project ID.
void	setProxyIds(String[] ProxyIds) Set Database proxy ID
void	setProxyVips(String[] ProxyVips) Set Database proxy IP
void	setSecurityGroupId(String SecurityGroupId) Set Security group ID.
void	setStatus(Long[] Status) Set Instance status.
void	setSubnetIds(Long[] SubnetIds) Set Subnet ID.
void	setTagKeysForSearch(String[] TagKeysForSearch) Set Whether to use the tag key as a filter condition
void	setTags(Tag[] Tags) Set Tag key value
void	setTagValues(String[] TagValues) Set Tag value
void	setTaskStatus(Long[] TaskStatus) Set Instance task status.
void	setUniqSubnetIds(String[] UniqSubnetIds) Set VPC character subnetId
void	setUniqueVpcIds(String[] UniqueVpcIds) Set VPC character vpcId
void	setVips(String[] Vips) Set Private IP address of the instance.
void	setVpcIds(Long[] VpcIds) Set VPC ID.
void	setWithDr(Long WithDr) Set Whether instances corresponding to the disaster recovery relationship are included.
void	setWithExCluster(Long WithExCluster) Set Whether dedicated cluster details are included.
void	setWithMaster(Long WithMaster) Set Whether primary instances are included.
void	setWithRo(Long WithRo) Set Whether read-only instances are included.
void	setWithSecurityGroup(Long WithSecurityGroup) Set Whether security group ID is used as a filter
void	setZoneIds(Long[] ZoneIds) Set AZ 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, getMultipartRequestParams, set, 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()

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

getProjectId

public Long getProjectId()

Get Project ID.

Returns:

ProjectId Project ID.

setProjectId

public void setProjectId(Long ProjectId)

Set Project ID.

Parameters:

ProjectId - Project ID.

getInstanceTypes

public Long[] getInstanceTypes()

Get Instance type. Value range: 1 (primary), 2 (disaster recovery), 3 (read-only).

Returns:

InstanceTypes Instance type. Value range: 1 (primary), 2 (disaster recovery), 3 (read-only).

setInstanceTypes

public void setInstanceTypes(Long[] InstanceTypes)

Set Instance type. Value range: 1 (primary), 2 (disaster recovery), 3 (read-only).

Parameters:

InstanceTypes - Instance type. Value range: 1 (primary), 2 (disaster recovery), 3 (read-only).

getVips

public String[] getVips()

Get Private IP address of the instance.

Returns:

Vips Private IP address of the instance.

setVips

public void setVips(String[] Vips)

Set Private IP address of the instance.

Parameters:

Vips - Private IP address of the instance.

getStatus

public Long[] getStatus()

Get Instance status. Valid values:
`0` (creating)
`1` (running)
`4` (isolating)
`5` (isolated; the instance can be restored and started in the recycle bin)

Returns:

Status Instance status. Valid values:
`0` (creating)
`1` (running)
`4` (isolating)
`5` (isolated; the instance can be restored and started in the recycle bin)

setStatus

public void setStatus(Long[] Status)

Set Instance status. Valid values:
`0` (creating)
`1` (running)
`4` (isolating)
`5` (isolated; the instance can be restored and started in the recycle bin)

Parameters:

Status - Instance status. Valid values:
`0` (creating)
`1` (running)
`4` (isolating)
`5` (isolated; the instance can be restored and started in the recycle bin)

getOffset

public Long getOffset()

Get Offset. Default value: 0.

Returns:

Offset Offset. Default value: 0.

setOffset

public void setOffset(Long Offset)

Set Offset. Default value: 0.

Parameters:

Offset - Offset. Default value: 0.

getLimit

public Long getLimit()

Get Number of results to be returned for a single request. Default value: 20. Maximum value: 2,000.

Returns:

Limit Number of results to be returned for a single request. Default value: 20. Maximum value: 2,000.

setLimit

public void setLimit(Long Limit)

Set Number of results to be returned for a single request. Default value: 20. Maximum value: 2,000.

Parameters:

Limit - Number of results to be returned for a single request. Default value: 20. Maximum value: 2,000.

getSecurityGroupId

public String getSecurityGroupId()

Get Security group ID. When it is used as a filter, the `WithSecurityGroup` parameter should be set to 1.

Returns:

SecurityGroupId Security group ID. When it is used as a filter, the `WithSecurityGroup` parameter should be set to 1.

setSecurityGroupId

public void setSecurityGroupId(String SecurityGroupId)

Set Security group ID. When it is used as a filter, the `WithSecurityGroup` parameter should be set to 1.

Parameters:

SecurityGroupId - Security group ID. When it is used as a filter, the `WithSecurityGroup` parameter should be set to 1.

getPayTypes

public Long[] getPayTypes()

Get Billing method. Value range: 0 (monthly subscribed), 1 (hourly).

Returns:

PayTypes Billing method. Value range: 0 (monthly subscribed), 1 (hourly).

setPayTypes

public void setPayTypes(Long[] PayTypes)

Set Billing method. Value range: 0 (monthly subscribed), 1 (hourly).

Parameters:

PayTypes - Billing method. Value range: 0 (monthly subscribed), 1 (hourly).

getInstanceNames

public String[] getInstanceNames()

Get Instance name.

Returns:

InstanceNames Instance name.

setInstanceNames

public void setInstanceNames(String[] InstanceNames)

Set Instance name.

Parameters:

InstanceNames - Instance name.

getTaskStatus

public Long[] getTaskStatus()

Get Instance task status. Valid values:
0 - no task
1 - upgrading
2 - importing data
3 - enabling secondary instance access
4 - enabling public network access
5 - batch operation in progress
6 - rolling back
7 - disabling public network access
8 - modifying password
9 - renaming instance
10 - restarting
12 - migrating self-built database
13 - dropping tables
14 - Disaster recovery instance creating sync task
15 - waiting for switch
16 - switching
17 - upgrade and switch completed
19 - parameter settings to be executed

Returns:

TaskStatus Instance task status. Valid values:
0 - no task
1 - upgrading
2 - importing data
3 - enabling secondary instance access
4 - enabling public network access
5 - batch operation in progress
6 - rolling back
7 - disabling public network access
8 - modifying password
9 - renaming instance
10 - restarting
12 - migrating self-built database
13 - dropping tables
14 - Disaster recovery instance creating sync task
15 - waiting for switch
16 - switching
17 - upgrade and switch completed
19 - parameter settings to be executed

setTaskStatus

public void setTaskStatus(Long[] TaskStatus)

Set Instance task status. Valid values:
0 - no task
1 - upgrading
2 - importing data
3 - enabling secondary instance access
4 - enabling public network access
5 - batch operation in progress
6 - rolling back
7 - disabling public network access
8 - modifying password
9 - renaming instance
10 - restarting
12 - migrating self-built database
13 - dropping tables
14 - Disaster recovery instance creating sync task
15 - waiting for switch
16 - switching
17 - upgrade and switch completed
19 - parameter settings to be executed

Parameters:

TaskStatus - Instance task status. Valid values:
0 - no task
1 - upgrading
2 - importing data
3 - enabling secondary instance access
4 - enabling public network access
5 - batch operation in progress
6 - rolling back
7 - disabling public network access
8 - modifying password
9 - renaming instance
10 - restarting
12 - migrating self-built database
13 - dropping tables
14 - Disaster recovery instance creating sync task
15 - waiting for switch
16 - switching
17 - upgrade and switch completed
19 - parameter settings to be executed

getEngineVersions

public String[] getEngineVersions()

Get Version of the instance database engine. Value range: 5.1, 5.5, 5.6, 5.7.

Returns:

EngineVersions Version of the instance database engine. Value range: 5.1, 5.5, 5.6, 5.7.

setEngineVersions

public void setEngineVersions(String[] EngineVersions)

Set Version of the instance database engine. Value range: 5.1, 5.5, 5.6, 5.7.

Parameters:

EngineVersions - Version of the instance database engine. Value range: 5.1, 5.5, 5.6, 5.7.

getVpcIds

public Long[] getVpcIds()

Get VPC ID.

Returns:

VpcIds VPC ID.

setVpcIds

public void setVpcIds(Long[] VpcIds)

Set VPC ID.

Parameters:

VpcIds - VPC ID.

getZoneIds

public Long[] getZoneIds()

Get AZ ID.

Returns:

ZoneIds AZ ID.

setZoneIds

public void setZoneIds(Long[] ZoneIds)

Set AZ ID.

Parameters:

ZoneIds - AZ ID.

getSubnetIds

public Long[] getSubnetIds()

Get Subnet ID.

Returns:

SubnetIds Subnet ID.

setSubnetIds

public void setSubnetIds(Long[] SubnetIds)

Set Subnet ID.

Parameters:

SubnetIds - Subnet ID.

getCdbErrors

public Long[] getCdbErrors()

Get Whether to lock disk write. Valid values: `0`(unlock), `1`(lock). Default value: 0.

Returns:

CdbErrors Whether to lock disk write. Valid values: `0`(unlock), `1`(lock). Default value: 0.

setCdbErrors

public void setCdbErrors(Long[] CdbErrors)

Set Whether to lock disk write. Valid values: `0`(unlock), `1`(lock). Default value: 0.

Parameters:

CdbErrors - Whether to lock disk write. Valid values: `0`(unlock), `1`(lock). Default value: 0.

getOrderBy

public String getOrderBy()

Get Sort by field of the returned result set. Currently, supported values include "InstanceId", "InstanceName", "CreateTime", and "DeadlineTime".

Returns:

OrderBy Sort by field of the returned result set. Currently, supported values include "InstanceId", "InstanceName", "CreateTime", and "DeadlineTime".

setOrderBy

public void setOrderBy(String OrderBy)

Set Sort by field of the returned result set. Currently, supported values include "InstanceId", "InstanceName", "CreateTime", and "DeadlineTime".

Parameters:

OrderBy - Sort by field of the returned result set. Currently, supported values include "InstanceId", "InstanceName", "CreateTime", and "DeadlineTime".

getOrderDirection

public String getOrderDirection()

Get Sorting method of the returned result set. Currently, "ASC" or "DESC" is supported.

Returns:

OrderDirection Sorting method of the returned result set. Currently, "ASC" or "DESC" is supported.

setOrderDirection

public void setOrderDirection(String OrderDirection)

Set Sorting method of the returned result set. Currently, "ASC" or "DESC" is supported.

Parameters:

OrderDirection - Sorting method of the returned result set. Currently, "ASC" or "DESC" is supported.

getWithSecurityGroup

public Long getWithSecurityGroup()

Get Whether security group ID is used as a filter

Returns:

WithSecurityGroup Whether security group ID is used as a filter

setWithSecurityGroup

public void setWithSecurityGroup(Long WithSecurityGroup)

Set Whether security group ID is used as a filter

Parameters:

WithSecurityGroup - Whether security group ID is used as a filter

getWithExCluster

public Long getWithExCluster()

Get Whether dedicated cluster details are included. Value range: 0 (not included), 1 (included)

Returns:

WithExCluster Whether dedicated cluster details are included. Value range: 0 (not included), 1 (included)

setWithExCluster

public void setWithExCluster(Long WithExCluster)

Set Whether dedicated cluster details are included. Value range: 0 (not included), 1 (included)

Parameters:

WithExCluster - Whether dedicated cluster details are included. Value range: 0 (not included), 1 (included)

getExClusterId

public String getExClusterId()

Get Exclusive cluster ID.

Returns:

ExClusterId Exclusive cluster ID.

setExClusterId

public void setExClusterId(String ExClusterId)

Set Exclusive cluster ID.

Parameters:

ExClusterId - Exclusive cluster ID.

getInstanceIds

public String[] getInstanceIds()

Get Instance ID.

Returns:

InstanceIds Instance ID.

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set Instance ID.

Parameters:

InstanceIds - Instance ID.

getInitFlag

public Long getInitFlag()

Get Initialization flag. Value range: 0 (not initialized), 1 (initialized).

Returns:

InitFlag Initialization flag. Value range: 0 (not initialized), 1 (initialized).

setInitFlag

public void setInitFlag(Long InitFlag)

Set Initialization flag. Value range: 0 (not initialized), 1 (initialized).

Parameters:

InitFlag - Initialization flag. Value range: 0 (not initialized), 1 (initialized).

getWithDr

public Long getWithDr()

Get Whether instances corresponding to the disaster recovery relationship are included. Valid values: 0 (not included), 1 (included). Default value: 1. If a primary instance is pulled, the data of the disaster recovery relationship will be in the `DrInfo` field. If a disaster recovery instance is pulled, the data of the disaster recovery relationship will be in the `MasterInfo` field. The disaster recovery relationship contains only partial basic data. To get the detailed data, you need to call an API to pull it.

Returns:

WithDr Whether instances corresponding to the disaster recovery relationship are included. Valid values: 0 (not included), 1 (included). Default value: 1. If a primary instance is pulled, the data of the disaster recovery relationship will be in the `DrInfo` field. If a disaster recovery instance is pulled, the data of the disaster recovery relationship will be in the `MasterInfo` field. The disaster recovery relationship contains only partial basic data. To get the detailed data, you need to call an API to pull it.

setWithDr

public void setWithDr(Long WithDr)

Set Whether instances corresponding to the disaster recovery relationship are included. Valid values: 0 (not included), 1 (included). Default value: 1. If a primary instance is pulled, the data of the disaster recovery relationship will be in the `DrInfo` field. If a disaster recovery instance is pulled, the data of the disaster recovery relationship will be in the `MasterInfo` field. The disaster recovery relationship contains only partial basic data. To get the detailed data, you need to call an API to pull it.

Parameters:

WithDr - Whether instances corresponding to the disaster recovery relationship are included. Valid values: 0 (not included), 1 (included). Default value: 1. If a primary instance is pulled, the data of the disaster recovery relationship will be in the `DrInfo` field. If a disaster recovery instance is pulled, the data of the disaster recovery relationship will be in the `MasterInfo` field. The disaster recovery relationship contains only partial basic data. To get the detailed data, you need to call an API to pull it.

getWithRo

public Long getWithRo()

Get Whether read-only instances are included. Valid values: 0 (not included), 1 (included). Default value: 1.

Returns:

WithRo Whether read-only instances are included. Valid values: 0 (not included), 1 (included). Default value: 1.

setWithRo

public void setWithRo(Long WithRo)

Set Whether read-only instances are included. Valid values: 0 (not included), 1 (included). Default value: 1.

Parameters:

WithRo - Whether read-only instances are included. Valid values: 0 (not included), 1 (included). Default value: 1.

getWithMaster

public Long getWithMaster()

Get Whether primary instances are included. Valid values: 0 (not included), 1 (included). Default value: 1.

Returns:

WithMaster Whether primary instances are included. Valid values: 0 (not included), 1 (included). Default value: 1.

setWithMaster

public void setWithMaster(Long WithMaster)

Set Whether primary instances are included. Valid values: 0 (not included), 1 (included). Default value: 1.

Parameters:

WithMaster - Whether primary instances are included. Valid values: 0 (not included), 1 (included). Default value: 1.

getDeployGroupIds

public String[] getDeployGroupIds()

Get Placement group ID list.

Returns:

DeployGroupIds Placement group ID list.

setDeployGroupIds

public void setDeployGroupIds(String[] DeployGroupIds)

Set Placement group ID list.

Parameters:

DeployGroupIds - Placement group ID list.

getTagKeysForSearch

public String[] getTagKeysForSearch()

Get Whether to use the tag key as a filter condition

Returns:

TagKeysForSearch Whether to use the tag key as a filter condition

setTagKeysForSearch

public void setTagKeysForSearch(String[] TagKeysForSearch)

Set Whether to use the tag key as a filter condition

Parameters:

TagKeysForSearch - Whether to use the tag key as a filter condition

getCageIds

public String[] getCageIds()

Get Financial cage IDs.

Returns:

CageIds Financial cage IDs.

setCageIds

public void setCageIds(String[] CageIds)

Set Financial cage IDs.

Parameters:

CageIds - Financial cage IDs.

getTagValues

public String[] getTagValues()

Get Tag value

Returns:

TagValues Tag value

setTagValues

public void setTagValues(String[] TagValues)

Set Tag value

Parameters:

TagValues - Tag value

getUniqueVpcIds

public String[] getUniqueVpcIds()

Get VPC character vpcId

Returns:

UniqueVpcIds VPC character vpcId

setUniqueVpcIds

public void setUniqueVpcIds(String[] UniqueVpcIds)

Set VPC character vpcId

Parameters:

UniqueVpcIds - VPC character vpcId

getUniqSubnetIds

public String[] getUniqSubnetIds()

Get VPC character subnetId

Returns:

UniqSubnetIds VPC character subnetId

setUniqSubnetIds

public void setUniqSubnetIds(String[] UniqSubnetIds)

Set VPC character subnetId

Parameters:

UniqSubnetIds - VPC character subnetId

getTags

public Tag[] getTags()

Get Tag key value

Returns:

Tags Tag key value

setTags

public void setTags(Tag[] Tags)

Set Tag key value

Parameters:

Tags - Tag key value

getProxyVips

public String[] getProxyVips()

Get Database proxy IP

Returns:

ProxyVips Database proxy IP

setProxyVips

public void setProxyVips(String[] ProxyVips)

Set Database proxy IP

Parameters:

ProxyVips - Database proxy IP

getProxyIds

public String[] getProxyIds()

Get Database proxy ID

Returns:

ProxyIds Database proxy ID

setProxyIds

public void setProxyIds(String[] ProxyIds)

Set Database proxy ID

Parameters:

ProxyIds - Database proxy ID

getEngineTypes

public String[] getEngineTypes()

Get Database engine type

Returns:

EngineTypes Database engine type

setEngineTypes

public void setEngineTypes(String[] EngineTypes)

Set Database engine type

Parameters:

EngineTypes - Database engine type

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel