tencent cloud

Feedback

Data Types

Last updated: 2022-06-14 16:46:35

Account

TencentDB account information

Used by actions: DeleteAccounts, ModifyAccountDescription, ModifyAccountMaxUserConnections, ModifyAccountPassword, ModifyAccountPrivileges.

Name Type Required Description
User String Yes New account name
Host String Yes New account domain name

Address

Address

Used by actions: DescribeCDBProxy, QueryCDBProxy.

Name Type Description
Vip String Address
Note: this field may return null, indicating that no valid value can be found.
VPort Integer Port
Note: this field may return null, indicating that no valid value can be found.
UniqVpcId String VPC ID
Note: this field may return null, indicating that no valid value can be found.
UniqSubnet String VPC subnet ID
Note: this field may return null, indicating that no valid value can be found.
Desc String Description
Note: this field may return null, indicating that no valid value can be found.

AuditFilter

Audit rule filters

Used by actions: DescribeAuditRules.

Name Type Required Description
Type String Yes Filter parameter names. Valid values:
SrcIp: Client IP;
User: Database account;
DB: Database name.
Compare String Yes Filter match type. Valid value:
INC: Include;
EXC: Exclude;
EQ: Equal to;
NEQ: Not equal to.
Value String Yes Filter match value

AuditPolicy

Audit Policy

Used by actions: DescribeAuditPolicies.

Name Type Description
PolicyId String Audit policy ID.
Status String Audit policy status. Valid values:
creating;
running,
paused;
failed.
InstanceId String Database instance ID
CreateTime String Creation time of audit policy in the format of 2019-03-20 17:09:13
ModifyTime String Last modified time of audit policy in the format of 2019-03-20 17:09:13
PolicyName String Audit policy name
RuleId String Audit rule ID
RuleName String Audit rule name
Note: This field may return null, indicating that no valid value was found.
InstanceName String Database instance name
Note: This field may return null, indicating that no valid value was found.

AuditRule

Audit rule

Used by actions: DescribeAuditRules.

Name Type Description
RuleId String Audit rule ID
CreateTime String Creation time of audit rule in the format of 2019-03-20 17:09:13
ModifyTime String Last modified time of audit rule in the format of 2019-03-20 17:09:13
RuleName String Audit rule name
Note: This field may return null, indicating that no valid value was found.
Description String Audit rule description
Note: This field may return null, indicating that no valid value was found.
RuleFilters Array of AuditFilter Audit rule filters
Note: This field may return null, indicating that no valid value was found.
AuditAll Boolean Whether to enable full audit

BackupConfig

Configuration information of ECDB secondary database 2. This field is only applicable to ECDB instances

Used by actions: DescribeDBInstanceConfig.

Name Type Description
ReplicationMode String Replication mode of secondary database 2. Value range: async, semi-sync
Zone String Name of the AZ of secondary database 2, such as ap-shanghai-1
Vip String Private IP address of secondary database 2
Vport Integer Access port of secondary database 2

BackupInfo

Backup details

Used by actions: DescribeBackups.

Name Type Description
Name String Backup filename
Size Integer Backup file size in bytes
Date String Backup snapshot time in the format of yyyy-MM-dd HH:mm:ss, such as 2016-03-17 02:10:37
IntranetUrl String Download address
InternetUrl String Download address
Type String Log type. Valid values: logical (logical cold backup), physical (physical cold backup).
BackupId Integer Backup subtask ID, which is used when backup files are deleted
Status String Backup task status. Valid values: SUCCESS (backup succeeded), FAILED (backup failed), RUNNING (backup is in progress).
FinishTime String Backup task completion time
Creator String (This field will be disused and is thus not recommended) backup creator. Valid values: SYSTEM (created by system), Uin (initiator's Uin value).
StartTime String Backup task start time
Method String Backup method. Valid values: full (full backup), partial (partial backup).
Way String Backup mode. Valid values: manual (manual backup), automatic (automatic backup).
ManualBackupName String Manual backup alias
SaveMode String Backup retention type. Valid values: save_mode_regular (non-archive backup), save_mode_period`(archive backup).

BackupItem

When creating a backup, you need to specify the information of the table to be backed up.

Used by actions: CreateBackup.

Name Type Required Description
Db String Yes Name of the database to be backed up
Table String No Name of the table to be backed up. If this parameter is passed in, the specified table in the database will be backed up; otherwise, the database will be backed up.

BackupLimitVpcItem

VPCs used to restrict backup download

Used by actions: DescribeBackupDownloadRestriction, ModifyBackupDownloadRestriction.

Name Type Required Description
Region String Yes The region where the backup download restrictions take effect. It must be the same as the common request parameter Region of the API.
VpcList Array of String Yes The list of VPCs used to restrict backup download

BackupSummaryItem

Statistical items of instance backup

Used by actions: DescribeBackupSummaries.

Name Type Description
InstanceId String Instance ID.
AutoBackupCount Integer Number of automatic data backups of an instance.
AutoBackupVolume Integer Capacity of automatic data backups of an instance.
ManualBackupCount Integer Number of manual data backups of an instance.
ManualBackupVolume Integer Capacity of manual data backups of an instance.
DataBackupCount Integer Total number of data backups of an instance (including automatic backups and manual backups).
DataBackupVolume Integer Total capacity of data backups of an instance.
BinlogBackupCount Integer Number of log backups of an instance.
BinlogBackupVolume Integer Capacity of log backups of an instance.
BackupVolume Integer Total capacity of backups of an instance (including data backups and log backups).

BaseGroupInfo

Proxy group information

Used by actions: DescribeCDBProxy, QueryCDBProxy.

Name Type Description
ProxyGroupId String Proxy group ID
Note: this field may return null, indicating that no valid value can be found.
NodeCount Integer Number of proxy nodes
Note: this field may return null, indicating that no valid value can be found.
Status String Proxy group status. Valid values: init (delivering), online (active), offline (inactive), destroy (destoryed)
Note: this field may return null, indicating that no valid value can be found.
Region String Region
Note: this field may return null, indicating that no valid value can be found.
Zone String Availability zone
Note: this field may return null, indicating that no valid value can be found.
OpenRW Boolean Whether read/write separation is enabled
Note: this field may return null, indicating that no valid value can be found.
CurrentProxyVersion String Current proxy version
Note: this field may return null, indicating that no valid value can be found.
SupportUpgradeProxyVersion String Target version to which the proxy can be upgraded
Note: this field may return null, indicating that no valid value can be found.

BinlogInfo

Binlog information

Used by actions: DescribeBinlogs.

Name Type Description
Name String Binlog backup filename
Size Integer Backup file size in bytes
Date Timestamp File stored time in the format of 2016-03-17 02:10:37
IntranetUrl String Download address
InternetUrl String Download address
Type String Log type. Value range: binlog
BinlogStartTime String Binlog file start file
BinlogFinishTime String Binlog file end time

CloneItem

Clone task information.

Used by actions: DescribeCloneList.

Name Type Description
SrcInstanceId String ID of the original instance in a clone task
DstInstanceId String ID of the cloned instance in a clone task
CloneJobId Integer Clone task ID
RollbackStrategy String The policy used in a clone task. Valid values: timepoint (roll back to a specific point in time), backupset (roll back by using a specific backup file).
RollbackTargetTime String The point in time to which the cloned instance will be rolled back
StartTime String Task start time
EndTime String Task end time
TaskStatus String Task status. Valid values: initial, running, wait_complete, success, failed.

ColumnPrivilege

Column permission information

Used by actions: DescribeAccountPrivileges, ModifyAccountPrivileges.

Name Type Required Description
Database String Yes Database name
Table String Yes Table name
Column String Yes Column name
Privileges Array of String Yes Permission information

CommonTimeWindow

Common time window

Used by actions: DescribeBackupConfig, ModifyBackupConfig.

Name Type Required Description
Monday String No Time window on Monday in the format of 02:00-06:00
Tuesday String No Time window on Tuesday in the format of 02:00-06:00
Wednesday String No Time window on Wednesday in the format of 02:00-06:00
Thursday String No Time window on Thursday in the format of 02:00-06:00
Friday String No Time window on Friday in the format of 02:00-06:00
Saturday String No Time window on Saturday in the format of 02:00-06:00
Sunday String No Time window on Sunday in the format of 02:00-06:00

ConnectionPoolInfo

Connection pool information

Used by actions: DescribeCDBProxy, QueryCDBProxy.

Name Type Description
ConnectionPool Boolean Whether the connection pool is enabled
Note: this field may return null, indicating that no valid value can be found.
ConnectionPoolType String Connection pool type. Valid value: SessionConnectionPool (session-level connection pool)
Note: this field may return null, indicating that no valid value can be found.
PoolConnectionTimeOut Integer Connection persistence timeout in seconds
Note: this field may return null, indicating that no valid value can be found.

CustomConfig

Proxy configuration

Used by actions: DescribeProxyCustomConf.

Name Type Description
Device String Device
Note: this field may return null, indicating that no valid value can be found.
Type String Type
Note: this field may return null, indicating that no valid value can be found.
DeviceType String Device type
Note: this field may return null, indicating that no valid value can be found.
Memory Integer Memory
Note: this field may return null, indicating that no valid value can be found.
Cpu Integer Number of CPU cores
Note: this field may return null, indicating that no valid value can be found.

DBSwitchInfo

TencentDB instance switch records

Used by actions: DescribeDBSwitchRecords.

Name Type Description
SwitchTime Timestamp Switch time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-09-03 01:34:31
SwitchType String Switch type. Value range: TRANSFER (data migration), MASTER2SLAVE (primary/secondary switch), RECOVERY (primary/secondary recovery)

DatabasePrivilege

Database permission

Used by actions: DescribeAccountPrivileges, ModifyAccountPrivileges.

Name Type Required Description
Privileges Array of String Yes Permission information
Database String Yes Database name

DatabasesWithCharacterLists

Database name and character set

Used by actions: DescribeDatabases.

Name Type Description
DatabaseName String Database name
CharacterSet String Character set

DeviceCpuInfo

CPU load

Used by actions: DescribeDeviceMonitorInfo.

Name Type Description
Rate Array of DeviceCpuRateInfo Average instance CPU utilization
Load Array of Integer CPU monitoring data of the instance

DeviceCpuRateInfo

Average instance CPU utilization

Used by actions: DescribeDeviceMonitorInfo.

Name Type Description
CpuCore Integer CPU core number
Rate Array of Integer CPU utilization

DeviceDiskInfo

Disk monitoring data of the instance

Used by actions: DescribeDeviceMonitorInfo.

Name Type Description
IoRatioPerSec Array of Integer Time percentage of IO operations per second
IoWaitTime Array of Integer Average wait time of device I/O operations * 100 in milliseconds. For example, if the value is 201, the average wait time of I/O operations is 201/100 = 2.1 milliseconds.
Read Array of Integer Average number of read operations completed by the disk per second * 100. For example, if the value is 2,002, the average number of read operations completed by the disk per second is 2,002/100=20.2.
Write Array of Integer Average number of write operations completed by the disk per second * 100. For example, if the value is 30,001, the average number of write operations completed by the disk per second is 30,001/100=300.01.
CapacityRatio Array of Integer Disk capacity. Each value is comprised of two data, with the first data representing the used capacity and the second one representing the total disk capacity.

DeviceMemInfo

Memory monitoring information of the physical server where the instance is located

Used by actions: DescribeDeviceMonitorInfo.

Name Type Description
Total Array of Integer Total memory size in KB, which is the value of total in the Mem: in the free command
Used Array of Integer Used memory size in KB, which is the value of used in the Mem: row in the free command

DeviceNetInfo

Network monitoring information of the physical server where the instance is located

Used by actions: DescribeDeviceMonitorInfo.

Name Type Description
Conn Array of Integer Number of TCP connections
PackageIn Array of Integer ENI inbound packets per second
PackageOut Array of Integer ENI outbound packets per second
FlowIn Array of Integer Inbound traffic in Kbps
FlowOut Array of Integer Outbound traffic in Kbps

DrInfo

Disaster recovery instance information

Used by actions: DescribeDBInstances.

Name Type Description
Status Integer Disaster recovery instance status
Zone String AZ information
InstanceId String Instance ID
Region String Region information
SyncStatus Integer Instance sync status. Possible returned values include:
0 - disaster recovery not synced;
1 - disaster recovery syncing;
2 - disaster recovery synced successfully;
3 - disaster recovery sync failed;
4 - repairing disaster recovery sync;
InstanceName String Instance name
InstanceType Integer Instance type

ErrlogItem

Structured error log details

Used by actions: DescribeErrorLogData.

Name Type Description
Timestamp Integer Error occurrence time.
Note: this field may return null, indicating that no valid values can be obtained.
Content String Error details
Note: this field may return null, indicating that no valid values can be obtained.

ImportRecord

Import task records

Used by actions: DescribeDBImportRecords.

Name Type Description
Status Integer Status value
Code Integer Status value
CostTime Integer Execution duration
InstanceId String Instance ID
WorkId String Backend task ID
FileName String Name of the file to be imported
Process Integer Execution progress
CreateTime Timestamp Task creation time
FileSize String File size
Message String Task execution information
JobId Integer Task ID
DbName String Name of the table to be imported
AsyncRequestId String Async task request ID

Inbound

Security group inbound rule

Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

Name Type Description
Action String Policy, which can be ACCEPT or DROP
CidrIp String Source IP or IP range, such as 192.168.0.0/16
PortRange String Port
IpProtocol String Network protocol. UDP and TCP are supported.
Dir String The direction of the rule, which is INPUT for inbound rules
Desc String Rule description

InstanceInfo

Instance details

Used by actions: DescribeDBInstances.

Name Type Description
WanStatus Integer Public network access status. Value range: 0 (not enabled), 1 (enabled), 2 (disabled)
Zone String AZ information
InitFlag Integer Initialization flag. Value range: 0 (not initialized), 1 (initialized)
RoVipInfo RoVipInfo VIP information of a read-only instance. This field is exclusive to read-only instances where read-only access is enabled separately
Note: This field may return null, indicating that no valid values can be obtained.
Memory Integer Memory capacity in MB
Status Integer Instance status. Value range: 0 (creating), 1 (running), 4 (isolating), 5 (isolated)
VpcId Integer VPC ID, such as 51102
SlaveInfo SlaveInfo Information of a secondary server
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String Instance ID
Volume Integer Disk capacity in GB
AutoRenew Integer Auto-renewal flag. Value range: 0 (auto-renewal not enabled), 1 (auto-renewal enabled), 2 (auto-renewal disabled)
ProtectMode Integer Data replication mode. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync)
RoGroups Array of RoGroup Details of a read-only group
Note: This field may return null, indicating that no valid values can be obtained.
SubnetId Integer Subnet ID, such as 2333
InstanceType Integer Instance type. Value range: 1 (primary), 2 (disaster recovery), 3 (read-only)
ProjectId Integer Project ID
Region String Region information
DeadlineTime Timestamp Instance expiration time
DeployMode Integer AZ deployment mode. Valid values: 0 (single-AZ), 1 (multi-AZ)
TaskStatus Integer Instance task status. 0 - no task; 1 - upgrading; 2 - importing data; 3 - activating secondary; 4 - enabling public network access; 5 - batch operation in progress; 6 - rolling back; 7 - disabling public network access; 8 - changing password; 9 - renaming instance; 10 - restarting; 12 - migrating self-built instance; 13 - dropping table; 14 - creating and syncing disaster recovery instance; 15 - pending upgrade and switch; 16 - upgrade and switch in progress; 17 - upgrade and switch completed
MasterInfo MasterInfo Details of a primary instance
Note: This field may return null, indicating that no valid values can be obtained.
DeviceType String Instance type
EngineVersion String Kernel version
InstanceName String Instance name
DrInfo Array of DrInfo Details of a disaster recovery instance
Note: This field may return null, indicating that no valid values can be obtained.
WanDomain String Public domain name
WanPort Integer Public network port number
PayType Integer Billing type
CreateTime String Instance creation time
Vip String Instance IP
Vport Integer Port number
CdbError Integer Whether the disk write is locked (It depends on whether the instance data in disk exceeds its quota). Valid values: 0 (unlocked), 1 (locked).
UniqVpcId String VPC descriptor, such as "vpc-5v8wn9mg"
UniqSubnetId String Subnet descriptor, such as "subnet-1typ0s7d"
PhysicalId String Physical ID
Cpu Integer Number of cores
Qps Integer Queries per second
ZoneName String AZ name
DeviceClass String Physical machine model
Note: This field may return null, indicating that no valid values can be obtained.
DeployGroupId String Placement group ID
Note: this field may return null, indicating that no valid values can be obtained.
ZoneId Integer AZ ID
Note: this field may return null, indicating that no valid values can be obtained.
InstanceNodes Integer Number of nodes
TagList Array of TagInfoItem List of tags
Note: this field may return null, indicating that no valid values can be obtained.

InstanceRebootTime

Estimated time of instance restart

Used by actions: DescribeDBInstanceRebootTime.

Name Type Description
InstanceId String Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.
TimeInSeconds Integer Estimated restart time

InstanceRollbackRangeTime

Time range available for instance rollback

Used by actions: DescribeRollbackRangeTime.

Name Type Description
Code Integer Queries database error code
Message String Queries database error message
InstanceId String List of instance IDs. An instance ID is in the format of cdb-c1nl9rpv, which is the same as the instance ID displayed on the TencentDB Console page.
Times Array of RollbackTimeRange Time range available for rollback

LocalBinlogConfig

Retention policy of local binlog

Used by actions: DescribeLocalBinlogConfig.

Name Type Description
SaveHours Integer Retention period of local binlog. Value range: [72,168].
MaxUsage Integer Space utilization of local binlog. Value range: [30,50].

LocalBinlogConfigDefault

Default retention policy of local binlog.

Used by actions: DescribeLocalBinlogConfig.

Name Type Description
SaveHours Integer Retention period of local binlog. Value range: [72,168].
MaxUsage Integer Space utilization of local binlog. Value range: [30,50].

MasterInfo

Master instance information

Used by actions: DescribeDBInstances.

Name Type Description
Region String Region information
RegionId Integer Region ID
ZoneId Integer AZ ID
Zone String AZ information
InstanceId String Instance ID
ResourceId String Long instance ID
Status Integer Instance status
InstanceName String Instance name
InstanceType Integer Instance type
TaskStatus Integer Task status
Memory Integer Memory capacity
Volume Integer Disk capacity
DeviceType String Instance model
Qps Integer Queries per second
VpcId Integer VPC ID
SubnetId Integer Subnet ID
ExClusterId String Dedicated cluster ID
ExClusterName String Dedicated cluster name

Outbound

Security group outbound rule

Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

Name Type Description
Action String Policy, which can be ACCEPT or DROP
CidrIp String Destination IP or IP range, such as 172.16.0.0/12
PortRange String Port or port range
IpProtocol String Network protocol. UDP and TCP are supported
Dir String The direction of the rule, which is OUTPUT for inbound rules
Desc String Rule description

ParamInfo

Instance parameter information

Used by actions: CreateDBInstanceHour, InitDBInstances.

Name Type Required Description
Name String Yes Parameter name
Value String Yes Parameter value

ParamRecord

Parameter modification records

Used by actions: DescribeInstanceParamRecords.

Name Type Description
InstanceId String Instance ID
ParamName String Parameter name
OldValue String Parameter value before modification
NewValue String Parameter value after modification
IsSucess Boolean Whether the parameter is modified successfully
ModifyTime String Modification time

ParamTemplateInfo

Parameter template information

Used by actions: DescribeParamTemplates.

Name Type Description
TemplateId Integer Parameter template ID
Name String Parameter template name
Description String Parameter template description
EngineVersion String Instance engine version
TemplateType String Parameter template type

Parameter

Database instance parameter

Used by actions: CreateParamTemplate, ModifyInstanceParam, ModifyParamTemplate.

Name Type Required Description
Name String Yes Parameter name
CurrentValue String Yes Parameter value

ParameterDetail

Instance parameter details

Used by actions: DescribeDefaultParams, DescribeInstanceParams, DescribeParamTemplateInfo.

Name Type Description
Name String Parameter name
ParamType String Parameter type. Valid values: integer, enum, float, string, func
Default String Default value of the parameter
Description String Parameter description
CurrentValue String Current value of the parameter
NeedReboot Integer Whether the database needs to be restarted for the modified parameter to take effect. Value range: 0 (no); 1 (yes)
Max Integer Maximum value of the parameter
Min Integer Minimum value of the parameter
EnumValue Array of String Enumerated values of the parameter. It is null if the parameter is non-enumerated
MaxFunc String Maximum parameter value, which is valid only when ParamType is set to func
MinFunc String Minimum parameter value, which is valid only when ParamType is set to func

PoolConf

Connection pool configuration of database proxy

Used by actions: DescribeProxyConnectionPoolConf.

Name Type Description
ConnectionPoolType String Connection pool type. Valid value: SessionConnectionPool (session-level connection pool)
Note: this field may return null, indicating that no valid value can be found.
MaxPoolConnectionTimeOut Integer Maximum value of connection persistence timeout in seconds
Note: this field may return null, indicating that no valid value can be found.
MinPoolConnectionTimeOut Integer Minimum value of connection persistence timeout in seconds
Note: this field may return null, indicating that no valid value can be found.

ProxyGroup

Database proxy group information

Used by actions: DescribeCDBProxy.

Name Type Description
BaseGroup BaseGroupInfo Basic information of the proxy
Note: this field may return null, indicating that no valid value can be found.
Address Array of Address Address information of the proxy
Note: this field may return null, indicating that no valid value can be found.
ConnectionPoolInfo ConnectionPoolInfo Connection pool information of the proxy
Note: this field may return null, indicating that no valid value can be found.
ProxyNode Array of ProxyNodeInfo Node information of the proxy
Note: this field may return null, indicating that no valid value can be found.
RWInstInfo RWInfo Routing information of the proxy
Note: this field may return null, indicating that no valid value can be found.

ProxyGroups

Database proxy group information

Used by actions: QueryCDBProxy.

Name Type Description
BaseGroup BaseGroupInfo Basic information of the proxy
Note: this field may return null, indicating that no valid value can be found.
Address Array of Address Address information of the proxy
Note: this field may return null, indicating that no valid value can be found.
ConnectionPoolInfo ConnectionPoolInfo Connection pool information of the proxy
Note: this field may return null, indicating that no valid value can be found.
ProxyNode Array of ProxyNodeInfo Node information of the proxy
Note: this field may return null, indicating that no valid value can be found.
RWInstInfo RWInfos Routing information of the proxy
Note: this field may return null, indicating that no valid value can be found.

ProxyNodeInfo

Node information of the proxy

Used by actions: DescribeCDBProxy, QueryCDBProxy.

Name Type Description
ProxyNodeId String Proxy node ID
Note: this field may return null, indicating that no valid value can be found.
ProxyNodeConnections Integer Current number of connections to the node
Note: this field may return null, indicating that no valid value can be found.
ProxyNodeCpu Integer CPU
Note: this field may return null, indicating that no valid value can be found.
ProxyNodeMem Integer Memory
Note: this field may return null, indicating that no valid value can be found.
ProxyStatus String Node status:
init (applying)
online (active)
offline (inactive)
destroy (destroyed)
recovering (recovering from fault)
error (failed)
Note: this field may return null, indicating that no valid value can be found.

RWInfo

Read/Write separation information of the proxy

Used by actions: DescribeCDBProxy.

Name Type Description
InstCount Integer Number of instances in the proxy group
Note: this field may return null, indicating that no valid value can be found.
WeightMode String Assignment mode of read/write weights
Valid values: system (auto-assigned), custom
Note: this field may return null, indicating that no valid value can be found.
IsKickOut Boolean Whether to remove delayed read-only instances from the proxy group
Note: this field may return null, indicating that no valid value can be found.
MinCount Integer The minimum number of read-only instances allowed by the proxy group
Note: this field may return null, indicating that no valid value can be found.
MaxDelay Integer Delay threshold
Note: this field may return null, indicating that no valid value can be found.
FailOver Boolean Whether to enable failover
Note: this field may return null, indicating that no valid value can be found.
AutoAddRo Boolean Whether to automatically add newly created read-only instances to the proxy group
Note: this field may return null, indicating that no valid value can be found.
RWInstInfo RWInstanceInfo Information of instances in the proxy group
Note: this field may return null, indicating that no valid value can be found.

RWInfos

Read/Write separation information of the proxy

Used by actions: QueryCDBProxy.

Name Type Description
InstCount Integer Number of instances in the proxy group
Note: this field may return null, indicating that no valid value can be found.
WeightMode String Assignment mode of read/write weights
Valid values: system (auto-assigned), custom
Note: this field may return null, indicating that no valid value can be found.
IsKickOut Boolean Whether to remove delayed read-only instances from the proxy group
Note: this field may return null, indicating that no valid value can be found.
MinCount Integer The minimum number of read-only instances allowed by the proxy group
Note: this field may return null, indicating that no valid value can be found.
MaxDelay Integer Delay threshold
Note: this field may return null, indicating that no valid value can be found.
FailOver Boolean Whether to enable failover
Note: this field may return null, indicating that no valid value can be found.
AutoAddRo Boolean Whether to automatically add newly created read-only instances to the proxy group
Note: this field may return null, indicating that no valid value can be found.
RWInstInfo Array of RWInstanceInfo Information of instances in the proxy group
Note: this field may return null, indicating that no valid value can be found.

RWInstanceInfo

Information of instances in the proxy group

Used by actions: DescribeCDBProxy, QueryCDBProxy.

Name Type Description

RegionSellConf

Sale configuration of the region

Used by actions: DescribeDBZoneConfig.

Name Type Description
RegionName String Region name
Area String Area
IsDefaultRegion Integer Whether it is a default region
Region String Region name
ZonesConf Array of ZoneSellConf Sale configuration of the AZ

ReleaseResult

Deisolation task result

Used by actions: ReleaseIsolatedDBInstances.

Name Type Description
InstanceId String Instance ID.
Code Integer Result value of instance deisolation. A returned value of 0 indicates success.
Message String Error message for instance deisolation.

RoGroup

Read-only group parameter

Used by actions: CreateDBInstanceHour, DescribeDBInstances, DescribeRoGroups.

Name Type Required Description
RoGroupMode String Yes Read-only group mode. Valid values: alone (the system assigns a read-only group automatically), allinone (a new read-only group will be created), join (an existing read-only group will be used).
RoGroupId String No Read-only group ID.
RoGroupName String No Read-only group name.
RoOfflineDelay Integer No Whether to enable the function of isolating an instance that exceeds the latency threshold. If it is enabled, when the latency between the read-only instance and the primary instance exceeds the latency threshold, the read-only instance will be isolated. Valid values: 1 (enabled), 0 (not enabled)
RoMaxDelayTime Integer No Latency threshold
MinRoInGroup Integer No Minimum number of instances to be retained. If the number of the purchased read-only instances is smaller than the set value, they will not be removed.
WeightMode String No Read/write weight distribution mode. Valid values: system (weights are assigned by the system automatically), custom (weights are customized)
Weight Integer No Weight value.
RoInstances Array of RoInstanceInfo No Details of read-only instances in read-only group
Vip String No Private IP of read-only group.
Vport Integer No Private network port number of read-only group.
UniqVpcId String No VPC ID.
Note: this field may return null, indicating that no valid values can be obtained.
UniqSubnetId String No Subnet ID.
Note: this field may return null, indicating that no valid values can be obtained.
RoGroupRegion String No Read-only group region.
Note: this field may return null, indicating that no valid values can be obtained.
RoGroupZone String No Read-only group AZ.
Note: this field may return null, indicating that no valid values can be obtained.
DelayReplicationTime Integer No Replication delay.
Note: this field may return null, indicating that no valid values can be obtained.

RoGroupAttr

RO group configuration information.

Used by actions: ModifyRoGroupInfo.

Name Type Required Description
RoGroupName String No RO group name.
RoMaxDelayTime Integer No Maximum delay threshold for RO instances in seconds. Minimum value: 1. Please note that this value will take effect only if an instance removal policy is enabled in the RO group.
RoOfflineDelay Integer No Whether to enable instance removal. Valid values: 1 (enabled), 0 (not enabled). Please note that if instance removal is enabled, the delay threshold parameter (RoMaxDelayTime) must be set.
MinRoInGroup Integer No Minimum number of instances to be retained, which can be set to any value less than or equal to the number of RO instances in the RO group. Please note that if this value is set to be greater than the number of RO instances, no removal will be performed, and if it is set to 0, all instances with an excessive delay will be removed.
WeightMode String No Weighting mode. Supported values include system (automatically assigned by the system) and custom (defined by user). Please note that if the custom mode is selected, the RO instance weight configuration parameter (RoWeightValues) must be set.
ReplicationDelayTime Integer No Replication delay.

RoInstanceInfo

RO instance details

Used by actions: CreateDBInstanceHour, DescribeRoGroups.

Name Type Description
MasterInstanceId String Master instance ID corresponding to the RO group
RoStatus String RO instance status in the RO group. Value range: online, offline
OfflineTime String Last deactivation time of a RO instance in the RO group
Weight Integer RO instance weight in the RO group
Region String RO instance region name, such as ap-shanghai
Zone String Name of RO AZ, such as ap-shanghai-1
InstanceId String RO instance ID in the format of cdbro-c1nl9rpv
Status Integer RO instance status. Valid values: 0 (creating), 1 (running), 3 (remote RO), 4 (deleting). When the DescribeDBInstances API is used to query the information of the source instance, if the source instance is associated with a remote read-only instance, the returned status value of the remote read-only instance always shows 3.
InstanceType Integer Instance type. Value range: 1 (primary), 2 (disaster recovery), 3 (read-only)
InstanceName String RO instance name
HourFeeStatus Integer Pay-as-you-go billing status. Value range: 1 (normal), 2 (in arrears)
TaskStatus Integer RO instance task status. Value range:
0 - no task
1 - upgrading
2 - importing data
3 - activating secondary
4 - public network access enabled
5 - batch operation in progress
6 - rolling back
7 - public network access not enabled
8 - modifying password
9 - renaming instance
10 - restarting
12 - migrating self-built instance
13 - dropping table
14 - creating and syncing disaster recovery instance
Memory Integer RO instance memory size in MB
Volume Integer RO instance disk size in GB
Qps Integer Queries per second
Vip String Private IP address of the RO instance
Vport Integer Access port of the RO instance
VpcId Integer VPC ID of the RO instance
SubnetId Integer VPC subnet ID of the RO instance
DeviceType String RO instance specification description. Value range: CUSTOM
EngineVersion String Database engine version of the read-only replica. Valid values: 5.1, 5.5, 5.6, 5.7, 8.0
DeadlineTime String RO instance expiration time in the format of yyyy-mm-dd hh:mm:ss. If it is a pay-as-you-go instance, the value of this field is 0000-00-00 00:00:00
PayType Integer RO instance billing method. Value range: 0 (monthly subscribed), 1 (pay-as-you-go), 2 (monthly postpaid)

RoVipInfo

VIP information of the read-only instance

Used by actions: DescribeDBInstances.

Name Type Description
RoVipStatus Integer VIP status of the read-only instance
RoSubnetId Integer VPC subnet of the read-only instance
RoVpcId Integer VPC of the read-only instance
RoVport Integer VIP port number of the read-only instance
RoVip String VIP of the read-only instance

RoWeight

Instance weight

Used by actions: ModifyCDBProxy.

Name Type Required Description

RoWeightValue

RO instance weight value

Used by actions: ModifyRoGroupInfo.

Name Type Required Description
InstanceId String Yes RO instance ID.
Weight Integer Yes Weight value. Value range: [0, 100].

RollbackDBName

Name of the database for rollback

Used by actions: DescribeRollbackTaskDetail, StartBatchRollback.

Name Type Required Description
DatabaseName String Yes Original database name before rollback
Note: this field may return null, indicating that no valid values can be obtained.
NewDatabaseName String Yes New database name after rollback
Note: this field may return null, indicating that no valid values can be obtained.

RollbackInstancesInfo

Details of the instance for rollback

Used by actions: DescribeRollbackTaskDetail, StartBatchRollback.

Name Type Required Description
InstanceId String Yes TencentDB instance ID
Note: this field may return null, indicating that no valid values can be obtained.
Strategy String Yes Rollback policy. Valid values: table (ultrafast mode), db (faster mode), and full (fast mode). Default value: full. In the ultrafast mode, only backups and binlogs of the tables specified by the Tables parameter are imported; if Tables does not include all of the tables involved in cross-table operations, the rollback may fail; and the Database parameter must be left empty. In the faster mode, only backups and binlogs of the databases specified by the Databases parameter are imported, and if Databases does not include all of the databases involved in cross-database operations, the rollback may fail. In the fast mode, backups and binlogs of the entire instance will be imported in a speed slower than the other modes.
RollbackTime String Yes Database rollback time in the format of yyyy-mm-dd hh:mm:ss
Databases Array of RollbackDBName No Information of the databases to be rolled back, which means rollback at the database level
Note: this field may return null, indicating that no valid values can be obtained.
Tables Array of RollbackTables No Information of the tables to be rolled back, which means rollback at the table level
Note: this field may return null, indicating that no valid values can be obtained.

RollbackTableName

Name of the table for rollback

Used by actions: DescribeRollbackTaskDetail, StartBatchRollback.

Name Type Required Description
TableName String Yes Original table name before rollback
Note: this field may return null, indicating that no valid values can be obtained.
NewTableName String Yes New table name after rollback
Note: this field may return null, indicating that no valid values can be obtained.

RollbackTables

Details of the table for rollback

Used by actions: DescribeRollbackTaskDetail, StartBatchRollback.

Name Type Required Description
Database String Yes Database name
Note: this field may return null, indicating that no valid values can be obtained.
Table Array of RollbackTableName Yes Table details
Note: this field may return null, indicating that no valid values can be obtained.

RollbackTask

Rollback task details

Used by actions: DescribeRollbackTaskDetail.

Name Type Description
Info String Task execution information.
Status String Task execution result. Valid values: INITIAL: initializing, RUNNING: running, SUCCESS: succeeded, FAILED: failed, KILLED: terminated, REMOVED: deleted, PAUSED: paused.
Progress Integer Task execution progress. Value range: [0,100].
StartTime String Task start time.
EndTime String Task end time.
Detail Array of RollbackInstancesInfo Rollback task details.
Note: this field may return null, indicating that no valid values can be obtained.

RollbackTimeRange

Time range available for rollback

Used by actions: DescribeRollbackRangeTime.

Name Type Description
Begin String Start time available for rollback in the format of yyyy-MM-dd HH:mm:ss, such as 2016-10-29 01:06:04
End String End time available for rollback in the format of yyyy-MM-dd HH:mm:ss, such as 2016-11-02 11:44:47

Rule

Weight rule

Used by actions: DescribeProxyCustomConf.

Name Type Description
LessThan Integer The maximum weight
Note: this field may return null, indicating that no valid value can be found.
Weight Integer Weight
Note: this field may return null, indicating that no valid value can be found.

SecurityGroup

Security group details

Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

Name Type Description
ProjectId Integer Project ID
CreateTime String Creation time in the format of yyyy-mm-dd hh:mm:ss
Inbound Array of Inbound Inbound rule
Outbound Array of Outbound Outbound rule
SecurityGroupId String Security group ID
SecurityGroupName String Security group name
SecurityGroupRemark String Security group remarks

SellConfig

Purchasable configuration details

Used by actions: DescribeDBZoneConfig.

Name Type Description
Device String (Disused) Device type
Type String (Disused) Purchasable specification description
CdbType String (Disused) Instance type
Memory Integer Memory size in MB
Cpu Integer CPU core count
VolumeMin Integer Minimum disk size in GB
VolumeMax Integer Maximum disk size in GB
VolumeStep Integer Disk increment in GB
Connection Integer Number of connections
Qps Integer Queries per second
Iops Integer IOs per second
Info String Application scenario description
Status Integer Status. Value 0 indicates that this specification is purchasable.
Tag Integer (Disused) Tag value
DeviceType String Instance resource isolation type. Valid values: UNIVERSAL (general instance), EXCLUSIVE (dedicated instance), BASIC (basic instance).
Note: null may be returned for this field, indicating that no valid values can be obtained.
DeviceTypeName String Instance resource isolation type. Valid values: UNIVERSAL (general instance), EXCLUSIVE (dedicated instance), BASIC (basic instance).
Note: null may be returned for this field, indicating that no valid values can be obtained.
EngineType String Engine type. Valid values: Innodb,RocksDB.
Note: This field may return null, indicating that no valid value can be obtained.

SellType

Purchasable instance type

Used by actions: DescribeDBZoneConfig.

Name Type Description
TypeName String Name of the purchasable instance
EngineVersion Array of String Kernel version number
Configs Array of SellConfig Configuration details of a purchasable specification

SlaveConfig

Configuration information of the salve database

Used by actions: DescribeDBInstanceConfig.

Name Type Description
ReplicationMode String Replication mode of the secondary database. Value range: async, semi-sync
Zone String AZ name of the secondary database, such as ap-shanghai-1

SlaveInfo

Slave server information

Used by actions: DescribeDBInstances.

Name Type Description
First SlaveInstanceInfo Information of secondary server 1
Second SlaveInstanceInfo Information of secondary server 2
Note: This field may return null, indicating that no valid values can be obtained.

SlaveInstanceInfo

Slave server information

Used by actions: DescribeDBInstances.

Name Type Description
Vport Integer Port number
Region String Region information
Vip String Virtual IP information
Zone String AZ information

SlowLogInfo

Slow log details

Used by actions: DescribeSlowLogs.

Name Type Description
Name String Backup filename
Size Integer Backup file size in bytes
Date String Backup snapshot time in the format of yyyy-MM-dd HH:mm:ss, such as 2016-03-17 02:10:37
IntranetUrl String Download address on the private network
InternetUrl String Download address on the public network
Type String Log type. Value range: slowlog (slow log)

SlowLogItem

Structured slow log details

Used by actions: DescribeSlowLogData.

Name Type Description
Timestamp Integer SQL execution time.
Note: this field may return null, indicating that no valid values can be obtained.
QueryTime Float SQL execution duration in seconds.
Note: this field may return null, indicating that no valid values can be obtained.
SqlText String SQL statement.
Note: this field may return null, indicating that no valid values can be obtained.
UserHost String Client address.
Note: this field may return null, indicating that no valid values can be obtained.
UserName String Username.
Note: this field may return null, indicating that no valid values can be obtained.
Database String Database name.
Note: this field may return null, indicating that no valid values can be obtained.
LockTime Float Lock duration in seconds.
Note: this field may return null, indicating that no valid values can be obtained.
RowsExamined Integer Number of scanned rows.
Note: this field may return null, indicating that no valid values can be obtained.
RowsSent Integer Number of rows in result set.
Note: this field may return null, indicating that no valid values can be obtained.
SqlTemplate String SQL template.
Note: this field may return null, indicating that no valid values can be obtained.
Md5 String SQL statement MD5.
Note: this field may return null, indicating that no valid values can be obtained.

SqlFileInfo

SQL file information

Used by actions: DescribeUploadedFiles.

Name Type Description
UploadTime Timestamp Upload time
UploadInfo UploadInfo Upload progress
FileName String Filename
FileSize Integer File size in bytes
IsUploadFinished Integer Whether upload is finished. Valid values: 0 (not completed), 1 (completed)
FileId String File ID

TablePrivilege

Table permission

Used by actions: DescribeAccountPrivileges, ModifyAccountPrivileges.

Name Type Required Description
Database String Yes Database name
Table String Yes Table name
Privileges Array of String Yes Permission information

Tag

Tag structure

Used by actions: DescribeDBInstances.

Name Type Required Description
Key String Yes Tag key
Value String Yes Tag value

TagInfo

Tag information

Used by actions: CreateCloneInstance, CreateDBInstanceHour, ModifyInstanceTag.

Name Type Description
TagKey String Tag key
TagValue Array of String Tag value

TagInfoItem

Tag information

Used by actions: DescribeDBInstances.

Name Type Description
TagKey String Tag key
Note: this field may return null, indicating that no valid values can be obtained.
TagValue String Tag value
Note: this field may return null, indicating that no valid values can be obtained.

TagInfoUnit

Tag information unit

Used by actions: DescribeTagsOfInstanceIds.

Name Type Description
TagKey String Tag key
TagValue String Tag value

TagsInfoOfInstance

Instance tag information

Used by actions: DescribeTagsOfInstanceIds.

Name Type Description
InstanceId String Instance ID
Tags Array of TagInfoUnit Tag information

TaskDetail

Details of an instance task

Used by actions: DescribeTasks.

Name Type Description
Code Integer Error code.
Message String Error message.
JobId Integer ID of an instance task.
Progress Integer Instance task progress.
TaskStatus String Instance task status. Valid values:
"UNDEFINED" - undefined;
"INITIAL" - initializing;
"RUNNING" - running;
"SUCCEED" - succeeded;
"FAILED" - failed;
"KILLED" - terminated;
"REMOVED" - deleted;
"PAUSED" - paused.
"WAITING" - waiting (which can be canceled)
TaskType String Instance task type. Valid values:
"ROLLBACK" - rolling back a database;
"SQL OPERATION" - performing an SQL operation;
"IMPORT DATA" - importing data;
"MODIFY PARAM" - setting a parameter;
"INITIAL" - initializing a TencentDB instance;
"REBOOT" - restarting a TencentDB instance;
"OPEN GTID" - enabling GTID of a TencentDB instance;
"UPGRADE RO" - upgrading a read-only instance;
"BATCH ROLLBACK" - rolling back databases in batches;
"UPGRADE MASTER" - upgrading a primary instance;
"DROP TABLES" - dropping a TencentDB table;
"SWITCH DR TO MASTER" - promoting a disaster recovery instance.
StartTime String Instance task start time.
EndTime String Instance task end time.
InstanceIds Array of String ID of an instance associated with a task.
Note: This field may return null, indicating that no valid values can be obtained.
AsyncRequestId String Async task request ID.

UploadInfo

File upload description

Used by actions: DescribeUploadedFiles.

Name Type Description
AllSliceNum Integer Number of parts of file
CompleteNum Integer Number of completed parts

ZoneConf

Multi-AZ information

Used by actions: DescribeDBZoneConfig.

Name Type Required Description
DeployMode Array of Integer Yes AZ deployment mode. Value range: 0 (single-AZ), 1 (multi-AZ)
MasterZone Array of String Yes AZ where the primary instance is located
SlaveZone Array of String Yes AZ where salve database 1 is located when the instance is deployed in multi-AZ mode
BackupZone Array of String Yes AZ where salve database 2 is located when the instance is deployed in multi-AZ mode

ZoneSellConf

AZ sale configurations

Used by actions: DescribeDBZoneConfig.

Name Type Description
Status Integer AZ status used to indicate whether instances are purchasable. Value range: 1 (purchasable), 3 (not purchasable), 4 (AZ not displayed)
ZoneName String AZ name
IsCustom Boolean Whether it is a custom instance type
IsSupportDr Boolean Whether disaster recovery is supported
IsSupportVpc Boolean Whether VPC is supported
HourInstanceSaleMaxNum Integer Maximum purchasable quantity of hourly billed instances
IsDefaultZone Boolean Whether it is a default AZ
IsBm Boolean Whether it is a BM zone
PayType Array of String Supported billing method. Value range: 0 (monthly subscribed), 1 (hourly), 2 (postpaid)
ProtectMode Array of String Data replication type. Value range: 0 (async), 1 (semi-sync), 2 (strong sync)
Zone String AZ name
SellType Array of SellType Array of purchasable instance types
ZoneConf ZoneConf Multi-AZ information
DrZone Array of String Information of the supported disaster recovery AZ
IsSupportRemoteRo Boolean Whether cross-AZ read-only access is supported
RemoteRoZone Array of String Information of supported cross-AZ read-only zone
Note: this field may return null, indicating that no valid values can be obtained.
ExClusterStatus Integer AZ status used to indicate whether dedicated instances are purchasable. Valid values: 1 (purchasable), 3(not purchasable),4` (AZ not displayed)
ExClusterRemoteRoZone Array of String AZ information of the cross-AZ deployed read-only instances which are associated with a dedicated instance
Note: This field may return null, indicating that no valid values can be obtained.
ExClusterZoneConf ZoneConf AZ information of a multi-AZ deployed dedicated instance.
Note: This field may return null, indicating that no valid values can be obtained.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support