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: CreateAccounts, CreateRotationPassword, DeleteAccounts, ModifyAccountDescription, ModifyAccountMaxUserConnections, ModifyAccountPassword, ModifyAccountPrivileges.
| Name | Type | Required | Description |
|---|---|---|---|
| User | String | Yes | New account name |
| Host | String | Yes | New account domain name |
Account details
Used by actions: DescribeAccounts.
| Name | Type | Description |
|---|---|---|
| Notes | String | Account remarks |
| Host | String | Account domain name |
| User | String | Account name |
| ModifyTime | Timestamp | Account information modification time |
| ModifyPasswordTime | Timestamp | Password modification time |
| CreateTime | Timestamp | This parameter is deprecated. |
| MaxUserConnections | Integer | The maximum number of instance connections supported by an account |
Aggregation condition for an audit log
Used by actions: AnalyzeAuditLogs.
| Name | Type | Required | Description |
|---|---|---|---|
| AggregationField | String | Yes | Aggregation field. Valid values: host (source IP), user （username), dbName (database name), sqlType (SQL type). |
| Offset | Integer | No | Offset |
| Limit | Integer | No | Number of buckets returned under this field. Maximum value: 100. |
Analysis engine node information.
Used by actions: DescribeDBInstances.
| Name | Type | Description |
|---|---|---|
| NodeId | String | Node ID. |
| Status | String | Node status. |
| DataStatus | String | Data loading status. |
| Cpu | Integer | Number of CPU cores, in cores. |
| Memory | Integer | Memory size, in MB. |
| Storage | Integer | Disk size, in GB. |
| Zone | String | Node AZ. |
| Message | String | Data synchronization error message. |
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 |
Filter conditions for querying audit instances.
Used by actions: DescribeAuditInstanceList.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Filter condition name. Valid values: InstanceId - Instance ID, InstanceName - Instance name, ProjectId - Project ID, TagKey - Tag key, Tag - Tag (using a vertical bar as separator, for example: TagKey |
| ExactMatch | Boolean | Yes | true indicates exact matching; false indicates fuzzy matching. |
| Values | Array of String | Yes | Filter value. |
Audit instance details.
Used by actions: DescribeAuditInstanceList.
| Name | Type | Description |
|---|---|---|
| ProjectId | Integer | Project ID. |
| TagList | Array of TagInfoUnit | Tag information. |
| DbType | String | Database kernel type. |
| DbVersion | String | Database kernel version. |
Audit log details
Used by actions: DescribeAuditLogs.
| Name | Type | Description |
|---|---|---|
| AffectRows | Integer | Number of affected rows |
| ErrCode | Integer | The error code |
| SqlType | String | SQL Type. |
| PolicyName | String | Audit policy name, which will be unavailable soon. |
| DBName | String | Database Name. |
| Sql | String | SQL Statement. |
| Host | String | Client address |
| User | String | Username |
| ExecTime | Integer | Execution time (μs) |
| Timestamp | String | Time |
| SentRows | Integer | Number of returned rows |
| ThreadId | Integer | Thread ID |
| CheckRows | Integer | Number of scanned rows Note: This field may return null, indicating that no valid values can be obtained. |
| CpuTime | Float | CPU execution time (μs) Note: This field may return null, indicating that no valid values can be obtained. |
| IoWaitTime | Integer | IO wait time (μs) Note: This field may return null, indicating that no valid values can be obtained. |
| LockWaitTime | Integer | Lock wait time (μs) Note: This field may return null, indicating that no valid values can be obtained. |
| NsTime | Integer | Start time, which forms a time accurate to nanoseconds with·timestamp.Note: This field may return null, indicating that no valid values can be obtained. |
| TrxLivingTime | Integer | Transaction duration (μs) Note: This field may return null, indicating that no valid values can be obtained. |
| TemplateInfo | Array of LogRuleTemplateInfo | Basic information on the rule template hit by the log. Note: The return value may be null, indicating that no valid data can be obtained. |
Analysis result of an audit log
Used by actions: AnalyzeAuditLogs.
| Name | Type | Description |
|---|---|---|
| AggregationField | String | Aggregation dimension Note: This field may return null, indicating that no valid values can be obtained. |
| Buckets | Array of Bucket | Result set of an aggregation bucket Note: This field may return null, indicating that no valid values can be obtained. |
Audit log file.
Used by actions: DescribeAuditLogFiles.
| Name | Type | Description |
|---|---|---|
| FileName | String | Audit log file name. |
| CreateTime | String | Creation time of the audit log file, in the format: "2019-03-20 17:09:13". |
| Status | String | File status. Possible return values:"creating" - Generating;"failed" - Creation failed;"success" - Generated. |
| FileSize | Integer | File size in KB. |
| DownloadUrl | String | Download URL for the audit log. |
| ErrMsg | String | Error message. |
Filter condition for an audit log, which is used by users to filter the returned audit logs when querying them.
Used by actions: AnalyzeAuditLogs.
| Name | Type | Required | Description |
|---|---|---|---|
| Host | Array of String | No | Client address |
| User | Array of String | No | Username |
| DBName | Array of String | No | Database Name. |
| TableName | Array of String | No | Table name |
| PolicyName | Array of String | No | Audit policy name |
| Sql | String | No | SQL statement. Supports fuzzy matching. |
| SqlType | String | No | SQL Type. Currently supports: "SELECT", "INSERT", "UPDATE", "DELETE", "CREATE", "DROP", "ALTER", "SET", "REPLACE", "EXECUTE". |
| ExecTime | Integer | No | Execution time in ms, which is used to filter the audit log with execution time greater than this value. |
| AffectRows | Integer | No | Number of affected rows, which is used to filter the audit log with affected rows greater than this value. |
| SqlTypes | Array of String | No | SQL type (Multiple types can be queried at same time). Valid values: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, SET, REPLACE, EXECUTE. |
| Sqls | Array of String | No | SQL statement. Multiple SQL statements can be passed in. |
| AffectRowsSection | String | No | Number of rows affected in the format of M-N, such as 10-200. |
| SentRowsSection | String | No | Number of rows returned in the format of M-N, such as 10-200. |
| ExecTimeSection | String | No | Execution time in the format of M-N, such as 10-200. |
| LockWaitTimeSection | String | No | Lock wait time in the format of M-N, such as 10-200. |
| IoWaitTimeSection | String | No | IO wait time in the format of M-N, such as 10-200. |
| TransactionLivingTimeSection | String | No | Transaction duration in the format of M-N, such as 10-200. |
| ThreadId | Array of String | No | Thread ID |
| SentRows | Integer | No | Number of returned rows, which is used to filter the audit log with affected rows greater than this value. |
| ErrCode | Array of Integer | No | MySQL error codes |
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. |
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 |
Filter of rule audit
Used by actions: OpenAuditService.
| Name | Type | Required | Description |
|---|---|---|---|
| RuleFilters | Array of RuleFilters | No | A single audit rule. |
Details of an audit rule template.
Used by actions: DescribeAuditRuleTemplates.
| Name | Type | Description |
|---|---|---|
| RuleTemplateId | String | Rule template ID. |
| RuleTemplateName | String | Rule template name. |
| RuleFilters | Array of RuleFilters | Filter conditions of the rule template. |
| Description | String | Rule template description. |
| CreateAt | String | Rule template creation time. |
| AlarmLevel | Integer | Alarm level. Valid values: 1 - Low risk, 2 - Medium risk, 3 - High risk. |
| AlarmPolicy | Integer | Alarm policy. Valid values: 0 - Alarm disabled, 1 - Alarm enabled. |
| AffectedInstances | Array of String | Instances to which this rule template is applied. |
| Status | Integer | Template status. Valid values: 0 - No task, 1 - modifying. |
| UpdateAt | String | Template update time. |
Automatic scale-out policy for elastic CPU scale-out.
Used by actions: StartCpuExpand.
| Name | Type | Required | Description |
|---|---|---|---|
| ExpandThreshold | Integer | Yes | CPU utilization threshold (percent value). Valid values: 70, 80, and 90. Automatic scale-out will be triggered when CPU utilization reaches the set threshold. |
| ExpandPeriod | Integer | Yes | Interval, in seconds. Valid values: 1, 3, 5, 10, 15, and 30. The system backend determines whether automatic scale-out is required at the set interval. |
| ShrinkThreshold | Integer | Yes | CPU utilization threshold (percent value). Valid values: 10, 20, and 30. Automatic scale-in will be triggered when CPU utilization reaches the set threshold. |
| ShrinkPeriod | Integer | Yes | Interval, in seconds. Valid values: 5, 10, 15, and 30. The system backend determines whether automatic scale-in is required at the set interval. |
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-2 |
| Vip | String | Private IP address of secondary database 2 |
| Vport | Integer | Access port of secondary database 2 |
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). |
| Region | String | The region where local backup resides |
| RemoteInfo | Array of RemoteBackupInfo | Detailed information of remote backups |
| CosStorageType | Integer | Storage method. Valid values: 0 (regular storage), 1(archive storage). Default value: 0. |
| InstanceId | String | Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB console. |
| EncryptionFlag | String | Whether the backup file is encrypted. Valid values: on (encrypted), off (unencrypted).Note: This field may return null, indicating that no valid values can be obtained. |
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. |
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 |
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). |
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 |
| Region | String | The region where the binlog file resides |
| Status | String | Backup task status. Valid values: SUCCESS (backup succeeded), FAILED (backup failed), RUNNING (backup is in progress). |
| RemoteInfo | Array of RemoteBackupInfo | The detailed information of remote binlog backups |
| CosStorageType | Integer | Storage method. Valid values: 0 (regular storage), 1(archive storage). Default value: 0. |
| InstanceId | String | Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB console. |
Information of an aggregation bucket
Used by actions: AnalyzeAuditLogs.
| Name | Type | Description |
|---|---|---|
| Key | String | None Note: This field may return null, indicating that no valid values can be obtained. |
| Count | Integer | Number of occurrences of the key value |
The purchasable configuration in a region
Used by actions: DescribeCdbZoneConfig.
| Name | Type | Description |
|---|---|---|
| RegionName | String | Region name |
| Area | String | Area |
| IsDefaultRegion | Integer | Whether it is a default region |
| Region | String | Region name |
| RegionConfig | Array of CdbZoneSellConf | The purchasable configuration in an AZ in a region |
The details of purchasable configuration
Used by actions: DescribeCdbZoneConfig.
| Name | Type | Description |
|---|---|---|
| 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 capacity increment in GB |
| Iops | Integer | IO operations per second |
| Info | String | Application scenario description |
| Status | Integer | Status. The value 0 indicates that this specification is available. |
| DeviceType | String | Instance type, possible value ranges from UNIVERSAL (universal type), EXCLUSIVE (exclusive), BASIC (basic), to BASIC_V2 (basic v2). |
| EngineType | String | Engine type description. Valid values: Innodb, RocksDB. |
| Id | Integer | Purchasable specifications ID |
Purchasable instance type
Used by actions: DescribeCdbZoneConfig.
| Name | Type | Description |
|---|---|---|
| TypeName | String | Purchasable instance name. Z3: High-availability, corresponds to the specified specification DeviceType, including UNIVERSAL and EXCLUSIVE. CVM: It is a basic edition type, and the DeviceType in the corresponding specifications is BASIC (Offline). TKE: It is the basic version v2 type, and the DeviceType in the corresponding specifications is BASIC_V2. CLOUD_NATIVE_CLUSTER: Represents the standard type of cloud disk edition. CLOUD_NATIVE_CLUSTER_EXCLUSIVE: Indicates the enhanced cloud disk edition. ECONOMICAL: Means economical. |
| EngineVersion | Array of String | Engine version number |
| ConfigIds | Array of Integer | Purchasable specifications ID |
The purchasable specifications in a region
Used by actions: DescribeCdbZoneConfig.
| Name | Type | Description |
|---|---|---|
| Configs | Array of CdbSellConfig | List of purchasable specifications |
| Regions | Array of CdbRegionSellConf | List of AZs in purchasable regions |
Purchasable specifications in an AZ
Used by actions: DescribeCdbZoneConfig.
| Name | Type | Description |
|---|---|---|
| Status | Integer | AZ status, which is used to indicate whether instances are purchasable. Valid values: 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. Valid values: 0 (yearly/monthly subscribed), 1 (hourly billed), 2 (pay-as-you-go) |
| ProtectMode | Array of String | Data replication type. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync) |
| Zone | String | AZ name |
| ZoneConf | ZoneConf | Multi-AZ information |
| DrZone | Array of String | Information of supported disaster recovery AZs |
| IsSupportRemoteRo | Boolean | Whether cross-AZ read-only access is supported |
| RemoteRoZone | Array of String | Information of supported cross-AZ read-only zone |
| ExClusterStatus | Integer | AZ status, which is used to indicate whether dedicated instances are purchasable. Valid values: 1 (purchasable),3(not purchasable),4` (AZ not displayed) |
| ExClusterRemoteRoZone | Array of String | Information of cross-AZ read-only zones supported by a dedicated instance |
| ExClusterZoneConf | ZoneConf | AZ information of a multi-AZ deployed dedicated instance. |
| SellType | Array of CdbSellType | Array of purchasable instance types. The value of configIds and configs have a one-to-one correspondence. |
| ZoneId | Integer | AZ ID |
| IsSupportIpv6 | Boolean | Whether IPv6 is supported |
| EngineType | Array of String | Supported engine types for purchasable database |
| CloudNativeClusterStatus | Integer | Sales status of the cloud disk edition instance in the current availability zone. Possible returned values: 1-launched; 3-not available for sale; 4-not displayed. |
| DiskTypeConf | Array of DiskTypeConfigItem | Cloud disk edition or single-node basic edition supported disk type. |
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. |
| NewRegionId | Integer | Clone instance region ID |
| SrcRegionId | Integer | Source instance region ID |
Cluster Edition node information.
Used by actions: DescribeDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeId | String | No | Node ID. |
| Role | String | No | Node type: primary node and secondary node. |
| Zone | String | No | Region. |
Topology configuration of nodes for cloud disk edition.
Used by actions: CreateDBInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| ReadWriteNode | ReadWriteNode | No | RW node topology. Description: NodeId can be obtained through DescribeDBInstances. |
| ReadOnlyNodes | Array of ReadonlyNode | No | RO node topology. Description: NodeId can be obtained through DescribeDBInstances. |
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 |
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 |
| BackupPeriodStrategy | String | No | Non-archive backup retention policy. Valid values: weekly (back up by week), monthly (back up by month), default value: weekly. |
| Days | Array of Integer | No | If BackupPeriodStrategy is monthly, you need to pass in the specific backup dates. The time interval between any two adjacent dates cannot exceed 2 days, for example, [1,4,7,9,11,14,17,19,22,25,28,30,31]. |
| BackupPeriodTime | String | No | Backup time by month in the format of 02:00–06:00, which is required when BackupPeriodStrategy is monthly. |
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. |
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) |
Database permission
Used by actions: DescribeAccountPrivileges, ModifyAccountPrivileges.
| Name | Type | Required | Description |
|---|---|---|---|
| Privileges | Array of String | Yes | Permission information |
| Database | String | Yes | Database name |
Database name and character set
Used by actions: DescribeDatabases.
| Name | Type | Description |
|---|---|---|
| DatabaseName | String | Database name |
| CharacterSet | String | Character set |
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 |
Average instance CPU utilization
Used by actions: DescribeDeviceMonitorInfo.
| Name | Type | Description |
|---|---|---|
| CpuCore | Integer | CPU core number |
| Rate | Array of Integer | CPU utilization |
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. |
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 |
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 |
Disk sale type
Used by actions: DescribeCdbZoneConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| DeviceType | String | No | Type of instance corresponding to the disk. Only support single node (cloud disk) and cloud disk edition. |
| DiskType | Array of String | No | List of disk types to choose. |
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 |
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. |
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 |
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 |
| AddressModule | String | Address module |
| Desc | String | Rule description |
Search filter for audit log
Used by actions: AnalyzeAuditLogs, CreateAuditLogFile, DescribeAuditLogs.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | Filter condition. The search conditions are supported as follows: Include/Exclude, and Include/Exclude (segment dimension) can be used to search for: sql - SQL details.Equal to, Not equal to, Include, and Exclude can be used to search for:host - Client IP,user - Username,DBName - Database name.Equal to and Not equal to can be used to search for:sqlType - SQL type,errCode - Error code,threadId - Thread ID.Range search is supported for: execTime- Execution time (μs),lockWaitTime - Lock wait time (μs),ioWaitTime - IO wait time (μs),trxLivingTime - Transaction duration (μs),cpuTime - CPU time (μs),checkRows - Number of scanned rows,affectRows - Number of affected rows,sentRows - Number of returned rows. |
| Compare | String | No | Filter. Valid values:WINC - Include (segment dimension)WEXC - Exclude (segment dimension)INC - Include,EXC - Exclude,EQS - Equal to,NEQ - Not equal to.RA - Range |
| Value | Array of String | No | The filter value. In a reverse query, multiple values are in an "AND" relationship; while in a forward query, multiple values are in an "OR" relationship. |
Instance audit details.
Used by actions: DescribeAuditInstanceList.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| AuditStatus | String | Audit status. ON - Audit is enabled, OFF - Audit is disabled. |
| AuditTask | Integer | Task status. Valid values: 0 - No task; 1 - Enabling audit; 2 - Disabling audit. |
| LogExpireDay | Integer | Log retention period. Valid values:7 - One week;30 - One month;90 - Three months;180 - Six months;365 - One year;1095 - Three years;1825 - Five years. |
| HighLogExpireDay | Integer | High-frequency storage period. Valid values:3 - 3 days;7 - One week;30 - One month;90 - Three months;180 - Six months;365 - One year;1095 - Three years;1825 - Five years. |
| LowLogExpireDay | Integer | Low-frequency storage period (in days). This equals the log retention period minus the high-frequency storage period. |
| BillingAmount | Float | Log storage volume (in GB). |
| HighRealStorage | Float | High-frequency storage volume (in GB). |
| LowRealStorage | Float | Low-frequency storage volume (in GB). |
| AuditAll | Boolean | Whether full audit is enabled. true - Full audit. |
| CreateAt | String | Time when the audit service was activated. |
| InstanceInfo | AuditInstanceInfo | Related information about the instance. |
| RealStorage | Float | Total storage volume (in GB). |
| OldRule | Boolean | Whether an audit policy is configured. |
| RuleTemplateIds | Array of String | Rule template applied to the instance. |
| TrialStatus | String | Trial status. |
| TrialStartTime | Integer | Trial start time. |
| TrialDuration | Integer | Trial duration. |
| TrialCloseTime | Integer | Trial end time. |
| TrialDescribeLogHours | Integer | Log query time limit during the trial period. |
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 | Read-only VIP information. This field is available only for read-only instances with dedicated access enabled. |
| Memory | Integer | Memory capacity in MB |
| Status | Integer | Instance status. Valid values: 0 (creating), 1 (running), 4 (isolating), 5 (isolated). |
| VpcId | Integer | VPC ID, such as 51102 |
| SlaveInfo | SlaveInfo | Secondary server information. |
| 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 | Detailed information about the read-only group. |
| 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 | Detailed information about the primary instance. |
| DeviceType | String | Instance type |
| EngineVersion | String | Kernel version |
| InstanceName | String | Instance name |
| DrInfo | Array of DrInfo | Detailed information about the disaster recovery instance. |
| 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 server model. |
| DeployGroupId | String | Placement group ID. |
| ZoneId | Integer | AZ ID. |
| InstanceNodes | Integer | Number of nodes |
| TagList | Array of TagInfoItem | Tag list. |
| EngineType | String | Engine type. |
| MaxDelayTime | Integer | Maximum delay threshold. |
| DiskType | String | Instance disk type. Valid values are returned only for Cluster Edition and single-node (cloud disk) instances. Note: 1. If "DiskType": "CLOUD_HSSD" is returned, it indicates that the instance disk type is Enhanced SSD. 2. If "DiskType": "CLOUD_SSD" is returned, it indicates that the instance disk type is Cloud SSD. 3. If "DiskType": "" is returned and the DeviceType parameter value is UNIVERSAL or EXCLUSIVE, it indicates that the instance uses a local SSD. |
| ExpandCpu | Integer | Current number of CPU cores for scale-out. |
| ClusterInfo | Array of ClusterInfo | Cluster Edition instance node information. |
| AnalysisNodeInfos | Array of AnalysisNodeInfo | Analysis engine node list. |
| DeviceBandwidth | Integer | Device bandwidth, in GB. This parameter is valid when DeviceClass is specified. For example, 25 means the current device bandwidth is 25 GB; 10 means the current device bandwidth is 10 GB. |
| DestroyProtect | String | Instance termination protection status. on indicates enabled; otherwise, the protection is disabled. |
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 |
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 |
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]. |
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]. |
Basic information on the rule template hit by the audit log.
Used by actions: DescribeAuditLogs.
| Name | Type | Description |
|---|---|---|
| RuleTemplateId | String | Template ID. Note: The return value may be null, indicating that no valid data can be obtained. |
| RuleTemplateName | String | Template name. Note: The return value may be null, indicating that no valid data can be obtained. |
| AlarmLevel | String | Alarm level. Valid values: 1: Low risk; 2: Medium risk; 3: High risk. Note: The return value may be null, indicating that no valid data can be obtained. |
| RuleTemplateStatus | Integer | Template change status. Valid values: 0: Unchanged; 1: Changed; 2: Deleted. Note: The return value may be null, indicating that no valid data can be obtained. |
Configurations of sending slow and error logs of a CDB instance to CLS.
Used by actions: DescribeDBInstanceLogToCLS.
| Name | Type | Description |
|---|---|---|
| Status | String | Enabling status of the feature. Note: The return value may be null, indicating that no valid data can be obtained. |
| LogSetId | String | CLS log set ID. Note: The return value may be null, indicating that no valid data can be obtained. |
| LogTopicId | String | Log topic ID. Note: The return value may be null, indicating that no valid data can be obtained. |
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 |
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 |
| AddressModule | String | Address module |
| Desc | String | Rule description |
Instance parameter information
Used by actions: CreateDBInstance, CreateDBInstanceHour.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Parameter name |
| Value | String | Yes | Parameter value |
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 |
| ModifyTime | String | Modification time |
| IsSuccess | Boolean | Indicates whether the parameter is modified successfully. |
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 |
| EngineType | String | Parameter template engine Note: This field may return null, indicating that no valid values can be obtained. |
Database instance parameter
Used by actions: CreateParamTemplate, ModifyInstanceParam, ModifyInstancePasswordComplexity, ModifyParamTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Parameter name |
| CurrentValue | String | No | Parameter value |
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 |
| IsNotSupportEdit | Boolean | Whether the parameter can be modified Note: This field may return null, indicating that no valid values can be obtained. |
Information of the database proxy address
Used by actions: DescribeCdbProxyInfo.
| Name | Type | Description |
|---|---|---|
| ProxyAddressId | String | Address ID of the proxy group |
| UniqVpcId | String | VPC ID |
| UniqSubnetId | String | VPC subnet ID |
| Vip | String | IP address |
| VPort | Integer | Port |
| WeightMode | String | Assignment mode of weights. Valid values: system (auto-assigned), custom. Note: This field may return null, indicating that no valid values can be obtained. |
| IsKickOut | Boolean | Whether to remove delayed read-only instances from the proxy group Valid values: true, false. Note: This field may return null, indicating that no valid values can be obtained. |
| MinCount | Integer | Least read-only instances. Minimum value: 0. Note: This field may return null, indicating that no valid values can be obtained. |
| MaxDelay | Integer | The delay threshold. Minimum value: 0. Note: This field may return null, indicating that no valid values can be obtained. |
| AutoAddRo | Boolean | Whether to automatically add newly created read-only instances. Valid values: true, false. Note: This field may return null, indicating that no valid values can be obtained. |
| ReadOnly | Boolean | Whether it is read-only. Valid values: true, false. Note: This field may return null, indicating that no valid values can be obtained. |
| TransSplit | Boolean | Whether to enable transaction splitting Note: This field may return null, indicating that no valid values can be obtained. |
| FailOver | Boolean | Whether to enable failover Note: This field may return null, indicating that no valid values can be obtained. |
| ConnectionPool | Boolean | Whether to enable the connection pool Note: This field may return null, indicating that no valid values can be obtained. |
| Desc | String | Note: This field may return null, indicating that no valid values can be obtained. |
| ProxyAllocation | Array of ProxyAllocation | Read weight assignment for an instance Note: This field may return null, indicating that no valid values can be obtained. |
Weight allocation for a proxy node
Used by actions: AdjustCdbProxyAddress, CreateCdbProxyAddress, DescribeCdbProxyInfo.
| Name | Type | Required | Description |
|---|---|---|---|
| Region | String | Yes | Proxy node region |
| Zone | String | Yes | AZ of proxy node region |
| ProxyInstance | Array of ProxyInst | Yes | Proxy instance allocation |
Details of proxy group
Used by actions: DescribeCdbProxyInfo.
| Name | Type | Description |
|---|---|---|
| ProxyGroupId | String | Proxy group ID |
| ProxyVersion | String | Proxy version Note: This field may return null, indicating that no valid values can be obtained. |
| SupportUpgradeProxyVersion | String | Supported proxy upgrade version Note: This field may return null, indicating that no valid values can be obtained. |
| Status | String | Proxy status Note: This field may return null, indicating that no valid values can be obtained. |
| TaskStatus | String | Proxy task status Note: This field may return null, indicating that no valid values can be obtained. |
| ProxyNode | Array of ProxyNode | Node information of the proxy group Note: This field may return null, indicating that no valid values can be obtained. |
| ProxyAddress | Array of ProxyAddress | Address information of the proxy group Note: This field may return null, indicating that no valid values can be obtained. |
| ConnectionPoolLimit | Integer | Connection pool threshold Note: This field may return null, indicating that no valid values can be obtained. |
| SupportCreateProxyAddress | Boolean | Whether to support address creation Note: This field may return null, indicating that no valid values can be obtained. |
| SupportUpgradeProxyMysqlVersion | String | TencentDB versions supporting proxy versions upgrade Note: This field may return null, indicating that no valid values can be obtained. |
Proxy instance
Used by actions: AdjustCdbProxyAddress, CreateCdbProxyAddress.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceId | String | No | Instance ID Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceName | String | No | Instance name Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceType | Integer | No | Instance type. Valid values: master (source instance), ro (read-only instance), dr (disaster recovery instance), sdr (disaster recovery instance of small specifications). Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Instance status. Valid values: 0 (creating), 1 (running), 4 (isolating), 5 (isolated). Note: This field may return null, indicating that no valid values can be obtained. |
| Weight | Integer | No | Read weight. If it is assigned by the system automatically, the modification will not take effect but represents whether the instance is enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | No | Instance region Note: This field may return null, indicating that no valid values can be obtained. |
| Zone | String | No | Instance AZ Note: This field may return null, indicating that no valid values can be obtained. |
Proxy node
Used by actions: DescribeCdbProxyInfo.
| Name | Type | Description |
|---|---|---|
| ProxyId | String | Proxy node ID Note: This field may return null, indicating that no valid values can be obtained. |
| Cpu | Integer | Number of CPU cores Note: This field may return null, indicating that no valid values can be obtained. |
| Mem | Integer | Memory size Note: This field may return null, indicating that no valid values can be obtained. |
| Status | String | Node status Note: This field may return null, indicating that no valid values can be obtained. |
| Zone | String | Proxy node AZ Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | Proxy node region Note: This field may return null, indicating that no valid values can be obtained. |
| Connection | Integer | Connections Note: This field may return null, indicating that no valid values can be obtained. |
The specification configuration of a node
Used by actions: AdjustCdbProxy, CreateCdbProxy.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeCount | Integer | Yes | Number of nodes |
| Cpu | Integer | Yes | Number of CPU cores |
| Mem | Integer | Yes | Memory size |
| Region | String | Yes | Region |
| Zone | String | Yes | AZ |
Configuration of the cloud disk edition RW node.
Used by actions: CreateDBInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Zone | String | Yes | Availability zone where the RW node is located. |
| NodeId | String | No | When upgrading a cloud disk edition instance, if you need to adjust the Availability Zone of Read-Only Nodes, you must specify the node ID. |
RO node configuration for cloud disk edition.
Used by actions: CreateDBInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| IsRandomZone | String | No | Whether distributed in a random availability Zone. Import YES means random availability Zone. Otherwise used specified availability Zone. |
| Zone | String | No | Specify the availability zone for node distribution. |
| NodeId | String | No | When upgrading a cloud disk edition instance, if you need to adjust the Availability Zone of Read-Only Nodes, you must specify the node ID. |
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. |
Information of the remote backup
Used by actions: DescribeBackups, DescribeBinlogs.
| Name | Type | Description |
|---|---|---|
| SubBackupId | Integer | ID of the remote backup subtask |
| Region | String | The region where the remote backup resides |
| Status | String | Backup task status. Valid values: SUCCESS (backup succeeded), FAILED (backup failed), RUNNING (backup is in progress). |
| StartTime | String | The start time of remote backup |
| FinishTime | String | The end time of remote backup |
| Url | String | The download address |
Read-only group parameter
Used by actions: CreateDBInstance, CreateDBInstanceHour, DescribeDBInstances, DescribeRoGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| RoGroupMode | String | Yes | Read-only group mode. Available values are: alone-automatic allocation by the system; allinone-create a read-only group; join-use an existing read-only group. |
| RoGroupId | String | No | Read-only group ID. |
| RoGroupName | String | No | Read-only group name. |
| RoOfflineDelay | Integer | No | Whether to enable the feature to isolate an instance that exceeds the latency threshold. After enabling this feature, if the delay between a read-only instance and the primary instance exceeds the delay threshold, the read-only instance will be isolated. Available values: 1-enable; 0-disable. |
| RoMaxDelayTime | Integer | No | Delay threshold, in seconds. Value range: 1–10000. The value is an integer. |
| MinRoInGroup | Integer | No | Minimum number of instances to retain. If the number of read-only instances purchased is less than the set number, removal will not occur. |
| WeightMode | String | No | Read-write weight allocation mode. Available values: system-automatic allocation by the system; custom-customization. |
| Weight | Integer | No | This field is deprecated and meaningless. To view the weight of a read-only instance, check the Weight value in the RoInstances field. |
| RoInstances | Array of RoInstanceInfo | No | Details of read-only instances in the read-only group. |
| Vip | String | No | Private IP address of the read-only group. |
| Vport | Integer | No | Private network port number of the read-only group. |
| UniqVpcId | String | No | VPC ID. |
| UniqSubnetId | String | No | Subnet ID. |
| RoGroupRegion | String | No | Region of the read-only group. |
| RoGroupZone | String | No | AZ of the read-only group. |
| DelayReplicationTime | Integer | No | Replication delay time, in seconds. Value range: 1–259200. The value is an integer. |
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. |
RO instance details
Used by actions: CreateDBInstance, CreateDBInstanceHour, DescribeDBInstances, DescribeRoGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| MasterInstanceId | String | No | Master instance ID corresponding to the RO group |
| RoStatus | String | No | RO instance status in the RO group. Value range: online, offline |
| OfflineTime | String | No | Last deactivation time of a RO instance in the RO group |
| Weight | Integer | No | RO instance weight in the RO group |
| Region | String | No | RO instance region name, such as ap-shanghai |
| Zone | String | No | Canonical name of the RO Availability Zone, for example ap-shanghai-2 |
| InstanceId | String | No | RO instance ID in the format of cdbro-c1nl9rpv |
| Status | Integer | No | 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 | No | Instance type. Value range: 1 (primary), 2 (disaster recovery), 3 (read-only) |
| InstanceName | String | No | RO instance name |
| HourFeeStatus | Integer | No | Pay-as-you-go status. Valid values: 1 - normal; 2 - in arrears. |
| TaskStatus | Integer | No | 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 | No | RO instance memory size in MB |
| Volume | Integer | No | RO instance disk size in GB |
| Qps | Integer | No | Queries per second |
| Vip | String | No | Private IP address of the RO instance |
| Vport | Integer | No | Access port of the RO instance |
| VpcId | Integer | No | VPC ID of the RO instance |
| SubnetId | Integer | No | VPC subnet ID of the RO instance |
| DeviceType | String | No | RO instance specification description. Value range: CUSTOM |
| EngineVersion | String | No | Database engine version of the read-only replica. Valid values: 5.1, 5.5, 5.6, 5.7, 8.0 |
| DeadlineTime | String | No | 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 | No | Billing type of the RO instance. Valid values: 0 - yearly/monthly subscription; 1 - pay-as-you-go; 2-postpaid by month. |
| ReplicationStatus | String | No | RO replication delay status. |
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 |
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]. |
Name of the database for rollback
Used by actions: 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. |
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. |
Name of the table for rollback
Used by actions: 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. |
Details of the table for rollback
Used by actions: 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. |
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. |
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 |
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. |
Filter of the audit rule
Used by actions: CreateAuditRuleTemplate, DescribeAuditRuleTemplateModifyHistory, DescribeAuditRuleTemplates, ModifyAuditRuleTemplates, OpenAuditService.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Parameter name of the audit rule filter. Valid values: host (client IP), user (database account), dbName (database name), sqlType (SQL type), sql (SQL statement), affectRows (affected rows), sentRows (returned rows), checkRows (scanned rows), execTime (execution rows). |
| Compare | String | Yes | Filter match value of the audit rule Valid values: INC (including), EXC (excluding), EQS (equal to), NEQ (not equal to), REG (regex), GT (greater than), LT (less than). |
| Value | Array of String | Yes | Filter match value of the audit rule Valid values for sqlType: alter, changeuser, create, delete, drop, execute, insert, login, logout, other, replace, select, set,update`. |
Rule template content.
Used by actions: DescribeAuditRuleTemplateModifyHistory.
| Name | Type | Description |
|---|---|---|
| RuleTemplateId | String | Rule template ID. |
| RuleTemplateName | String | Rule template name. |
| RuleFilters | Array of RuleFilters | Rule content. |
| AlarmLevel | Integer | Alarm level. Valid values: 1 - Low risk, 2 - Medium risk, 3 - High risk. |
| AlarmPolicy | Integer | Alarm policy. Valid values: 0 - Alarm disabled, 1 - Alarm enabled. |
| Description | String | Rule description. |
Rule template change history.
Used by actions: DescribeAuditRuleTemplateModifyHistory.
| Name | Type | Description |
|---|---|---|
| TaskId | Integer | Task ID. |
| ModifyBeforeInfo | RuleTemplateInfo | Details of the original rule template. |
| ModifyAfterInfo | RuleTemplateInfo | Details of the modified rule template. |
| AffectedInstances | Array of String | Affected instances. |
| Operator | String | Operator (account UIN). |
| UpdateTime | String | Time of the change. |
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 |
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-2 |
Slave server information
Used by actions: DescribeDBInstances.
| Name | Type | Description |
|---|---|---|
| First | SlaveInstanceInfo | Information of secondary server 1 |
| Second | SlaveInstanceInfo | Second secondary server information. |
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 |
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) |
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. |
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 |
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 structure
Used by actions: DescribeDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Tag key |
| Value | String | Yes | Tag value |
Tag information
Used by actions: CreateCloneInstance, CreateDBInstance, CreateDBInstanceHour, ModifyInstanceTag.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | Array of String | Yes | Tag value |
Tag information
Used by actions: DescribeDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key. |
| TagValue | String | Yes | Tag value. |
Tag information unit
Used by actions: DescribeAuditInstanceList, DescribeTagsOfInstanceIds.
| Name | Type | Description |
|---|---|---|
| TagKey | String | Tag key |
| TagValue | String | Tag value |
Instance tag information
Used by actions: DescribeTagsOfInstanceIds.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| Tags | Array of TagInfoUnit | Tag information |
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. |
File upload description
Used by actions: DescribeUploadedFiles.
| Name | Type | Description |
|---|---|---|
| AllSliceNum | Integer | Number of parts of file |
| CompleteNum | Integer | Number of completed parts |
Multi-AZ information
Used by actions: DescribeCdbZoneConfig.
| 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 |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários