Range of constraint type values
Used by actions: DescribeDBParameters.
Name | Type | Description |
---|---|---|
Min | String | Minimum value when constraint type is section |
Max | String | Maximum value when 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 secondary will be used first, and if it is unavailable, the primary will be used; 2: the secondary will be used first, and if it is unavailable, the operation will fail. |
DelayThresh | Integer | This field is meaningful for read-only accounts, indicating to select a secondary where the primary/secondary delay is below this value Note: this field may return null, indicating that no valid values can be obtained. |
TencentDB instance backup time configuration information
Used by actions: DescribeBackupTime.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID |
StartBackupTime | String | Start time of daily backup window in the format of mm:ss , such as 22:00 |
EndBackupTime | String | End time of daily backup window in the format of mm:ss , such as 23:00 |
TencentDB instance details.
Used by actions: DescribeDBInstances.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID, which uniquely identifies a TDSQL instance |
InstanceName | String | Customizable instance name |
AppId | Integer | Application ID of instance |
ProjectId | Integer | Project ID of instance |
Region | String | Instance region name, such as ap-shanghai |
Zone | String | Instance AZ name, such as ap-guangzhou-1 |
VpcId | Integer | VPC ID, which is 0 if the basic network is used |
SubnetId | Integer | Subnet ID, which is 0 if the basic network is used |
Status | Integer | Instance status. 0: creating, 1: processing, 2: running, 3: instance not initialized, -1: instance isolated, -2: instance deleted |
Vip | String | Private IP address |
Vport | Integer | Private network port |
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 |
CreateTime | Timestamp | Instance creation time in the format of 2006-01-02 15:04:05 |
UpdateTime | Timestamp | Last updated time of instance in the format of 2006-01-02 15:04:05 |
AutoRenewFlag | Integer | Auto-renewal flag. 0: no, 1: yes |
PeriodEndTime | Timestamp | Instance expiration time in the format of 2006-01-02 15:04:05 |
Uin | String | Instance account |
TdsqlVersion | String | TDSQL version information |
Memory | Integer | Instance memory size in GB |
Storage | Integer | Instance storage capacity in GB |
UniqueVpcId | String | VPC ID in string type |
UniqueSubnetId | String | VPC subnet ID in string type |
OriginSerialId | String | Original ID of instance (this field is obsolete and should not be depended on) |
NodeCount | Integer | Number of nodes. 2: one master and one slave, 3: one master and two slaves |
IsTmp | Integer | Whether it is a temp instance. 0: no, non-zero value: yes |
ExclusterId | String | Dedicated cluster ID. If this parameter is empty, the instance is a general instance |
Id | Integer | Numeric ID of instance (this field is obsolete and should not be depended on) |
Pid | Integer | Product type ID |
Qps | Integer | Maximum QPS value |
Paymode | String | Billing mode Note: this field may return null, indicating that no valid values can be obtained. |
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. |
StatusDesc | String | Current instance running status description 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 |
Machine | String | Model |
IsEncryptSupported | Integer | Whether data encryption is supported. 1: yes, 0: no |
Cpu | Integer | Number of CPU cores of instance |
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. |
DbEngine | String | Database engine Note: this field may return null, indicating that no valid values can be obtained. |
DbVersion | String | Database version 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 (primary instance), 3 (disaster recovery instance), and 4 (dedicated disaster recovery instance).Note: this field may return null, indicating that no valid values can be obtained. |
TencentDB parameter information.
Used by actions: InitDBInstances, ModifyDBParameters.
Name | Type | Required | Description |
---|---|---|---|
Param | String | Yes | Parameter name |
Value | String | Yes | Parameter value |
Database information
Used by actions: DescribeDatabases.
Name | Type | Description |
---|---|---|
DbName | String | Database name |
Pulled log information
Used by actions: DescribeDBLogFiles.
Name | Type | Description |
---|---|---|
Mtime | Integer | Last modified time of log |
Length | Integer | File length |
Uri | String | Uniform resource identifier (URI) used during log download |
FileName | String | Filename |
Monitoring data
Used by actions: DescribeDBPerformance, DescribeDBPerformanceDetails, DescribeDBResourceUsage, DescribeDBResourceUsageDetails.
Name | Type | Description |
---|---|---|
StartTime | Timestamp | Start time in the format of 2018-03-24 23:59:59 |
EndTime | Timestamp | End time in the format of 2018-03-24 23:59:59 |
Data | Array of Float | Monitoring data |
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 section Note: 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.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 |
Parameter modification result
Used by actions: ModifyDBParameters.
Name | Type | Description |
---|---|---|
Param | String | Renames a parameter |
Code | Integer | Result of parameter modification. 0: success, -1: failure, -2: invalid parameter value |
Set of database performance monitoring metrics
Used by actions: DescribeDBPerformanceDetails.
Name | Type | Description |
---|---|---|
UpdateTotal | MonitorData | Number of UPDATE operations |
DiskIops | MonitorData | Number of disk IOs per second |
ConnActive | MonitorData | Number of active connections |
MemHitRate | MonitorData | Cache hit rate |
SlaveDelay | MonitorData | Primary/Secondary delay |
SelectTotal | MonitorData | Number of SELECT operations |
LongQuery | MonitorData | Number of slow queries |
DeleteTotal | MonitorData | Number of DELETE operations |
InsertTotal | MonitorData | Number of INSERT operations |
IsMasterSwitched | MonitorData | Whether primary/Secondary switch occurred. 1: yes, 0: no |
Set of database resource usage monitoring metrics
Used by actions: DescribeDBResourceUsageDetails.
Name | Type | Description |
---|---|---|
BinlogDiskAvailable | MonitorData | Available capacity of binlog disk in GB |
CpuUsageRate | MonitorData | CPU utilization |
MemAvailable | MonitorData | Available memory size in GB |
DataDiskAvailable | MonitorData | Available disk capacity in GB |
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. |
Slow query entry information
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. |
Was this page helpful?