tencent cloud

TDSQL Boundless

문서TDSQL Boundless​​API ReferenceData Types

Data Types

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-10-13 15:24:35

AnalysisInstanceInfo

Analytics engine instance info

Used by actions: DescribeDBInstanceDetail, DescribeDBInstances.

Name Type Description
ReplicasNum Integer

Number of replicas

AnalysisRelationInfo

Analytics engine association

Used by actions: DescribeDBInstanceDetail, DescribeDBInstances.

Name Type Description
PrimaryInstanceId String

Source instance Id
AnalysisInstanceId String

Analysis engine instance Id
Status String

Analysis engine relationship status

Enumeration values:

  • creating: Creating
  • running: Running
  • destroyed: Terminated
CreateAt String

Creation time.
UpdateAt String

Update time.

ArchiveLogInterval

Recoverable time interval

Used by actions: DescribeDBSAvailableRecoveryTime.

Name Type Required Description
EndTime String No End time.
Note: This field may return null, indicating that no valid values can be obtained.
MajorVersion String No Major version.
Note: This field may return null, indicating that no valid values can be obtained.
MinorVersion String No Minor version.
Note: This field may return null, indicating that no valid values can be obtained.
StartTime String No Start time.
Note: This field may return null, indicating that no valid values can be obtained.

ArchiveLogModel

Archive log object

Used by actions: DescribeDBSArchiveLogs.

Name Type Required Description
ArchiveLogId Integer No Archivelog ID
Note: This field may return null, indicating that no valid values can be obtained.
BackupDuration Integer No Backup duration
Note: This field may return null, indicating that no valid values can be obtained.
BackupStatus String No Backup status
Note: This field may return null, indicating that no valid values can be obtained.
EndTime String No Backup end time.
Note: This field may return null, indicating that no valid values can be obtained.
ErrorMessage String No Error message
Note: This field may return null, indicating that no valid values can be obtained.
ExpiredTime String No Expiration time
Note: This field may return null, indicating that no valid values can be obtained.
FileName String No Backup file name
Note: This field may return null, indicating that no valid values can be obtained.
FileSize Integer No Backup set file size in Byte
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String No Instance ID.
Note: This field may return null, indicating that no valid values can be obtained.
StartTime String No Backup start time.
Note: This field may return null, indicating that no valid values can be obtained.

AutoScalingConfig

Scope of resources for instance configuration adjustment
When ResourceType is cpu, it means ccu.
When the value is nodecount, it indicates the range of the number of nodes.
For disk, it indicates the disk capacity range (unit: GB).
Whether ScaleUpEnabled enables scale-up
Whether ScaleDownEnabled is enabled
ThresholdPercent is the trigger threshold (%).
Step is the step length for configuration change

Used by actions: CreateDBInstances, DescribeDBInstanceDetail, DescribeDBInstances.

Name Type Required Description
RangeMin Float Yes

Minimum value
RangeMax Float Yes

Maximum value
ResourceType String No

Resource type corresponding to the returned range parameter

Enumeration values:

  • cpu: Returns the CPU adjustment return limit. When no mem limit exists, it represents ccu.
  • nodecount: Returns the limit range of the number of nodes for horizontal scaling.
  • datadisk: Returns the capacity limit range for disk scale-out.
ScaleUpEnabled Boolean No

Whether upgrade is allowed
ScaleDownEnabled Boolean No

Whether to allow downgrade
ThresholdPercent Integer No

Trigger threshold (%)
Step Float No

Configuration change step length

BackupMethodStatisticsModel

Backup method statistical object - provided to backup space statistics API

Used by actions: DescribeDBSBackupStatistics.

Name Type Description
AutoBackupSize Integer

Auto-backup size in Byte


Note: This field may return null, indicating that no valid values can be obtained.
AverageSizePerDay Integer

Average size of total backup per day in Byte


Note: This field may return null, indicating that no valid values can be obtained.
ManualBackupSize Integer

Manual backup size, unit Byte


Note: This field may return null, indicating that no valid values can be obtained.
TotalSize Integer

Total backup size in Byte


Note: This field may return null, indicating that no valid values can be obtained.

BackupMethodStatisticsOutPut

Backup method statistical object, provided to backup set statistical detail API

Used by actions: DescribeDBSBackupStatisticsDetail.

Name Type Description
AutoBackupSize Array of Integer

Auto-backup size in Byte


Note: This field may return null, indicating that no valid values can be obtained.
ManualBackupSize Array of Integer

Manual backup size, unit Byte


Note: This field may return null, indicating that no valid values can be obtained.

BackupPolicyModelInput

Modify backup policy object.

Used by actions: ModifyDBSBackupPolicy.

Name Type Required Description
BackupEndTime String No <P>Backup end time.
BackupMethod String No <P>Backup method: physical physical backup, snapshot snapshot backup
BackupStartTime String No <P>Backup start time
EnableFull Integer No <P>Whether full backup is enabled
EnableLog Integer No <P>Whether to enable log backup
FullRetentionPeriod Integer No <P>Full backup retention time can currently only be set to 7 days.
InstanceId String No

Instance ID.
LogRetentionPeriod Integer No <P>Log retention days. currently, can only set retention to 7 days.
PeriodTime String No <P>Days of the week to perform backup.
StorageType String No

Storage type: COS, SNAPSHOT

valid values:
  • COS: COS storage
  • SNAPSHOT: cloud disk SNAPSHOT

BackupPolicyModelOutPut

Backup policy object

Used by actions: DescribeDBSBackupPolicy.

Name Type Description
BackupEndTime String

Backup end time


Note: This field may return null, indicating that no valid values can be obtained.
BackupMethod String

Backup method


Note: This field may return null, indicating that no valid values can be obtained.
BackupStartTime String

Backup start time


Note: This field may return null, indicating that no valid values can be obtained.
DBType String

Engine type


Note: This field may return null, indicating that no valid values can be obtained.
DBVersion String

Engine version


Note: This field may return null, indicating that no valid values can be obtained.
EnableFull Integer

Whether full backup is enabled


Note: This field may return null, indicating that no valid values can be obtained.
EnableLog Integer

Whether to enable log backup


Note: This field may return null, indicating that no valid values can be obtained.
ExpectedNextBackupPeriod String

Expected next backup time


Note: This field may return null, indicating that no valid values can be obtained.
FullRetentionPeriod Integer

Full backup retention time


Note: This field may return null, indicating that no valid values can be obtained.
ID Integer

Policy ID


Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String

Instance ID.


Note: This field may return null, indicating that no valid values can be obtained.
LogRetentionPeriod Integer

Log retention days


Note: This field may return null, indicating that no valid values can be obtained.
PeriodTime String

Days of the week to perform backup


Note: This field may return null, indicating that no valid values can be obtained.
Region String

Region


Note: This field may return null, indicating that no valid values can be obtained.
PeriodType Integer

Backup cycle type 0:Weekly


Note: This field may return null, indicating that no valid values can be obtained.

BackupSetModel

Backup set object

Used by actions: DescribeDBSBackupSets.

Name Type Required Description
BackupDuration Integer No Backup set duration, unit sec
Note: This field may return null, indicating that no valid values can be obtained.
BackupMethod String No Backup method
Note: This field may return null, indicating that no valid values can be obtained.
BackupName String No Backup note name
Note: This field may return null, indicating that no valid values can be obtained.
BackupProgress Float No Backup set progress percentage
Note: This field may return null, indicating that no valid values can be obtained.
BackupSetId Integer No Backup set ID
Note: This field may return null, indicating that no valid values can be obtained.
BackupStatus String No Backup status
Note: This field may return null, indicating that no valid values can be obtained.
BackupType String No Backup set type
Note: This field may return null, indicating that no valid values can be obtained.
DBVersion String No Instance version number
Note: This field may return null, indicating that no valid values can be obtained.
EndTime String No Backup end time.
Note: This field may return null, indicating that no valid values can be obtained.
EndTrxTime String No Transaction commit end time
Note: This field may return null, indicating that no valid values can be obtained.
ErrorMessage String No Error message
Note: This field may return null, indicating that no valid values can be obtained.
ExpiredTime String No Backup expiration time
Note: This field may return null, indicating that no valid values can be obtained.
FileName String No Backup file name
Note: This field may return null, indicating that no valid values can be obtained.
FileSize Integer No Backup set file size in Byte
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String No Instance ID.
Note: This field may return null, indicating that no valid values can be obtained.
ManualBackup Integer No Backup trigger. 0: autobackup; 1: manual.
Note: This field may return null, indicating that no valid values can be obtained.
StartTime String No Backup start time.
Note: This field may return null, indicating that no valid values can be obtained.

BackupSetsReqFilter

filter for backup set queries

Used by actions: DescribeDBSBackupSets.

Name Type Required Description
BackupMethod String No

Backup method, multiple values separated by commas

Enumeration value:

  • physical: Physical backup
  • snapshot: Snapshot backup

Note: This field may return null, indicating that no valid values can be obtained.
BackupStatus String No

Backup status, multiple values separated by commas. Description of meaning: pending scheduling pending, running running, success success, failed failed


Note: This field may return null, indicating that no valid values can be obtained.
BackupType String No

Backup type, multiple values separated by commas. Description of meaning: full backup full

Enumeration value:

  • full: Full backup

Note: This field may return null, indicating that no valid values can be obtained.
ManualBackup String No

Backup trigger mode

Enumeration value:

  • 0: Auto-backup
  • 1: Manual backup

Note: This field may return null, indicating that no valid values can be obtained.

BackupStatisticsModel

Backup statistics object

Used by actions: DescribeDBSBackupStatistics.

Name Type Description
AverageSizePerDay Integer

Average size of total backup per day in Byte


Note: This field may return null, indicating that no valid values can be obtained.
DataBackupSize Integer

Backup size of data, in Byte


Note: This field may return null, indicating that no valid values can be obtained.
LogBackupSize Integer

Log backup size in Byte


Note: This field may return null, indicating that no valid values can be obtained.
TotalCount Integer

Total backup count


Note: This field may return null, indicating that no valid values can be obtained.
TotalSize Integer

Total backup size in Byte


Note: This field may return null, indicating that no valid values can be obtained.

BackupTypeStatisticsModel

Backup method statistical object, provided to backup set statistical detail API

Used by actions: DescribeDBSBackupStatisticsDetail.

Name Type Description
DataBackupSize Array of Integer

Backup size of data, in Byte


Note: This field may return null, indicating that no valid values can be obtained.
LogBackupSize Array of Integer

Log backup size in Byte


Note: This field may return null, indicating that no valid values can be obtained.

BinlogInfo

Show the Binlog information of the node.

Used by actions: DescribeDBInstanceDetail.

Name Type Description
Sid String Unique ID of the log service
Type String Log service type
InstanceId String Unique ID of the instance

CloneInstanceModel

Clone instance object.

Used by actions: DescribeDBSCloneInstances.

Name Type Description
CloneEndTime String Clone task end time.
Note: This field may return null, indicating that no valid values can be obtained.
CloneId Integer Clone record ID.
Note: This field may return null, indicating that no valid values can be obtained.
CloneInsType String Clone instance type.
Note: This field may return null, indicating that no valid values can be obtained.
CloneInstanceId String Clone instance ID.
Note: This field may return null, indicating that no valid values can be obtained.
CloneInstanceIsDeleted Boolean Whether the clone instance is deleted.
Note: This field may return null, indicating that no valid values can be obtained.
CloneProgress Float Task progress of clone.
Note: This field may return null, indicating that no valid values can be obtained.
CloneStartTime String Task start time of the clone.
Note: This field may return null, indicating that no valid values can be obtained.
CloneStatus String Task status.
Note: This field may return null, indicating that no valid values can be obtained.
CloneTime String Clone time.
Note: This field may return null, indicating that no valid values can be obtained.
CloneType String Clone type.
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
DBType String Engine type.
Note: This field may return null, indicating that no valid values can be obtained.
Region String Region.
Note: This field may return null, indicating that no valid values can be obtained.
SourceInstanceId String Source instance ID.
Note: This field may return null, indicating that no valid values can be obtained.

ConstraintRange

Value range of the constraint type.

Used by actions: DescribeDBParameters.

Name Type Description
Min String Minimum value when the constraint type is section.
Max String Specifies the maximum value when the constraint type is section.

DBEngineInfo

Database engine information

Used by actions: DescribeDBEngines.

Name Type Description
Type String

Engine type
Version String

Engine version
Name String

Engine name
Description String

Engine description
New Boolean

Whether it is the latest version
SQLMode Array of String

Supported compatible modes, separated by commas
IsSupportParamTemplate Boolean

Whether parameter template is supported
IsSupportServerless Boolean

Whether Serverless mode is supported

DBParamValue

Cloud database parameter information.

Used by actions: ModifyDBParameters.

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

DataBackupStatisticsModel

Data backup statistics object

Used by actions: DescribeDBSBackupStatistics.

Name Type Description
AutoBackupCount Integer Auto-backup count
Note: This field may return null, indicating that no valid values can be obtained.
AutoBackupSize Integer Auto-backup size, in Byte
Note: This field may return null, indicating that no valid values can be obtained.
AverageSizePerBackup Integer Avg backup size per each, in Byte
Note: This field may return null, indicating that no valid values can be obtained.
AverageSizePerDay Integer Avg daily backup size, Byte
Note: This field may return null, indicating that no valid values can be obtained.
ManualBackupCount Integer Manual backup count
Note: This field may return null, indicating that no valid values can be obtained.
ManualBackupSize Integer Manual backup size, in Byte
Note: This field may return null, indicating that no valid values can be obtained.
TotalCount Integer Number of data backups
Note: This field may return null, indicating that no valid values can be obtained.
TotalSize Integer Data backup size, in Byte
Note: This field may return null, indicating that no valid values can be obtained.

Database

Database information

Used by actions: DescribeDatabases.

Name Type Description
DbName String Database name.

DatabaseFunction

Database function information.

Used by actions: DescribeDatabaseObjects.

Name Type Description
Func String Function name.

DatabasePrivileges

Database-level permission list

Used by actions: ModifyUserPrivileges.

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

DatabaseProcedure

Database stored procedure information.

Used by actions: DescribeDatabaseObjects.

Name Type Description
Proc String Stored procedure name.

DatabaseTable

Database table information.

Used by actions: DescribeDatabaseObjects.

Name Type Description
Table String Table name

DatabaseView

Database view information.

Used by actions: DescribeDatabaseObjects.

Name Type Description
View String View name.

DescribeSaleRegionInfo

Query the sales API. The return type is region information.

Used by actions: DescribeSaleInfo.

Name Type Description
Region String

English string of Region
ZoneList Array of DescribeSaleZonesInfo

Purchasable Zone list
RegionName String

Region Chinese character string
Enable Integer

Whether to sell. 1: sell, 0: do not sell
AvailableZoneNum Integer

Optional quantity of multiple availability


Note: This field may return null, indicating that no valid values can be obtained.
IsSupportedLogReplica Boolean

Whether to allow usage log replica


Note: This field may return null, indicating that no valid values can be obtained.
ZoneGroup Array of DescribeSaleZonesGroup

Availability zone combination
IsSupportServerless Boolean

Whether serverless is supported

DescribeSaleZonesGroup

Query sales regions and recommend availability zone combinations

Used by actions: DescribeSaleInfo.

Name Type Description
ZoneNum Integer

Number of availability zones
Zones Array of String

Availability zone combination
SupportTypes Array of String

Supported types
AvailableDiskTypes Array of String

Supported disk

Enumeration value:

  • CLOUD_TCS: Local disk
  • CLOUD_HSSD: Enhanced cloud disk

Note: This field may return null, indicating that no valid values can be obtained.
IsSupportServerless Boolean

Whether serverless is supported

DescribeSaleZonesInfo

Query the sales API. The return type is zone information.

Used by actions: DescribeSaleInfo.

Name Type Description
Zone String

English string of Zone
ZoneName String

Zone Chinese character string
Enable Integer

Whether to sell, 1: sell; 0: do not sell
IsDefaultMaster Integer

Whether the default primary AZ is used. 0 means no, 1 means yes.


Note: This field may return null, indicating that no valid values can be obtained.
AvailableDiskTypes Array of String

Selectable disk types in availability zones


Note: This field may return null, indicating that no valid values can be obtained.
SupportTypes Array of String

Whether it is an exclusive availability zone
IsSupportServerless Boolean

Whether serverless is supported

Explain

Execution plan

Used by actions: DescribeSlowLogs.

Name Type Required Description
ID String No

Identifier


Note: This field may return null, indicating that no valid values can be obtained.
SelectType String No

Query type

Enumeration value:

  • SIMPLE: A regular query with no subquery and UNION. Single table or ordinary JOIN is SIMPLE.

Note: This field may return null, indicating that no valid values can be obtained.
Table String No

Table name


Note: This field may return null, indicating that no valid values can be obtained.
Partitions String No

Partition


Note: This field may return null, indicating that no valid values can be obtained.
Type String No

Access type


Note: This field may return null, indicating that no valid values can be obtained.
PossibleKeys String No

Possibly used indexes


Note: This field may return null, indicating that no valid values can be obtained.
Key String No

Used Indexes


Note: This field may return null, indicating that no valid values can be obtained.
KeyLen String No

Used Indexes length


Note: This field may return null, indicating that no valid values can be obtained.
Ref String No

Column or constant to compare with the index


Note: This field may return null, indicating that no valid values can be obtained.
Rows String No

Estimate the number of scanned rows


Note: This field may return null, indicating that no valid values can be obtained.
Filtered String No

Estimated percentage of remaining rows after conditional filtering


Note: This field may return null, indicating that no valid values can be obtained.
Extra String No

Additional information, such as Using index, Using filesort


Note: This field may return null, indicating that no valid values can be obtained.

FlowType

Task type information for frontend dropdown filtering

Used by actions: DescribeFlowTypes.

Name Type Description
FlowName String

Task Type Name. Subsequently, you can filter FlowName in the output parameters of DescribeFlows.
FlowDesc String

Chinese description of the task type.

InstanceFilter

List filter criteria for instances

Used by actions: DescribeDBInstances.

Name Type Required Description
Name String No Filter key, support InstanceId, VpcId, SubnetId, Vip, Vport, Status, InstanceName, TagKey.
Values Array of String No Filter value.

InstanceInfo

Instance information type

Used by actions: DescribeDBInstances.

Name Type Description
Zone String

Region
CreateVersion String

Create an instance version
InitParams Array of InstanceParam

Initialize instance parameters
Status String

Instance status: creating, created, initializing, running, modifying, isolating, isolated, destroying, destroyed
InstanceId String

Instance id
StorageNodeNum Integer

Number of storage nodes
ResourceTags Array of ResourceTag

Instance tag information.
InstanceName String

Instance name
VpcId String

Character type vpcid
Vip String

Subnet IP
SubnetId String

Character type subnetid
Vport Integer

Subnet port
Disk Integer

Node disk capacity (unit: GB)
CreateTime String

Instance Creation Time
Region String

Region of the instance
StatusDesc String

Status description in Chinese of the instance
StorageNodeCpu Integer

CPU cores of the storage node
StorageNodeMem Integer

Storage node memory size
RenewFlag Integer

Renewal flag
PayMode String

Payment mode, 0 pay-as-you-go; 1 annual/monthly subscription
AccountTag String

User tag, inner: internal user; external: external user
InstanceType String

Instance Architecture Type, separate: decoupled architecture; hyper: peer-to-peer architecture
StorageType String

Disk Type, CLOUD_HSSD enhanced SSD, CLOUD_TCS local SSD disk
DestroyedAt String

"0000-00-00 00:00:00"
ExpireAt String

"0000-00-00 00:00:00"
IsolatedAt String

"0000-00-00 00:00:00"
IsolatedFrom String

"0000-00-00 00:00:00"
Replications Integer

1
FullReplications Integer

Number of replicas
AppId Integer

Account information
SubAccountUin String

Account information
Uin String

Account information
Zones Array of String

AZ information
Nodes Array of InstanceNode

Instance node
BinlogStatus Integer

Whether binlog is on
AZMode Integer

az mode. 1: Single az 2: Multi-az non-primary az mode 3: Multi-az primary az mode
StandbyFlag Integer

Disaster recovery flag. 1: No disaster recovery relationship; 2: Primary instance for disaster recovery; 3: Disaster Recovery Standby Instance
StandbySecondaryNum Integer

Number of connected standby instances (Valid only when StandbyFlag == 2)
ColumnarNodeCpu Integer

cpu cores of the columnar node
ColumnarNodeMem Integer

Columnar node memory size
ColumnarNodeNum Integer

Number of columnar nodes
ColumnarNodeDisk Integer

Columnar node disk capacity (unit: GB)
ColumnarNodeStorageType String

Columnar node disk type
InstanceCategory Integer

Exclusive flags, 1: Primary instance (dedicated), 2: Primary instance, 3: Disaster recovery instance, 4: Disaster recovery instance (dedicated)
ExclusiveClusterId String

dbdc-xxxxx
SQLMode String

Compatible mode
InstanceMode String

Instance mode
AutoScaleConfig AutoScalingConfig

Auto-scaling configuration
AnalysisMode String

Analytical engine mode

Enumeration value:

  • libra: LibraDB analytical engine mode
AnalysisRelationInfos Array of AnalysisRelationInfo

Analysis engine relationship information
AnalysisInstanceInfo AnalysisInstanceInfo

Analysis engine instance information
AutoScaleConfigs Array of AutoScalingConfig

Multiple automatic configuration adjustment configurations of the instance, including ccu and nodecount values

InstanceNode

Node information

Used by actions: DescribeDBInstances.

Name Type Required Description
ID Integer No Primary key
InstanceId String No Instance ID.
NodeId String No Node Id
Ip String No Instance Ip
EniIp String No Instance EniIp
Port Integer No Instance Port
SpecCode String No Instance SpecCode
NodeName String No Instance NodeName
Cpu Integer No Instance Cpu
Mem Integer No Instance memory
Disk Integer No Instance Disk
Type String No Instance type
Status String No Instance status
Version String No Instance version
Zone String No Instance region
LocalDNS String No Instance LocalDNS
Region String No Instance Region
LogDisk Integer No Instance log disk
DataDisk Integer No Instance data disk
ZoneID String No Instance Zone ID
SpecName String No Instance SpecName
Replicas Integer No Instance Replicas
Shards Integer No Instance Shards
DataReplicas Integer No Instance data replica
Params String No Instance initialization parameter
StorageType String No Storage medium, CLOUD_PREMIUM: Premium Cloud Disk, CLOUD_SSD: SSD cloud disk, CLOUD_HSSD: HSSD cloud disk

InstanceParam

Initialize instance parameters

Used by actions: CreateDBInstances, DescribeDBInstanceDetail, DescribeDBInstances.

Name Type Required Description
Param String Yes config key
Value String Yes Config value

LogBackupStatisticsModel

Backup statistics object for logs

Used by actions: DescribeDBSBackupStatistics.

Name Type Description
AverageSizePerBackup Integer

Avg size of each log backup in Byte


Note: This field may return null, indicating that no valid values can be obtained.
AverageSizePerDay Integer

Avg daily log backup size in Byte


Note: This field may return null, indicating that no valid values can be obtained.
TotalCount Integer

Number of log backups


Note: This field may return null, indicating that no valid values can be obtained.
TotalSize Integer

Log backup size in Byte


Note: This field may return null, indicating that no valid values can be obtained.

LogFilter

Slow log filtering

Used by actions: DescribeSlowLogs.

Name Type Required Description
Type String No Filter criterion name.

For example: sql - SQL command details

host - client IP
user - database account;
dbName – Database name;
sqlType - SQL type;
Error code

execTime - Execution time
lockWaitTime - Lock waiting time
ioWaitTime - IO wait time
trxLivingTime - Transaction execution time
Cpu time

threadId - Thread ID
trxId - Transaction ID
checkRows - Number of scanned rows
affectRows - Number of rows affected
sentRows - Number of rows returned
Compare String No Filter condition match type. Supported:
INC – Includes (multiple values are in a || relationship before).
EXC - excluding (multiple values are in an && relationship)
EQS – equal to (multiple values before are in a || relationship).
NEQ – not equal to (multiple values are in && relationship)

RG - Range;
Value Array of String No Filter condition matching value. When Compare=RG, for example ["1-100","200-300"].

MaintenanceWindowInfo

Maintenance window configuration

Used by actions: DescribeDBInstanceDetail.

Name Type Required Description
StartTime Integer No
Duration Integer No
WeekDays Array of String No

NodeInfo

Node information type

Used by actions: DescribeDBInstanceDetail.

Name Type Description
IP String

Node IP information
Type String

Node types, such as sqlengine, tdstore, mc
NodeId String

Unique identifier of the node
Port Integer

Node port information
Zone String

Availability zone of the node
Host String

Machine ip of the node
BinlogInfo Array of BinlogInfo

Node log service information
Cpu Integer

Number of CPUs of the node
Mem Integer

Node mem size
DataDisk Integer

Node disk size

ParamConstraint

Parameter constraints.

Used by actions: DescribeDBParameters.

Name Type Description
Type String Constraint type, for example enumeration, interval.
Enum String Lists the available options when the constraint type is enum.
Note: This field may return null, indicating that no valid values can be obtained.
Range ConstraintRange Value range when the constraint type is section.
Note: This field may return null, indicating that no valid values can be obtained.
String String Valid values when the constraint type is string.
Note: This field may return null, indicating that no valid values can be obtained.

ParamDesc

DB parameter description.

Used by actions: DescribeDBParameters.

Name Type Description
Param String Parameter name.
Value String Current parameter value.
SetValue String The configured value is the same as the value once the parameter takes effect.
Note: This field may return null, indicating that no valid values can be obtained.
Default String System default value.
Constraint ParamConstraint Parameter limits.
Note: This field may return null, indicating that no valid values can be obtained.
HaveSetValue Boolean Whether a value has been set. false: not set. true: has set.
NeedRestart Boolean true: restart required.
Description String Parameter description.
Note: This field may return null, indicating that no valid values can be obtained.

ResetUserPasswordInfo

User type for password reset

Used by actions: ResetUsersPassword.

Name Type Required Description
UserName String No

Username.
Host String No

host
Password String No

plaintext password
EncryptedPassword String No

Encryption password

ResourceTag

tag parameter

Used by actions: CreateCloneInstance, CreateDBInstances, CreateStandbyDBInstance, DescribeDBInstanceDetail, DescribeDBInstances.

Name Type Required Description
TagKey String No Tag key
TagValue String No Tag value

SecurityGroup

Security group details.

Used by actions: DescribeDBSecurityGroups.

Name Type Description
ProjectId Integer Project ID.
CreateTime String CreationTime, time format: 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.

SecurityGroupBound

Inbound and outbound rules.

Used by actions: DescribeDBSecurityGroups.

Name Type Description
CidrIp String Source IP or IP range, such as 192.168.0.0/16.
Action String Policy, ACCEPT or DROP.
PortRange String Port.
IpProtocol String Network protocol, supports UDP, TCP.

ServerlessCcu

ccu specification of a serverless instance

Used by actions: DescribeSpecs.

Name Type Description
MinCcu Float

ccu minimum value
MaxCcu Array of Float

Maximum value of ccu

ServerlessNodeNumSpec

Upper and lower limit of the hybrid node quantity allowed for adjustment for a Serverless instance

Used by actions: DescribeSpecs.

Name Type Required Description
MinNodeNum Integer No

Minimum number of nodes.
MaxNodeNum Integer No

Maximum number of nodes.

SlowLogData

slow log information

Used by actions: DescribeSlowLogs.

Name Type Description
Timestamp String

Sql execution time


Note: This field may return null, indicating that no valid values can be obtained.
QueryTime Float

Sql execution duration (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 IP 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 (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

Result set row count


Note: This field may return null, indicating that no valid values can be obtained.
TransactionId String

Transaction ID


Note: This field may return null, indicating that no valid values can be obtained.
RpcTime Float

rpc duration


Note: This field may return null, indicating that no valid values can be obtained.
StorageRpcTime Float

rpc duration for node interaction with storage


Note: This field may return null, indicating that no valid values can be obtained.
RpcRetryDelayTime Float

rpc retry latency


Note: This field may return null, indicating that no valid values can be obtained.
NodeId String

node Name


Note: This field may return null, indicating that no valid values can be obtained.
RpcTrace String

rpc link tracing


Note: This field may return null, indicating that no valid values can be obtained.
TDStoreLockTime Float

TDStore lock duration

Unit: seconds


Note: This field may return null, indicating that no valid values can be obtained.
TraceId String

Global ID


Note: This field may return null, indicating that no valid values can be obtained.
Explain Array of Explain

Execution plan


Note: This field may return null, indicating that no valid values can be obtained.

StandbyDBInstanceRelation

Disaster recovery instance relationship

Used by actions: DescribeStandbyDBInstanceRelationDetail.

Name Type Description
PrimaryInstanceId String Primary instance ID
PrimaryInstanceName String Primary instance name
PrimaryRegion String Region of the primary instance
PrimaryVip String Subnet IP of the primary instance
PrimaryVport Integer Port of the primary instance subnet
PrimaryZones Array of String Primary instance AZ
PrimaryStatus String Primary instance running status
SecondaryInstanceId String Disaster Recovery instance ID
SecondaryInstanceName String Disaster Recovery instance name
SecondaryRegion String Region of the standby instance
SecondaryVip String Subnet IP of the Disaster Recovery instance
SecondaryVport Integer Port of the Disaster Recovery instance subnet
SecondaryZones Array of String Disaster Recovery instance availability zone
SecondaryStatus String Disaster Recovery instance running status
ConnType String Connection type. Valid values: log_service, raft.
SyncMode String Synchronization type. Valid values: sync and async.
SyncStatus Integer Synchronization status. 1: synchronizing; 2: sync exception
SyncStatusDesc String Synchronization status description. Error information when the synchronization status is abnormal.
StandbyStatus String Disaster recovery status description. Valid values: "creating", "running", "modifying". Empty if no disaster recovery relationship exists.
PrimaryCreateVersion String Primary instance version
SecondaryCreateVersion String Disaster Recovery instance version
SyncDelay Integer Latency in seconds

StorageNodeSpec

Node specification for storage

Used by actions: DescribeSpecs.

Name Type Description
SpecCode String

Specification code
StorageNodeCpu Integer

CPU cores of the storage node
StorageNodeMem Integer

Storage node memory size
StorageNodeMaxNum Integer

Maximum quantity of storage nodes
StorageNodeMaxDisk Integer

Node disk size capacity limit
StorageNodeMinNum Integer

Minimum number of storage nodes
StorageNodeMinDisk Integer

Node disk size minimum
StorageType String

Disk Type, CLOUD_HSSD enhanced SSD, CLOUD_TCS local SSD disk
StorageNodeDefaultDisk Integer

Default disk size of storage node for frontend display
InstanceMode Array of String

Specification support billing mode list
DiskTypeCategory String

Disk Type CLOUD_DISK: cloud disk LOCAL_DISK: local disk

TablePrivileges

Table-level permissions

Used by actions: ModifyUserPrivileges.

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

User

Database account information

Used by actions: CreateUsers, DeleteUsers, ModifyUserPrivileges.

Name Type Required Description
UserName String Yes Username.
Host String Yes host

UserInfo

User information type

Used by actions: DescribeUsers.

Name Type Description
UserName String Username.
Description String User description
Note: This field may return null, indicating that no valid values can be obtained.
Host String Host IP, IP range ending with % to denote permission for all IPs in the range
CreateTime String Creation time.
UpdateTime String Update time
이전 주제: DescribeSpecs다음 주제: Error Codes

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백

키워드로 검색
    Enter keywords to search documentation