tencent cloud

APIs

DokumentasiAPIsTDSQL BoundlessData Types

Data Types

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-05-27 16:18:13

AnalysisInstanceInfo

Analytics engine instance info

Used by actions: DescribeDBInstanceDetail.

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

ccu range of a serverless instance

Used by actions: CreateDBInstances, DescribeDBInstanceDetail, DescribeDBInstances.

Name Type Required Description
RangeMin Float Yes

Minimum value of ccu


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

Maximum value of ccu


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

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

Backup end time.
BackupMethod String No

Backup method: physical physical backup, snapshot snapshot backup
BackupStartTime String No

Backup start time
EnableFull Integer No

Whether full backup is enabled
EnableLog Integer No

Whether to enable log backup
FullRetentionPeriod Integer No

Full backup retention time can currently only be set to 7 days.
InstanceId String No

Instance ID.
LogRetentionPeriod Integer No

Log retention days. currently, can only set retention to 7 days.
PeriodTime String No

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.

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

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

Creating an Instance Version


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

Initialize instance parameter


Note: This field may return null, indicating that no valid values can be obtained.
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


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

Instance name


Note: This field may return null, indicating that no valid values can be obtained.
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


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

Storage node memory size


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

Renewal flag


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

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

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


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

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


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

Disk Type, CLOUD_HSSD enhanced SSD, CLOUD_TCS local SSD disk


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

"0000-00-00 00:00:00"


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

"0000-00-00 00:00:00"


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

"0000-00-00 00:00:00"


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

"0000-00-00 00:00:00"


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

1


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

Number of replicas
AppId Integer

Account information


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

Account information


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

Account information


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

AZ information


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

Instance node


Note: This field may return null, indicating that no valid values can be obtained.
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


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

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


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

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


Note: This field may return null, indicating that no valid values can be obtained.
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

InstanceNode

Node information

Used by actions: DescribeDBInstances.

Name Type Required Description
ID Integer No Primary key
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.
NodeId String No Node Id
Note: This field may return null, indicating that no valid values can be obtained.
Ip String No Instance Ip
Note: This field may return null, indicating that no valid values can be obtained.
EniIp String No Eni IP of the instance
Note: This field may return null, indicating that no valid values can be obtained.
Port Integer No Instance Port
Note: This field may return null, indicating that no valid values can be obtained.
SpecCode String No Instance SpecCode
Note: This field may return null, indicating that no valid values can be obtained.
NodeName String No Instance NodeName
Note: This field may return null, indicating that no valid values can be obtained.
Cpu Integer No Instance Cpu
Note: This field may return null, indicating that no valid values can be obtained.
Mem Integer No Instance memory
Note: This field may return null, indicating that no valid values can be obtained.
Disk Integer No Instance Disk
Note: This field may return null, indicating that no valid values can be obtained.
Type String No Instance type
Note: This field may return null, indicating that no valid values can be obtained.
Status String No Instance status
Note: This field may return null, indicating that no valid values can be obtained.
Version String No instance version
Note: This field may return null, indicating that no valid values can be obtained.
Zone String No Region
Note: This field may return null, indicating that no valid values can be obtained.
LocalDNS String No Instance LocalDNS
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.
LogDisk Integer No Instance log disk
Note: This field may return null, indicating that no valid values can be obtained.
DataDisk Integer No Instance data disk
Note: This field may return null, indicating that no valid values can be obtained.
ZoneID String No Zone ID of the instance
Note: This field may return null, indicating that no valid values can be obtained.
SpecName String No Instance SpecName
Note: This field may return null, indicating that no valid values can be obtained.
Replicas Integer No Instance Replicas
Note: This field may return null, indicating that no valid values can be obtained.
Shards Integer No Instance Shards
Note: This field may return null, indicating that no valid values can be obtained.
DataReplicas Integer No Instance data replica
Note: This field may return null, indicating that no valid values can be obtained.
Params String No Initialize parameter
Note: This field may return null, indicating that no valid values can be obtained.
StorageType String No Storage medium, CLOUD_PREMIUM: Premium Cloud Disk, CLOUD_SSD: SSD cloud disk, CLOUD_HSSD: HSSD cloud disk
Note: This field may return null, indicating that no valid values can be obtained.

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.

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


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

Node types, such as sqlengine, tdstore, mc


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

Unique identifier of the node


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

Node port information


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

Availability zone of the node


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

Machine ip of the node


Note: This field may return null, indicating that no valid values can be obtained.
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.

ResourceTag

tag parameter

Used by actions: CreateCloneInstance, CreateDBInstances, 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 Integer

ccu minimum value
MaxCcu Array of Integer

Maximum value of ccu

StorageNodeSpec

Node specification for storage

Used by actions: DescribeSpecs.

Name Type Description
SpecCode String

Specification code


Note: This field may return null, indicating that no valid values can be obtained.
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


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

Default disk size of storage node for frontend display


Note: This field may return null, indicating that no valid values can be obtained.
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: 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
Topik sebelumnya: DescribeSpecsTopik selanjutnya: Error Codes

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan