History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
TencentDB account information
Used by actions: ModifyAccountPrivileges.
| Name | Type | Required | Description |
|---|---|---|---|
| User | String | Yes | Account name |
| Host | String | Yes | Host address |
Instance upgrade -- Adding shard
Used by actions: UpgradeDedicatedDCDBInstance, UpgradeHourDCDBInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| ShardCount | Integer | Yes | The number of shards to be added |
| ShardMemory | Integer | Yes | Shard memory capacity in GB |
| ShardStorage | Integer | Yes | Shard storage capacity in GB |
Node information of a sharded database
Used by actions: DescribeDCDBInstanceNodeInfo.
| Name | Type | Description |
|---|---|---|
| NodeId | String | Node ID |
| Role | String | Node role. Valid values: master, slave |
| ShardId | String | The ID of the shard where the node resides |
Column permission information
Used by actions: 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 |
Configuration information, which contains Config and Value.
Used by actions: ModifyAccountConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| Config | String | Yes | Configuration name, which supports max_user_connections. |
| Value | String | Yes | Configuration value |
Range of constraint type values
Used by actions: DescribeDBParameters.
| Name | Type | Description |
|---|---|---|
| Min | String | Minimum value when the constraint type is section |
| Max | String | Maximum value when the constraint type is section |
TencentDB account information
Used by actions: DescribeAccounts.
| Name | Type | Description |
|---|---|---|
| UserName | String | Username |
| Host | String | Host from which a user can log in (corresponding to the host field for a MySQL user; a user is uniquely identified by username and host; this parameter is in IP format and ends with % for IP range; % can be entered; if this parameter is left empty, % will be used by default). |
| Description | String | User remarks |
| CreateTime | Timestamp | Creation time |
| UpdateTime | Timestamp | Last updated time |
| ReadOnly | Integer | Read-only flag. 0: no; 1: for the account's SQL requests, the replica will be used first, and if it is unavailable, the source will be used; 2: the replica will be used first, and if it is unavailable, the operation will fail. |
| DelayThresh | Integer | If the replica delay exceeds the set value of this parameter, the replica will be considered to have failed. Set this parameter to a value above 10. This parameter takes effect when ReadOnly is 1 or 2. |
| SlaveConst | Integer | Whether to specify a replica server for read-only account. Valid values: 0 (No replica server is specified, which means that the proxy will select another available replica server to keep connection with the client if the current replica server doesn’t meet the requirement). 1 (The replica server is specified, which means that the connection will be disconnected if the specified replica server doesn’t meet the requirement.) |
| MaxUserConnections | Integer | Maximum number of connections. 0 indicates no limit. |
TencentDB parameter information.
Used by actions: CreateDCDBInstance, CreateDedicatedClusterDCDBInstance, CreateHourDCDBInstance, InitDCDBInstances, ModifyDBParameters.
| Name | Type | Required | Description |
|---|---|---|---|
| Param | String | Yes | Parameter name |
| Value | String | Yes | Parameter value |
TDSQL instance information
Used by actions: DescribeDCDBInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| AppId | Integer | Application ID |
| ProjectId | Integer | Project ID |
| Region | String | Region |
| Zone | String | AZ |
| VpcId | Integer | Numeric ID of a VPC |
| SubnetId | Integer | Subnet Digital ID |
| StatusDesc | String | Status description |
| Status | Integer | Instance status. Valid values: 0 (creating), 1 (running task), 2 (running), 3 (uninitialized), -1 (isolated), 4 (initializing), 5 (eliminating), 6 (restarting), 7 (migrating data) |
| Vip | String | Private IP |
| Vport | Integer | Private network port |
| CreateTime | Timestamp | Creation time |
| AutoRenewFlag | Integer | Auto-renewal flag |
| Memory | Integer | Memory size in GB |
| Storage | Integer | Storage capacity in GB |
| ShardCount | Integer | Number of shards |
| PeriodEndTime | Timestamp | Expiration time |
| IsolatedTimestamp | Timestamp | Isolation time |
| Uin | String | Account ID |
| ShardDetail | Array of ShardInfo | Shard details |
| NodeCount | Integer | Number of nodes. 2: one master and one slave; 3: one master and two slaves |
| IsTmp | Integer | Temporary instance flag. 0: non-temporary instance |
| ExclusterId | String | Dedicated cluster ID. If this parameter is empty, the instance is a non-dedicated cluster instance |
| UniqueVpcId | String | VPC ID in string type |
| UniqueSubnetId | String | VPC subnet ID in string type |
| Id | Integer | Numeric ID of instance (this field is obsolete and should not be depended on) |
| WanDomain | String | Domain name for public network access, which can be resolved by the public network |
| WanVip | String | Public IP address, which can be accessed over the public network |
| WanPort | Integer | Public network port |
| Pid | Integer | Product type ID (this field is obsolete and should not be depended on) |
| UpdateTime | Timestamp | Last updated time of an instance in the format of 2006-01-02 15:04:05 |
| DbEngine | String | Database engine |
| DbVersion | String | Database engine version |
| Paymode | String | Billing mode |
| Locker | Integer | Async task flow ID when an async task is in progress on an instance Note: this field may return null, indicating that no valid values can be obtained. |
| WanStatus | Integer | Public network access status. 0: not enabled; 1: enabled; 2: disabled; 3: enabling |
| IsAuditSupported | Integer | Whether the instance supports audit. 1: yes; 0: no |
| Cpu | Integer | Number of CPU cores |
| Ipv6Flag | Integer | Indicates whether the instance uses IPv6 Note: this field may return null, indicating that no valid values can be obtained. |
| Vipv6 | String | Private network IPv6 address Note: this field may return null, indicating that no valid values can be obtained. |
| WanVipv6 | String | Public network IPv6 address Note: this field may return null, indicating that no valid values can be obtained. |
| WanPortIpv6 | Integer | Public network IPv6 port Note: this field may return null, indicating that no valid values can be obtained. |
| WanStatusIpv6 | Integer | Public network IPv6 status Note: this field may return null, indicating that no valid values can be obtained. |
| DcnFlag | Integer | DCN type. Valid values: 0 (null), 1 (primary instance), 2 (disaster recovery instance) Note: this field may return null, indicating that no valid values can be obtained. |
| DcnStatus | Integer | DCN status. Valid values: 0 (null), 1 (creating), 2 (syncing), 3 (disconnected) Note: this field may return null, indicating that no valid values can be obtained. |
| DcnDstNum | Integer | The number of DCN disaster recovery instances Note: this field may return null, indicating that no valid values can be obtained. |
| InstanceType | Integer | Instance type. Valid values: 1 (dedicated primary instance), 2 (standard primary instance), 3 (standard disaster recovery instance), 4 (dedicated disaster recovery instance)Note: this field may return null, indicating that no valid values can be obtained. |
| ResourceTags | Array of ResourceTag | Instance tag information Note: this field may return null, indicating that no valid values can be obtained. |
| DbVersionId | String | Database engine version Note: This field may return null, indicating that no valid values can be obtained. |
TDSQL shard information.
Used by actions: DescribeDCDBShards.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| ShardSerialId | String | Shard SQL passthrough ID, which is used to pass through SQL statements to the specified shard for execution. |
| ShardInstanceId | String | Globally unique shard ID |
| Status | Integer | Status. 0: creating; 1: processing; 2: running; 3: shard not initialized. |
| StatusDesc | String | Status description |
| CreateTime | Timestamp | Creation time |
| VpcId | String | VPC ID in string format |
| SubnetId | String | VPC subnet ID in string format |
| ProjectId | Integer | Project ID |
| Region | String | Region |
| Zone | String | AZ |
| Memory | Integer | Memory size in GB |
| Storage | Integer | Storage capacity in GB |
| PeriodEndTime | Timestamp | Expiration time |
| NodeCount | Integer | Number of nodes. 2: one source and one replica; 3: one source and two replicas |
| StorageUsage | Float | Storage utilization in % |
| MemoryUsage | Float | Memory utilization in % |
| ShardId | Integer | Numeric shard ID (this field is obsolete and should not be depended on) |
| Pid | Integer | Product ID |
| ProxyVersion | String | Proxy version |
| Paymode | String | Billing mode Note: This field may return null, indicating that no valid values can be obtained. |
| ShardMasterZone | String | Source AZ of the shard Note: This field may return null, indicating that no valid values can be obtained. |
| ShardSlaveZones | Array of String | List of replica AZs of the shard Note: This field may return null, indicating that no valid values can be obtained. |
| Cpu | Integer | Number of CPU cores |
| Range | String | The value range of shardkey, which includes 64 hash values, such as 0-31 or 32-63. |
Database information
Used by actions: DescribeDatabases.
| Name | Type | Description |
|---|---|---|
| DbName | String | Database name |
Database function information
Used by actions: DescribeDatabaseObjects.
| Name | Type | Description |
|---|---|---|
| Func | String | Function name |
Database permission
Used by actions: ModifyAccountPrivileges.
| Name | Type | Required | Description |
|---|---|---|---|
| Privileges | Array of String | Yes | Permission information |
| Database | String | Yes | Database name |
Database stored procedure information
Used by actions: DescribeDatabaseObjects.
| Name | Type | Description |
|---|---|---|
| Proc | String | Stored procedure name |
Database table information
Used by actions: DescribeDatabaseObjects.
| Name | Type | Description |
|---|---|---|
| Table | String | Table name |
Database view information
Used by actions: DescribeDatabaseObjects.
| Name | Type | Description |
|---|---|---|
| View | String | View name |
DCN details
Used by actions: DescribeDcnDetail.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| Region | String | Region where the instance resides |
| Zone | String | Availability zone where the instance resides |
| Vip | String | Instance IP address |
| Vipv6 | String | Instance IPv6 address |
| Vport | Integer | Instance port |
| Status | Integer | Instance status |
| StatusDesc | String | Instance status description |
| DcnFlag | Integer | DCN flag. Valid values: 1 (primary), 2 (disaster recovery) |
| DcnStatus | Integer | DCN status. Valid values: 0 (none), 1 (creating), 2 (syncing), 3 (disconnected) |
| Cpu | Integer | Number of CPU cores of the instance |
| Memory | Integer | Instance memory capacity in GB |
| Storage | Integer | Instance storage capacity in GB |
| PayMode | Integer | Billing mode |
| CreateTime | String | Creation time of the instance in the format of 2006-01-02 15:04:05 |
| PeriodEndTime | String | Expiration time of the instance in the format of 2006-01-02 15:04:05 |
| InstanceType | Integer | Instance type. Valid values: 1 (dedicated primary instance), 2 (non-dedicated primary instance), 3 (non-dedicated disaster recovery instance), and 4 (dedicated disaster recovery instance). |
| EncryptStatus | Integer | Whether KMS is enabled. |
Order information
Used by actions: DescribeOrders.
| Name | Type | Description |
|---|---|---|
| DealName | String | Order ID. |
| OwnerUin | String | Account |
| Count | Integer | Number of items |
| FlowId | Integer | The associated process ID, which can be used to query the process execution status. |
| InstanceIds | Array of String | The ID of the created instance, which is required only for the order that creates an instance. Note: This field may return null, indicating that no valid values can be obtained. |
| PayMode | Integer | Billing mode. Valid values: 0 (postpaid), 1 (prepaid). |
Instance upgrade -- Expanding shard
Used by actions: UpgradeDedicatedDCDBInstance, UpgradeHourDCDBInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| ShardInstanceIds | Array of String | Yes | Shard IDs in array |
| ShardMemory | Integer | Yes | Shard memory capacity in GB |
| ShardStorage | Integer | Yes | Shard storage capacity in GB |
| ShardNodeCount | Integer | No | Number of shard nodes |
Backup file details of an instance
Used by actions: DescribeBackupFiles.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| InstanceStatus | Integer | Instance status |
| ShardId | String | Shard ID |
| FilePath | String | File path |
| FileName | String | File name |
| FileSize | Integer | File size |
| BackupType | String | Backup type. Valid values: Data (data backup), Binlog (Binlog backup), Errlog (error log), Slowlog (slow log). |
| ManualBackup | Integer | Manual backup. Valid values: 0 (no), 1 (yes). |
| StartTime | String | Backup start time |
| EndTime | String | Backup end time |
Information of a pulled log
Used by actions: DescribeDBLogFiles.
| Name | Type | Description |
|---|---|---|
| Mtime | Integer | Last modified time of a log |
| Length | Integer | File length |
| Uri | String | Uniform resource identifier (URI) used during log download |
| FileName | String | Filename |
Node information description
Used by actions: DescribeDCDBInstanceDetail.
| Name | Type | Description |
|---|---|---|
| NodeId | String | Node ID |
| Role | String | Node role. Valid values: master, slave. |
Parameter constraint
Used by actions: DescribeDBParameters.
| Name | Type | Description |
|---|---|---|
| Type | String | Constraint type, such as enum and section |
| Enum | String | List of valid values when constraint type is enum |
| Range | ConstraintRange | Range when constraint type is sectionNote: This field may return null, indicating that no valid values can be obtained. |
| String | String | List of valid values when constraint type is string |
Database parameter description
Used by actions: DescribeDBParameters.
| Name | Type | Description |
|---|---|---|
| Param | String | Parameter name |
| Value | String | Current parameter value |
| SetValue | String | Previously set value, which is the same as value after the parameter takes effect. If no value has been set, this field will not be returned.Note: This field may return null, indicating that no valid values can be obtained. |
| Default | String | Default value |
| Constraint | ParamConstraint | Parameter constraint |
| HaveSetValue | Boolean | Whether a value has been set. false: no, true: yes. |
| NeedRestart | Boolean | Whether restart is required. false: no; true: yes. |
Parameter modification result
Used by actions: ModifyDBParameters.
| Name | Type | Description |
|---|---|---|
| Param | String | Renames parameter |
| Code | Integer | Result of parameter modification. 0: success; -1: failure; -2: invalid parameter value |
Information of the reserved network resource
Used by actions: DescribeDCDBInstanceDetail.
| Name | Type | Description |
|---|---|---|
| VpcId | String | VPC |
| SubnetId | String | Subnet |
| Vip | String | Reserved private network IP under VpcId and SubnetId |
| Vports | Array of Integer | Port under Vip |
| RecycleTime | String | Valid hours of VIP |
Tag object, including tag key and tag value
Used by actions: CreateDCDBInstance, CreateDedicatedClusterDCDBInstance, CreateHourDCDBInstance, DescribeDCDBInstanceDetail, DescribeDCDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
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 |
| SecurityGroupId | String | Security group ID |
| SecurityGroupName | String | Security group name |
| SecurityGroupRemark | String | Security group remarks |
| Inbound | Array of SecurityGroupBound | Inbound rule |
| Outbound | Array of SecurityGroupBound | Outbound rule |
Security group inbound/outbound rule
Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.
| Name | Type | Description |
|---|---|---|
| Action | String | Policy, which can be ACCEPT or DROP |
| CidrIp | String | Source IP or source IP range, such as 192.168.0.0/16 |
| PortRange | String | Port |
| IpProtocol | String | Network protocol. UDP and TCP are supported. |
TDSQL shard information
Used by actions: DescribeDCDBInstanceDetail.
| Name | Type | Description |
|---|---|---|
| ShardSerialId | String | Shard serial ID |
| ShardInstanceId | String | Shard ID, such as shard-7vg1o339. |
| Status | Integer | Shard running status |
| StatusDesc | String | Description of shard running status |
| CreateTime | Timestamp | Shard creation time |
| Memory | Integer | Shard memory size in GB |
| Storage | Integer | Shard disk size in GB |
| LogDisk | Integer | Log disk space size of a shard in GB |
| NodeCount | Integer | Number of shard nodes |
| StorageUsage | Float | Disk space utilization of a shard |
| ProxyVersion | String | Version information of the shard proxy |
| ShardMasterZone | String | Source AZ of a shard |
| ShardSlaveZones | Array of String | Replica AZ of a shard |
| Cpu | Integer | Number of CPU cores |
| NodesInfo | Array of NodeInfo | Node information Note: This field may return null, indicating that no valid values can be obtained. |
Shard information
Used by actions: DescribeDCDBInstances.
| Name | Type | Description |
|---|---|---|
| ShardInstanceId | String | Shard ID |
| ShardSerialId | String | Shard set ID |
| Status | Integer | Status. 0: creating; 1: processing; 2: running; 3: shard not initialized; -2: shard deleted |
| Createtime | String | Creation time |
| Memory | Integer | Memory size in GB |
| Storage | Integer | Storage capacity in GB |
| ShardId | Integer | Numeric ID of a shard |
| NodeCount | Integer | Number of nodes. 2: one primary and one secondary; 3: one primary and two secondaries |
| Pid | Integer | Product type ID (this field is obsolete and should not be depended on) |
| Cpu | Integer | Number of CPU cores |
Information of a slow query that has been logged
Used by actions: DescribeDBSlowLogs.
| Name | Type | Description |
|---|---|---|
| CheckSum | String | Statement checksum for querying details |
| Db | String | Database name |
| FingerPrint | String | Abstracted SQL statement |
| LockTimeAvg | String | Average lock duration |
| LockTimeMax | String | Maximum lock duration |
| LockTimeMin | String | Minimum lock duration |
| LockTimeSum | String | Sum of lock durations |
| QueryCount | String | Number of queries |
| QueryTimeAvg | String | Average query duration |
| QueryTimeMax | String | Maximum query duration |
| QueryTimeMin | String | Minimum query duration |
| QueryTimeSum | String | Sum of query durations |
| RowsExaminedSum | String | Number of scanned rows |
| RowsSentSum | String | Number of sent rows |
| TsMax | String | Last execution time |
| TsMin | String | First execution time |
| User | String | Account |
| ExampleSql | String | Sample SQL Note: This field may return null, indicating that no valid values can be obtained. |
| Host | String | Host address of account Note: This field may return null, indicating that no valid values can be obtained. |
Instance upgrade -- Sharding
Used by actions: UpgradeDedicatedDCDBInstance, UpgradeHourDCDBInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| ShardInstanceIds | Array of String | Yes | Shard IDs in array |
| SplitRate | Integer | Yes | Data split ratio at 50% (fixed) |
| ShardMemory | Integer | Yes | Shard memory capacity in GB |
| ShardStorage | Integer | Yes | Shard storage capacity in GB |
Database column information
Used by actions: DescribeDatabaseTable.
| Name | Type | Description |
|---|---|---|
| Col | String | Column name |
| Type | String | Column type |
Table permission
Used by actions: ModifyAccountPrivileges.
| Name | Type | Required | Description |
|---|---|---|---|
| Database | String | Yes | Database name |
| Table | String | Yes | Table name |
| Privileges | Array of String | Yes | Permission information |
Temp instance
Used by actions: DescribeDBTmpInstances.
| Name | Type | Description |
|---|---|---|
| AppId | Integer | Application ID Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | Timestamp | Creation time Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceRemark | String | Instance remarks Note: This field may return null, indicating that no valid values can be obtained. |
| TempType | Integer | Type of temp instance. Valid values: 0 (non-temp instance), 1 (invalid temp instance), 2 (valid rollback temp instance).Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (running), -1 (isolated), -2 (eliminated).Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceId | String | Instance ID in the format of tdsql-ow728lmcNote: This field may return null, indicating that no valid values can be obtained. |
| Vip | String | Virtual instance IP Note: This field may return null, indicating that no valid values can be obtained. |
| Vport | Integer | Virtual instance port Note: This field may return null, indicating that no valid values can be obtained. |
| PeriodEndTime | Timestamp | Validity end time Note: This field may return null, indicating that no valid values can be obtained. |
| SrcInstanceId | String | Source instance ID in the format of tdsql-ow728lmcNote: This field may return null, indicating that no valid values can be obtained. |
| StatusDesc | String | Instance status description Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | Instance region Note: This field may return null, indicating that no valid values can be obtained. |
| Zone | String | AZ of the instance Note: This field may return null, indicating that no valid values can be obtained. |
| Vipv6 | String | Virtual IPv6 of the instance Note: This field may return null, indicating that no valid values can be obtained. |
| Ipv6Flag | Integer | Instance IPv6 flag Note: This field may return null, indicating that no valid values can be obtained. |
View permission information
Used by actions: ModifyAccountPrivileges.
| Name | Type | Required | Description |
|---|---|---|---|
| Database | String | Yes | Database name |
| View | String | Yes | View name |
| Privileges | Array of String | Yes | Permission information |
피드백