tencent cloud

Data Types
Last updated: 2025-11-07 10:57:12
Data Types
Last updated: 2025-11-07 10:57:12

Ability

Features supported by the cluster

Used by actions: DescribeClusterDetail, DescribeClusters.

Name Type Required Description
IsSupportSlaveZone String Yes Whether secondary AZ is supported
NonsupportSlaveZoneReason String Yes The causes for no support from an availability zone.
IsSupportRo String Yes Whether read-only instance is supported
NonsupportRoReason String Yes Reasons why RO instances are not supported.
IsSupportManualSnapshot String Yes Whether manual snapshot backup initiation is supported.
IsSupportTransparentDataEncryption String No Whether transparent data encryption is supported.
NoSupportTransparentDataEncryptionReason String No Reasons for no support of transparent data encryption.
IsSupportManualLogic String No Whether manual initiation of logical backup is supported.

Account

Database account information

Used by actions: DescribeAccounts.

Name Type Description
AccountName String Database account name
Description String Database account description
CreateTime Timestamp Creation time
UpdateTime Timestamp Update time
Host String Host
MaxUserConnections Integer The max connections

Addr

Database address

Used by actions: DescribeClusterDetail.

Name Type Description
IP String IP address
Port Integer Port

AuditInstanceFilters

Used by actions: DescribeAuditInstanceList.

Name Type Required Description
Name String Yes
ExactMatch Boolean Yes
Values Array of String Yes

AuditInstanceInfo

Used by actions: DescribeAuditInstanceList.

Name Type Description
ProjectId Integer Project ID.
TagList Array of Tag Tag information

AuditRuleFilters

Filter of rule audit

Used by actions: DescribeAuditRuleWithInstanceIds, ModifyAuditService.

Name Type Required Description
RuleFilters Array of RuleFilters Yes A single audit rule.

AuditRuleTemplateInfo

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 of the rule template
Description String Rule template description.
CreateAt String Creation time of a rule template
UpdateAt String Rule template modification time.
AlarmLevel Integer Alarm level. valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
AlarmPolicy Integer Alarm policy. 0 - no alert, 1 - alert.
Status Integer Template status. 0 - no task, 1 - modifying.
AffectedInstances Array of String Template application is used in which instances.

BackupFileInfo

Backup file information

Used by actions: DescribeBackupList.

Name Type Description
SnapshotId Integer Snapshot file ID, which is deprecated. You need to use BackupId.
FileName String Backup file name
FileSize Integer Backup file size
StartTime String Backup start time
FinishTime String Backup end time
BackupType String Backup type. Valid values: snapshot (snapshot backup), logic (logic backup).
BackupMethod String Back mode. auto: auto backup; manual: manual backup
BackupStatus String Backup file status. success: backup succeeded; fail: backup failed; creating: creating backup file; deleting: deleting backup file
SnapshotTime String Backup file time
BackupId Integer Backup ID.
SnapShotType String Specifies the snapshot type. valid values: full (full snapshot); increment (incremental snapshot).
BackupName String Specifies the remark of the backup file.

BackupLimitClusterRestriction

Specifies the backup download cluster restrictions parameter.

Used by actions: DescribeBackupDownloadRestriction, DescribeBackupDownloadUserRestriction.

Name Type Required Description
ClusterId String No Cluster ID
BackupLimitRestriction BackupLimitRestriction No Download limit configuration.

BackupLimitRestriction

Specifies the backup download limit parameter.

Used by actions: DescribeBackupDownloadRestriction, DescribeBackupDownloadUrl, DescribeBackupDownloadUserRestriction, DescribeBinlogDownloadUrl.

Name Type Required Description
LimitType String No Restriction type.
VpcComparisonSymbol String No This parameter only supports In, which indicates that the vpc specified by LimitVpc can be downloaded. the default is In.
IpComparisonSymbol String No Specified ips can download; specified ips are not allowed to download.
LimitVpcs Array of BackupLimitVpcItem No Specifies the vpc setting for download restrictions.
Note: This field may return null, indicating that no valid values can be obtained.
LimitIps Array of String No Specifies the ip settings for limiting downloads.
Note: This field may return null, indicating that no valid values can be obtained.

BackupLimitVpcItem

VPC settings for restricting backup download sources.

Used by actions: DescribeBackupDownloadUrl, DescribeBinlogDownloadUrl, ModifyBackupDownloadRestriction, ModifyBackupDownloadUserRestriction.

Name Type Required Description
Region String No Specifies the region for limiting download sources. currently only supports the current region.
VpcList Array of String No Limit the vpc list for downloads.

BillingResourceInfo

Billable resource information

Used by actions: DescribeResourcesByDealName.

Name Type Description
ClusterId String Cluster ID
InstanceIds Array of String Instance ID list
DealName String Order ID

BindInstanceInfo

Information of the instance bound to the resource pack

Used by actions: DescribeResourcePackageList.

Name Type Description
InstanceId String ID of the bound cluster.
InstanceRegion String The region where the bound instance is located.
InstanceType String Type of the bound instance.
ExtendIds Array of String The instance ID under the bound cluster.

BinlogConfigInfo

Specifies the binlog configuration message.

Used by actions: DescribeBinlogConfig, ModifyBinlogConfig.

Name Type Required Description
BinlogSaveDays Integer Yes Specifies the retention time of binlogs.
BinlogCrossRegionsEnable String Yes Whether binlog cross-region backup is enabled.
BinlogCrossRegions Array of String No binlog in a different region.
Note: This field may return null, indicating that no valid values can be obtained.

BinlogItem

Binlog description

Used by actions: DescribeBinlogs.

Name Type Description
FileName String Binlog filename
FileSize Integer File size in bytes
StartTime String Transaction start time
FinishTime String Transaction end time
BinlogId Integer Binlog file ID

BizTaskInfo

Used by actions: DescribeTasks.

Name Type Description
ID Integer
AppId Integer
ClusterId String
Region String Region
CreateTime String
DelayTime String Specifies the delayed execution time.
ErrMsg String Task failure information.
FlowId Integer
Input String
InstanceGroupId String
InstanceId String
ObjectId String
ObjectType String
Operator String
Output String
Status String
TaskType String
TriggerTaskId Integer
UpdateTime String
StartTime String
EndTime String
ClusterName String
InstanceName String
Process Integer
CreateClustersData CreateClustersData Create cluster task information.
RollbackData RollbackData Cluster rollback task information.
ModifyInstanceData ModifyInstanceData Instance configuration change task information.
ManualBackupData ManualBackupData
ModifyDbVersionData ModifyDbVersionData Modify kernel version task information.
ClusterSlaveData ClusterSlaveData Cluster availability zone information.
SwitchClusterLogBin SwitchClusterLogBin
ModifyInstanceParamsData BizTaskModifyParamsData
TaskMaintainInfo TaskMaintainInfo Maintenance time.
InstanceCLSDeliveryInfos Array of InstanceCLSDeliveryInfo Instance log delivery information.
TaskProgressInfo TaskProgressInfo Task progress information.

BizTaskModifyInstanceParam

Used by actions: DescribeTasks.

Name Type Description
InstanceId String
ModifyInstanceParamList Array of ModifyParamItem Details of instance parameter modification task.

BizTaskModifyParamsData

Used by actions: DescribeTasks.

Name Type Description
ClusterId String
ClusterParamList Array of ModifyParamItem Cluster parameter modification data.
ModifyInstanceParams Array of BizTaskModifyInstanceParam Instance parameter modification data.

CLSInfo

Used by actions: CreateCLSDelivery.

Name Type Required Description
TopicOperation String Yes
GroupOperation String Yes
Region String Yes
TopicId String No
TopicName String No
GroupId String No
GroupName String No

ClusterInstanceDetail

Cluster instance information

Used by actions: DescribeClusterDetail.

Name Type Description
InstanceId String Instance ID
InstanceName String Instance name
InstanceType String Engine type
InstanceStatus String Instance status
InstanceStatusDesc String Instance status description
InstanceCpu Integer Number of CPU cores
InstanceMemory Integer Memory
InstanceStorage Integer Disk
InstanceRole String Instance role
MaintainStartTime Integer Execution start time (seconds from 0 o'clock).
MaintainDuration Integer Specifies the continuous time. the unit is second.
MaintainWeekDays Array of String Specifies the time when it can be executed. valid values: ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"].
ServerlessStatus String serverless instance substatus.
InstanceTasks Array of ObjectTask Instance task information.
InstanceDeviceType String Instance machine type.
InstanceStorageType String Instance storage type.
DbMode String Database type.
NodeList Array of String Node list

ClusterReadOnlyValue

Cluster read-only switch list.

Used by actions: DescribeClusterReadOnly.

Name Type Description
ClusterId String Cluster ID
ReadOnlyValue String Specifies the value of the read-only switch.

ClusterSlaveData

Used by actions: DescribeTasks.

Name Type Description
OldMasterZone String Old primary availability zone.
OldSlaveZone Array of String
NewMasterZone String New primary availability zone.
NewSlaveZone Array of String
NewSlaveZoneAttr Array of SlaveZoneAttrItem New from availability zone attribute.
OldSlaveZoneAttr Array of SlaveZoneAttrItem Old availability zone attributes.

ClusterTaskId

Cluster task ID.

Used by actions: ModifyClusterReadOnly.

Name Type Description
ClusterId String Cluster ID
TaskId String Task ID

CreateClustersData

Used by actions: DescribeTasks.

Name Type Description
Cpu Integer
Memory Integer
StorageLimit Integer

CrossRegionBackupItem

Cross-Region backup describes the backup information in each region.

Used by actions: DescribeTasks.

Name Type Description
CrossRegion String Target region for backup.
BackupId Integer Target region's backup task ID.
BackupStatus String Backup status in the target region.

CynosdbCluster

Cluster information

Used by actions: DescribeClusters.

Name Type Required Description
Status String Yes Cluster status. Valid values are as follows:
creating
running
isolating
isolated
activating (removing isolation)
offlining (deactivating)
offlined (deactivated)
deleting
deleted
UpdateTime String Yes Update time
Zone String Yes AZ
ClusterName String Yes Cluster name
Region String Yes Region
DbVersion String Yes Database version
ClusterId String Yes Cluster ID
InstanceNum Integer Yes Number of instances
Uin String Yes User UIN
DbType String Yes Engine type.
AppId Integer Yes User appid.
StatusDesc String Yes Cluster status description
CreateTime String Yes Cluster Creation Time
PayMode Integer Yes Payment mode. 0: pay-as-you-go; 1: monthly subscription.
PeriodEndTime String Yes Expiration time.
Vip String Yes Cluster read/write vip.
Vport Integer Yes Cluster read/write vport.
ProjectID Integer Yes Project ID
VpcId String No Specifies the virtual private cloud ID.
SubnetId String No Specifies the subnet ID.
CynosVersion String No Specifies the cynos kernel version.
StorageLimit Integer No Specifies the storage capacity.
RenewFlag Integer No Renewal Flag
ProcessingTask String No Task being processed.
Tasks Array of ObjectTask No Task array of the cluster.
ResourceTags Array of Tag No Array of tags bound to the cluster.
DbMode String No Db type (NORMAL, SERVERLESS).
ServerlessStatus String No Specifies the status of the SERVERLESS cluster when the Db type is SERVERLESS. valid values:.
resume
pause
Storage Integer No Cluster prepaid storage size.
StorageId String No Cluster storage ID for prepaid storage, specifies the storage ID used for prepaid storage modification.
StoragePayMode Integer No Cluster storage payment mode. 0: pay-as-you-go; 1: monthly subscription.
MinStorageSize Integer No Minimum storage value corresponding to cluster computing specifications.
MaxStorageSize Integer No The maximum storage value corresponding to the cluster computing specification.
NetAddrs Array of NetAddr No Specifies the cluster network information.
PhysicalZone String No Physical availability zone.
MasterZone String No Primary AZ.
HasSlaveZone String No Whether there is an availability zone.
SlaveZones Array of String No Secondary AZ.
BusinessType String No Business type.
IsFreeze String No Whether to freeze.
OrderSource String No Order Source
Ability Ability No Capacity.
ResourcePackages Array of ResourcePackage No Specifies the information of the resource package bound to the instance (only the storage resource package is returned here, that is, packageType=DISK).

CynosdbClusterDetail

Cluster details

Used by actions: DescribeClusterDetail.

Name Type Description
ClusterId String Cluster ID
ClusterName String Cluster name
Region String Region
Zone String AZ
PhysicalZone String Physical availability zone.
Status String Status
StatusDesc String Status description
ServerlessStatus String Serverless cluster status when the database type is SERVERLESS. Valid values:
resume
resuming
pause
pausing
StorageId String Storage Id.
Storage Integer Storage size in gb.
MaxStorageSize Integer Maximum storage specification, in gb.
MinStorageSize Integer Specifies the minimum storage specification, in gb.
StoragePayMode Integer Storage billing type. 1 indicates monthly subscription, and 0 indicates pay-as-you-go.
VpcName String VPC name
VpcId String Unique VPC ID
SubnetName String Subnet name
SubnetId String Subnet ID
Charset String Character set
CreateTime String Creation time
DbType String Database type
DbMode String Db type:
  • NORMAL
  • SERVERLESS
    • .
    DbVersion String Database version
    StorageLimit Integer Specifies the maximum storage space.
    UsedStorage Integer Used capacity
    Vip String VIP
    Vport Integer vport
    RoAddr Array of Addr VIP and vport of the read-only instance in a cluster
    Ability Ability Functions supported by the cluster.
    CynosVersion String Specifies the cynos version.
    BusinessType String Business type.
    HasSlaveZone String Whether there is an availability zone.
    IsFreeze String Whether to freeze.
    Tasks Array of ObjectTask Task list.
    MasterZone String Primary AZ.
    SlaveZones Array of String Availability zone list.
    InstanceSet Array of ClusterInstanceDetail Instance information
    PayMode Integer Billing mode
    PeriodEndTime String Expiration time
    ProjectID Integer Project ID
    ResourceTags Array of Tag Array of tags bound to instance
    ProxyStatus String Proxy status.
    LogBin String binlog switch. valid values: ON, OFF.
    IsSkipTrade String Specifies whether to skip the transaction.
    PitrType String PITR type: valid values: normal, redo_pitr.
    IsOpenPasswordComplexity String Whether to enable password complexity.
    NetworkStatus String Network type.
    ResourcePackages Array of ResourcePackage The resource package information that is bound to the cluster.
    RenewFlag Integer Auto-Renewal flag. 1 indicates auto-renewal. 0 indicates non-renewal upon expiration.
    NetworkType String Specifies the node network type.
    SlaveZoneAttr Array of SlaveZoneAttrItem Secondary availability zone property.
    CynosVersionTag String Version Tag.

    CynosdbErrorLogItem

    Types of the returned error logs for an instance

    Used by actions: DescribeInstanceErrorLogs.

    Name Type Description
    Timestamp Integer Log timestamp.
    Level String Log level.
    Content String Log content.

    CynosdbInstance

    Instance information

    Used by actions: DescribeInstances, DescribeIsolatedInstances.

    Name Type Description
    Uin String User Uin
    AppId Integer User AppId
    ClusterId String Cluster ID
    ClusterName String Cluster name
    InstanceId String Instance ID
    InstanceName String Instance name
    ProjectId Integer Project ID
    Region String Region
    Zone String AZ
    Status String Instance status
    StatusDesc String Instance status description
    DbMode String Instance type, which is used to indicate whether it is a serverless instance.
    DbType String Database type
    DbVersion String Database version
    Cpu Integer Number of CPU cores
    Memory Integer Memory in GB
    Storage Integer Storage capacity in GB
    InstanceType String Instance type
    InstanceRole String Current instance role
    UpdateTime Timestamp Update time
    CreateTime Timestamp Creation time
    VpcId String VPC ID
    SubnetId String Subnet ID
    Vip String Private IP of instance
    Vport Integer Private port of instance
    PayMode Integer Billing mode
    PeriodEndTime Timestamp Instance expiration time
    DestroyDeadlineText String Termination deadline
    IsolateTime Timestamp Isolation time
    NetType Integer Network type
    WanDomain String Public domain name
    WanIP String Public IP
    WanPort Integer Public port
    WanStatus String Public network status
    DestroyTime String Instance termination time
    CynosVersion String TDSQL-C kernel version
    ProcessingTask String Task in progress
    RenewFlag Integer Renewal flag
    MinCpu Float Minimum number of CPU cores for serverless instance
    MaxCpu Float Maximum number of CPU cores for serverless instance
    ServerlessStatus String Serverless instance status. Valid values:
    resume
    pause
    StorageId String Prepayment storage Id.
    StoragePayMode Integer Storage billing mode
    PhysicalZone String Physical zone
    BusinessType String Business type.
    Tasks Array of ObjectTask Task
    IsFreeze String Whether to freeze.
    ResourceTags Array of Tag The resource tag
    Note: This field may return null, indicating that no valid values can be obtained.
    MasterZone String Primary AZ.
    SlaveZones Array of String Replica AZ
    Note: This field may return null, indicating that no valid value can be obtained.
    InstanceNetInfo Array of InstanceNetInfo Network information of the instance.
    ResourcePackages Array of ResourcePackage Information of the resource pack bound to an instance when packageType is CCU. Note: This field may return null, indicating that no valid values can be obtained.
    InstanceIndexMode String Specifies the instance index form. valid values include mixedRowColumn (row and column hybrid storage) and onlyRowIndex (row-only storage).
    InstanceAbility InstanceAbility Supported capabilities of the existing instance.
    DeviceType String Instance machine type.
    InstanceStorageType String Specifies the instance storage type.
    CynosVersionTag String Unknown field.
    NodeList Array of String Specifies the node information of libradb.

    CynosdbInstanceDetail

    Instance details

    Used by actions: DescribeInstanceDetail.

    Name Type Description
    Uin String User Uin
    AppId Integer User AppId
    ClusterId String Cluster ID
    ClusterName String Cluster name
    InstanceId String Instance ID
    InstanceName String Instance name
    ProjectId Integer Project ID
    Region String Region
    Zone String AZ
    Status String Instance status
    StatusDesc String Instance status description
    ServerlessStatus String Serverless instance status. Valid values:
    resume
    pause
    DbType String Database type
    DbVersion String Database version
    Cpu Integer Number of CPU cores
    Memory Integer Memory in GB
    Storage Integer Storage capacity in GB
    InstanceType String Instance type
    InstanceRole String Current instance role
    UpdateTime Timestamp Update time
    CreateTime Timestamp Creation time
    PayMode Integer Billing mode
    PeriodEndTime Timestamp Instance expiration time
    NetType Integer Network type
    VpcId String VPC ID
    SubnetId String Subnet ID
    Vip String Private IP of instance
    Vport Integer Private port of instance
    WanDomain String Public domain name of instance
    Charset String Character set
    CynosVersion String TDSQL-C kernel version
    RenewFlag Integer Renewal flag
    MinCpu Float The minimum number of CPU cores for a serverless instance
    MaxCpu Float The maximum number of CPU cores for a serverless instance
    DbMode String Db type:
  • NORMAL
  • SERVERLESS
    • .

    DatabasePrivileges

    Database permission list

    Used by actions: ModifyAccountPrivileges.

    Name Type Required Description
    Db String Yes Database.
    Privileges Array of String Yes Permission list

    DatabaseTables

    Database table information

    Used by actions: CreateBackup, SearchClusterTables.

    Name Type Required Description
    Database String No Database name
    Tables Array of String No Table name list.

    DbInfo

    Database details

    Used by actions: DescribeClusterDetailDatabases.

    Name Type Description
    DbName String Database name
    CharacterSet String Character set
    Status String Database status
    CollateRule String Collation
    Description String Specifies the remark of the database.
    UserHostPrivileges Array of UserHostPrivilege User permission
    DbId Integer Database ID
    CreateTime Timestamp ISO8601 Creation time
    UpdateTime Timestamp ISO8601 Update time.
    AppId Integer User appid.
    Uin String User UIN
    ClusterId String Cluster ID

    DeliverSummary

    Log shipping information.

    Used by actions: DescribeAuditInstanceList.

    Name Type Description
    DeliverType String Select the delivery type, storage class, message channel.
    DeliverSubType String Specifies the delivery subtype: cls, ckafka.
    DeliverConsumer String Sender.
    DeliverConsumerName String Specifies the name of the sender.

    ErrorLogItemExport

    The export format for an error log

    Used by actions: ExportInstanceErrorLogs.

    Name Type Required Description
    Timestamp String No Time
    Level String No Specifies the log level. valid values are note, warning, and error.
    Content String No Log content.

    ExchangeInstanceInfo

    Used by actions: DescribeTasks.

    Name Type Description
    SrcInstanceInfo RollbackInstanceInfo Source instance information.
    DstInstanceInfo RollbackInstanceInfo Target instance information.

    ExchangeRoGroupInfo

    Used by actions: DescribeTasks.

    Name Type Description
    SrcRoGroupInfo RollbackRoGroupInfo Source RO group information.
    DstRoGroupInfo RollbackRoGroupInfo Target RO group information.

    GoodsPrice

    Item price.

    Used by actions: InquirePriceMultiSpec.

    Name Type Description
    InstancePrice TradePrice Specifies the instance price.
    Note: This field may return null, indicating that no valid values can be obtained.
    StoragePrice TradePrice Specifies the storage price.
    Note: This field may return null, indicating that no valid values can be obtained.
    GoodsSpec GoodsSpec Specifies the product specification.
    Note: This field may return null, indicating that no valid values can be obtained.

    GoodsSpec

    Product specification.

    Used by actions: InquirePriceMultiSpec.

    Name Type Required Description
    GoodsNum Integer No Number of products
    Note: This field may return null, indicating that no valid values can be obtained.
    Cpu Integer No Number of CPU cores. required for PREPAID and POSTPAID instance types.
    Note: This field may return null, indicating that no valid values can be obtained.
    Memory Integer No Memory size in gb. required for PREPAID and POSTPAID instance types.
    Note: This field may return null, indicating that no valid values can be obtained.
    Ccu Float No Ccu size. required for serverless type.
    Note: This field may return null, indicating that no valid values can be obtained.
    StorageLimit Integer No Storage size. required for PREPAID storage type.
    Note: This field may return null, indicating that no valid values can be obtained.
    TimeSpan Integer No Purchase duration.
    Note: This field may return null, indicating that no valid values can be obtained.
    TimeUnit String No Duration unit.
    Note: This field may return null, indicating that no valid values can be obtained.
    DeviceType String No Machine type.

    InputAccount

    Account. Valid values: accountName, host.

    Used by actions: DeleteAccounts, ModifyAccountHost, ModifyAccountPrivileges.

    Name Type Required Description
    AccountName String Yes Account
    Host String No Host. Default value: %

    InstanceAbility

    Used by actions: DescribeInstances, DescribeIsolatedInstances.

    Name Type Description
    IsSupportForceRestart String Specifies whether the instance supports forced reboot. valid values: yes (supported), no (unsupported).
    NonsupportForceRestartReason String Specifies the causes for not supporting forced reboot.

    InstanceAuditRule

    Audit rule details of the instance, which is an output parameter of the DescribeAuditRuleWithInstanceIds API.

    Used by actions: DescribeAuditRuleWithInstanceIds.

    Name Type Description
    InstanceId String Instance ID.
    AuditRule Boolean Specifies whether it is a rule-based audit. true - rule-based audit; false - comprehensive audit.
    AuditRuleFilters Array of AuditRuleFilters Specifies the audit rule details. valid when AuditRule=true.
    OldRule Boolean Whether it is an audit policy.
    RuleTemplates Array of RuleTemplateInfo The rule template details of the instance application.

    InstanceAuditStatus

    Used by actions: DescribeAuditInstanceList.

    Name Type Description
    InstanceId String
    AuditStatus String
    LogExpireDay Integer Specifies the log retention period.
    HighLogExpireDay Integer High-Frequency storage duration.
    LowLogExpireDay Integer Specifies the duration of low-frequency storage.
    BillingAmount Float Specifies the log storage volume.
    HighRealStorage Float Specifies the high-frequency storage volume.
    LowRealStorage Float Specifies the infrequent access storage size.
    AuditAll Boolean Specifies whether it is a full audit. true - indicates a full audit.
    CreateAt String Specifies the audit activation time.
    InstanceInfo AuditInstanceInfo Instance-Related information.
    RealStorage Float Specifies the total storage capacity.
    RuleTemplateIds Array of String The rule template applied to the instance.
    Deliver String Specifies whether to enable log delivery: ON, OFF.
    DeliverSummary Array of DeliverSummary Log shipping type.

    InstanceCLSDeliveryInfo

    Used by actions: DescribeInstanceCLSLogDelivery, DescribeTasks.

    Name Type Description
    InstanceId String Instance ID
    InstanceName String Instance name
    TopicId String Log topic id.
    TopicName String Log topic name
    GroupId String Log set id.
    GroupName String Log set name.
    Region String Log delivery region.
    Status String Delivery status: creating, running, offlining, offlined.
    LogType String Log type.

    InstanceInitInfo

    Instance initialization configuration information

    Used by actions: CreateClusters, RollbackToNewCluster.

    Name Type Required Description
    Cpu Integer Yes Instance CPU
    Memory Integer Yes Instance memory
    InstanceType String Yes Instance type. Valid values:rw, ro.
    InstanceCount Integer Yes Number of the instances. Value range: 1-15.
    MinRoCount Integer No Minimum number of serverless instances. Value range: 1-15.
    MaxRoCount Integer No Maximum number of serverless instances. Value range: 1-15.
    MinRoCpu Float No Minimum specifications for serverless instance
    MaxRoCpu Float No Maximum specifications for serverless instance

    InstanceNameWeight

    Instance weight.

    Used by actions: CreateIntegrateCluster.

    Name Type Required Description
    InstanceName String No Instance name. specifies the name defined by InstanceInitInfo.InstanceName in cluster creation.
    Weight Integer No Weight

    InstanceNetInfo

    Instance network information

    Used by actions: DescribeInstances, DescribeIsolatedInstances.

    Name Type Description
    InstanceGroupType String Network type.
    InstanceGroupId String Instance group ID
    VpcId String Specifies the virtual private cloud ID.
    SubnetId String Specifies the subnet ID.
    NetType Integer Network type. valid values: 0 (basic network), 1 (vpc network), 2 (blackstone network).
    Vip String VPC IP.
    Vport Integer VPC port.
    WanDomain String Specifies the public network domain name.
    WanIP String Public IP address
    WanPort Integer Public network port.
    WanStatus String Public network enabled status.

    InstanceParamItem

    Instance parameter information

    Used by actions: DescribeInstanceParams.

    Name Type Description
    InstanceId String Instance ID
    ParamsItems Array of ParamItemDetail List of instance parameters

    InstanceSpec

    Details of purchasable instance specifications. Cpu and Memory determine the instance specification during instance creation. The value range of the storage capacity is [MinStorageSize,MaxStorageSize]

    Used by actions: DescribeInstanceSpecs.

    Name Type Description
    Cpu Integer Number of instance CPU cores
    Memory Integer Instance memory in GB
    MaxStorageSize Integer Maximum instance storage capacity GB
    MinStorageSize Integer Minimum instance storage capacity GB
    HasStock Boolean Whether there is an inventory.
    MachineType String Machine type
    MaxIops Integer Maximum IOPS
    MaxIoBandWidth Integer Maximum bandwidth
    ZoneStockInfos Array of ZoneStockInfo Regional inventory information.
    StockCount Integer Inventory quantity.

    IntegrateCreateClusterConfig

    Integrated cluster configuration.

    Used by actions: CreateIntegrateCluster.

    Name Type Required Description
    BinlogSaveDays Integer No Retention days of binlog. value range: 7-1830.
    BackupSaveDays Integer No Specifies the backup retention days. value range: 7-1830.
    SemiSyncTimeout Integer No Specifies the semi-sync timeout period. value range: [1000,4294967295].
    ProxyEndPointConfigs Array of ProxyEndPointConfigInfo No proxy connection address configuration message.

    IntegrateInstanceInfo

    Initializes the configuration information of an instance.

    Used by actions: CreateIntegrateCluster.

    Name Type Required Description
    Cpu Integer Yes Specifies the cpu of the instance.
    Memory Integer Yes Specifies the instance memory.
    InstanceType String Yes Instance type (rw/ro).
    InstanceCount Integer Yes Number of instances. value range: [1,15].
    DeviceType String No Instance machine type. valid values: universal type (common), exclusive type.

    LogicBackupConfigInfo

    Used by actions: DescribeBackupConfig, ModifyBackupConfig.

    Name Type Required Description
    LogicBackupEnable String No Whether automatic logical backup is enabled.
    LogicBackupTimeBeg Integer No Specifies the automatic logic backup start time.
    LogicBackupTimeEnd Integer No Specifies the termination time of automatic logical backup.
    LogicReserveDuration Integer No Specifies the retention time for automatic logical backup.
    LogicCrossRegionsEnable String No Whether cross-regional logical backup is enabled.
    LogicCrossRegions Array of String No

    ManualBackupData

    Used by actions: DescribeTasks.

    Name Type Description
    BackupType String
    BackupMethod String
    SnapshotTime String
    CrossRegionBackupInfos Array of CrossRegionBackupItem Detailed information of cross-region backup items.
    Note: This field may return null, indicating that no valid values can be obtained.

    ModifiableInfo

    Details of whether the parameter can be modified

    Used by actions: DescribeClusterParams, DescribeClusterPasswordComplexity, DescribeParamTemplateDetail.

    Name Type Description
    IsModifiable Integer

    ModifyDbVersionData

    Used by actions: DescribeTasks.

    Name Type Description
    OldVersion String
    NewVersion String
    UpgradeType String

    ModifyInstanceData

    Used by actions: DescribeTasks.

    Name Type Description
    Cpu Integer
    Memory Integer
    StorageLimit Integer
    OldCpu Integer
    OldMemory Integer
    OldStorageLimit Integer
    OldDeviceType String Instance machine type before scaling.
    DeviceType String Instance machine type after scaling.
    UpgradeType String
    LibraNodeCount Integer Specifies the quantity of libra nodes.
    OldLibraNodeCount Integer Specifies the original quantity of libra nodes.

    ModifyParamItem

    Information of the modified instance parameter

    Used by actions: AddInstances, DescribeTasks, ModifyInstanceParam, ModifyParamTemplate.

    Name Type Required Description
    ParamName String Yes Parameter name
    CurrentValue String Yes Current parameter value
    OldValue String No Old parameter value (useful only in output parameters).
    Component String No libra component type.

    Module

    Modules supported by the system

    Used by actions: DescribeZones.

    Name Type Description
    IsDisable String Whether it is supported. Valid values: yes, no.
    ModuleName String Module name

    NetAddr

    Network information

    Used by actions: DescribeClusters, DescribeProxies.

    Name Type Required Description
    Vip String No Private IP address
    Vport Integer No Specifies the private network port number.
    WanDomain String No Specifies the public network domain name.
    WanPort Integer No Specifies the public network port number.
    NetType String No Network type (ro - read-only, rw/ha - read-write).
    UniqSubnetId String No Specifies the subnet ID.
    UniqVpcId String No Specifies the virtual private cloud ID.
    Description String No Description information
    WanIP String No Public IP address
    WanStatus String No Specifies the public network status.
    InstanceGroupId String No Instance group ID

    NewAccount

    The newly created x08 account

    Used by actions: CreateAccounts.

    Name Type Required Description
    AccountName String Yes Account name, which can contain 1-16 letters, digits, and underscores. It must begin with a letter and end with a letter or digit.
    AccountPassword String Yes Password, which can contain 8-64 characters.
    Host String Yes Host
    Description String No Description
    MaxUserConnections Integer No Maximum number of user connections, which cannot be above 10,240.

    ObjectTask

    Task information

    Used by actions: DescribeClusterDetail, DescribeClusters, DescribeInstances, DescribeIsolatedInstances, DescribeProxies.

    Name Type Required Description
    TaskId Integer No Task auto-increment ID.
    TaskType String No Task type
    TaskStatus String No Status of tasks.
    ObjectId String No Task ID (cluster ID | instance group ID | instance ID).
    ObjectType String No Task type

    Package

    Resource pack

    Used by actions: DescribeResourcePackageList.

    Name Type Description
    AppId Integer AppID
    PackageId String The unique ID of the resource package.
    PackageName String Resource package name.
    PackageType String Specifies the resource package type.
    CCU: compute resource package. DISK: storage resource package.
    PackageRegion String Resource package region of use.
    China - common in the chinese mainland. overseas - universally applicable in hong kong (china), macao (china), taiwan (china), and overseas.
    Status String Specifies the status of the resource package.
    creating - indicates that it is in the process of being created.
    {using} specifies that it is in use.
    expired-expired;.
    normal_finish - specifies that it is used up.
    Apply_refund: apply for a refund.
    Specifies that the fee has been refunded.
    PackageTotalSpec Float Total resource package quantity.
    PackageUsedSpec Float Used amount of resource package.
    HasQuota Boolean Whether there is inventory surplus.
    BindInstanceInfos Array of BindInstanceInfo Specifies the bound instance information.
    StartTime String Specifies the effective time: 2022-07-01 00:00:00.
    ExpireTime String Specifies the expiration time: 2022-08-01 00:00:00.
    HistoryBindResourceInfos Array of BindInstanceInfo Information of the instance historically bound (now unbound) to the resource pack.

    PackageDetail

    Resource pack details

    Used by actions: DescribeResourcePackageDetail.

    Name Type Description
    AppId Integer AppId account ID.
    PackageId String The unique ID of the resource package.
    InstanceId String Instance ID
    SuccessDeductSpec Float Successfully deduct capacity.
    PackageTotalUsedSpec Float The used capacity of the resource package up to the present.
    StartTime String Deduction start time.
    EndTime String Deduction end time.
    ExtendInfo String Extension Information

    PackagePriority

    Resource package deduction priority.

    Used by actions: ModifyResourcePackagesDeductionPriority.

    Name Type Required Description
    PackageId String No The resource pack whose deduction priority needs to be customized.
    DeductionPriority Integer No Custom deduction priority.

    ParamDetail

    Instance parameter details

    Used by actions: DescribeParamTemplateDetail.

    Name Type Description
    ParamName String Parameter name
    ParamType String Parameter type. Valid values: integer, enum, float, string, func.
    SupportFunc Boolean Whether func is supported. Valid values: true (supported), false (not supported).
    Default String Default value
    Description String Parameter description
    CurrentValue String Current value of the parameter
    NeedReboot Integer Whether to restart the database for the modified parameters to take effect. Valid values: 0 (no), 1 (yes).
    Max String Maximum value of the parameter
    Min String Minimum value of the parameter
    EnumValue Array of String Optional enumerated values of the parameter. if it is a non-enumerated value, it is empty.
    IsGlobal Integer Valid values: 1 (global parameter), 0 (non-global parameter).
    MatchType String The match type. Valid value: multiVal.
    MatchValue String Match values, which will be separated by comma when MatchType is multiVal.
    IsFunc Boolean true - indicates a formula. false - indicates it is not a formula.
    Func String Specifies that when the parameter is set as a formula, Func returns the set formula content.
    ModifiableInfo ModifiableInfo Whether the parameter is modifiable.
    FuncPattern String The default formula style of parameters that support formulas.

    ParamInfo

    Parameter information

    Used by actions: DescribeClusterParams, DescribeClusterPasswordComplexity.

    Name Type Description
    CurrentValue String Current value
    Default String Default value
    EnumValue Array of String If the parameter is of type enum/string/bool, the available options list.
    Max String Maximum value when parameter type is float or integer.
    Min String Minimum value when parameter type is float or integer.
    ParamName String Parameter name
    NeedReboot Integer Whether to restart the instance for the modified parameters to take effect.
    ParamType String Parameter type: integer, float, string, enum, bool.
    MatchType String Match type. Regex can be used when parameter type is string. Valid value: multiVal.
    MatchValue String Match values, which will be separated by semicolon when match type is multiVal.
    Description String Parameter description
    IsGlobal Integer Whether it is a global parameter.
    ModifiableInfo ModifiableInfo Whether the parameter is modifiable.
    IsFunc Boolean Whether it is a function.
    Func String Function.
    FuncPattern String The default formula style of parameters that support formulas.

    ParamItem

    Parameter to be modified

    Used by actions: CreateClusters, CreateIntegrateCluster, CreateParamTemplate, ModifyClusterParam, RollbackToNewCluster.

    Name Type Required Description
    ParamName String Yes Parameter name
    CurrentValue String Yes New value
    OldValue String Yes Original value

    ParamItemDetail

    Instance parameter information

    Used by actions: DescribeInstanceParams.

    Name Type Description
    CurrentValue String Current value
    Default String Default value
    EnumValue Array of String Enumerated values of the parameter It is null if the parameter is non-enumerated.
    IsGlobal Integer Valid values: 1 (global parameter), 0 (non-global parameter).
    Max String Maximum value
    Min String Minimum value
    NeedReboot Integer Whether to restart the database for the modified parameters to take effect. Valid values: 0 (no), 1 (yes)
    ParamName String Parameter name
    ParamType String Parameter type. Valid values: integer, enum, float, string, func.
    Description String Parameter description
    IsFunc Boolean Whether the type is a formula.
    Func String Parameter configuration formula.
    FuncPattern String The default formula style of parameters that support formulas.

    ParamItemInfo

    Used by actions: DescribeChangedParamsAfterUpgrade.

    Name Type Description
    ParamName String Parameter name.
    NewValue String New parameter value.
    OldValue String Old parameter value.
    ValueFunction String Parameter formula.

    ParamTemplateListInfo

    Parameter template information

    Used by actions: DescribeParamTemplates.

    Name Type Description
    Id Integer Parameter template ID
    TemplateName String Parameter template name
    TemplateDescription String Parameter template description
    EngineVersion String Engine version
    DbMode String Database Type. Valid values: NORMAL, SERVERLESS.
    ParamInfoSet Array of TemplateParamInfo Parameter template details
    Note: This field may return null, indicating that no valid values can be obtained.

    PolicyRule

    Security group 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, such as UDP and TCP
    ServiceModule String Protocol port ID or protocol port group ID.
    AddressModule String IP address ID or IP address group ID.
    Id String id
    Desc String Description

    ProxyConfigInfo

    Access proxy configuration.

    Used by actions: CreateIntegrateCluster.

    Name Type Required Description
    ProxyCount Integer No Number of database proxy group nodes. this parameter is no longer recommended. recommend using ProxyZones.
    Cpu Integer No Number of CPU cores
    Mem Integer No Specifies the memory.
    Description String No Description.
    ProxyZones Array of ProxyZone No Database node information (this parameter is used in combination with ProxyCount, either one must be manually input).

    ProxyConnectionPoolInfo

    Connection pool information for the database proxy

    Used by actions: DescribeProxies.

    Name Type Required Description
    ConnectionPoolTimeOut Integer Yes Specifies the persistence threshold of the connection pool. the unit is seconds.
    OpenConnectionPool String No Whether the connection pool is enabled.
    ConnectionPoolType String No Specifies the connection pool type. valid values: SessionConnectionPool (session-level connection pool).

    ProxyEndPointConfigInfo

    proxy address configuration of the integrated cluster.

    Used by actions: CreateIntegrateCluster.

    Name Type Required Description
    UniqueVpcId String No Specifies the ID of the VPC network it belongs to.
    UniqueSubnetId String No Subnet ID.
    SecurityGroupIds Array of String No Security group id array.
    WeightMode String No Weight mode: system-system allocation, custom-custom.
    AutoAddRo String No Specifies whether to automatically add a read-only instance. valid values: yes, no.
    RwType String No Read-Write attribute. valid values: READWRITE, READONLY.
    InstanceNameWeights Array of InstanceNameWeight No Weight information.

    ProxyGroup

    Proxy group

    Used by actions: DescribeProxies.

    Name Type Description
    ProxyGroupId String Database proxy group ID
    ProxyNodeCount Integer Number of nodes in the proxy group
    Status String Database proxy group status
    Region String Region
    Zone String AZ
    CurrentProxyVersion String Current proxy version
    ClusterId String Cluster ID
    AppId Integer User AppId
    OpenRw String Specifies that a read-write node activates the database proxy.

    ProxyGroupInfo

    Database proxy group details

    Used by actions: DescribeProxies.

    Name Type Description
    ProxyGroup ProxyGroup Database proxy group.
    ProxyGroupRwInfo ProxyGroupRwInfo Database proxy group read-write separation information.
    ProxyNodes Array of ProxyNodeInfo Node information of the database proxy
    Note: This field may return null, indicating that no valid values can be obtained.
    ConnectionPool ProxyConnectionPoolInfo Database proxy connection pool information.
    NetAddrInfos Array of NetAddr Network information for database proxy
    Note: This field may return null, indicating that no valid values can be obtained.
    Tasks Array of ObjectTask Database proxy task set.

    ProxyGroupRwInfo

    Read/write separation information of the database proxy group

    Used by actions: DescribeProxies.

    Name Type Required Description
    ConsistencyType String No Consistency type. Valid values: eventual (eventual consistency), session (session consistency), global (global consistency).
    ConsistencyTimeOut Integer No Consistency timeout period
    WeightMode String No Weight mode. Valid values: system (auto-assigned), custom.
    FailOver String No Whether to enable failover
    AutoAddRo String No Whether to automatically add read-only instance. Valid value: yes, no.
    InstanceWeights Array of ProxyInstanceWeight No Instance weight array
    OpenRw String No Whether to enable read-write nodes. valid values: yes, no.
    RwType String No Read/write attribute. Valid values: READWRITE, READONLY.
    TransSplit Boolean No Transaction split
    AccessMode String No Connection mode. Valid values: balance, nearby.

    ProxyInstanceWeight

    Weight ratio between read-write instances and read-only instances

    Used by actions: CreateProxyEndPoint, DescribeProxies, ModifyProxyRwSplit.

    Name Type Required Description
    InstanceId String Yes InstanID
    Weight Integer Yes Instance weight

    ProxyNodeInfo

    Node in the database proxy group

    Used by actions: DescribeProxies, DescribeProxyNodes.

    Name Type Description
    ProxyNodeId String Database proxy node ID
    ProxyNodeConnections Integer Current node connections, which is not returned by the DescribeProxyNodes API.
    Cpu Integer CPU of the database proxy node
    Mem Integer Memory of the database proxy node
    Status String Status of the database proxy node
    ProxyGroupId String Database proxy group ID
    ClusterId String Cluster ID
    AppId Integer User AppID
    Region String Region
    Zone String AZ
    OssProxyNodeName String

    ProxySpec

    Database proxy specifications

    Used by actions: DescribeProxySpecs.

    Name Type Description
    Cpu Integer Number of database proxy CPU cores
    Mem Integer Database proxy memory

    ProxyVersionInfo

    The proxy version information supported by TDSQL-C for MySQL.

    Used by actions: DescribeSupportProxyVersion.

    Name Type Description
    ProxyVersion String proxy version number.
    ProxyVersionType String Version description: GA: stable version. BETA: BETA version. DEPRECATED: outdated.

    ProxyZone

    Number of proxy nodes and their AZs

    Used by actions: CreateIntegrateCluster, CreateProxy, UpgradeProxy.

    Name Type Required Description
    ProxyNodeZone String No AZ of the proxy node
    ProxyNodeCount Integer No The number of proxy nodes

    QueryFilter

    Query filter

    Used by actions: DescribeClusters, DescribeInstances, DescribeIsolatedInstances, DescribeProxyNodes, DescribeTasks.

    Name Type Required Description
    Names Array of String Yes Search field. Valid values: "InstanceId", "ProjectId", "InstanceName", "Vip"
    Values Array of String Yes Search string
    ExactMatch Boolean No Whether to use exact match
    Name String No Search field
    Operator String No Operator

    QueryParamFilter

    Filters for query

    Used by actions: DescribeProxies.

    Name Type Required Description
    Names Array of String Yes Search field. Valid values: "InstanceId", "ProjectId", "InstanceName", "Vip"
    Values Array of String Yes Search string
    ExactMatch Boolean No Whether to use exact match

    ResourcePackage

    Information of a resource pack

    Used by actions: DescribeClusterDetail, DescribeClusters, DescribeInstances, DescribeIsolatedInstances.

    Name Type Required Description
    PackageId String No The unique ID of the resource package.
    PackageType String No Resource package type: CCU: compute resource package.
    DISK: storage resource package.
    DeductionPriority Integer No Deduction priority of the current resource package bound to the current instance.

    RollbackData

    Used by actions: DescribeTasks.

    Name Type Description
    Cpu Integer
    Memory Integer
    StorageLimit Integer
    OriginalClusterId String
    OriginalClusterName String
    RollbackStrategy String
    SnapshotTime String
    MinCpu Integer Minimum CPU when rolling back to a serverlessls cluster.
    MaxCpu Integer Maximum CPU when rolling back to a serverlessls cluster.
    SnapShotId Integer Snapshot ID.
    RollbackDatabases Array of RollbackDatabase
    RollbackTables Array of RollbackTable
    BackupFileName String Specifies the backup file name.
    RollbackProcess RollbackProcessInfo Rollback process.

    RollbackDatabase

    Used by actions: DescribeTasks, RollBackCluster, RollbackToNewCluster.

    Name Type Required Description
    OldDatabase String Yes
    NewDatabase String Yes

    RollbackInstanceInfo

    Used by actions: DescribeTasks.

    Name Type Description
    ClusterId String Cluster ID
    ClusterName String Cluster name.
    UniqVpcId String VPC information
    UniqSubnetId String Subnet information.
    Vip String vip information.
    Vport Integer Specifies the vport information.
    InstanceId String Instance ID
    InstanceName String Instance name
    Status String Status
    Cpu Integer CPU Size
    Mem Integer Memory Size
    StorageLimit Integer Storage size

    RollbackProcessInfo

    Used by actions: DescribeTasks.

    Name Type Description
    IsVipSwitchable Boolean Is it possible to switch vip.
    VipSwitchableTime String The exchangeable time of vip.
    ExchangeInstanceInfoList Array of ExchangeInstanceInfo
    ExchangeRoGroupInfoList Array of ExchangeRoGroupInfo
    CurrentStep String Current step.
    CurrentStepProgress Integer Current step progress.
    CurrentStepRemainingTime String Remaining time of the current step.

    RollbackRoGroupInfo

    Used by actions: DescribeTasks.

    Name Type Description
    InstanceGroupId String Instance group ID
    UniqVpcId String VPC information
    UniqSubnetId String Subnet information.
    Vip String vip information.
    Vport Integer Specifies the vport information.

    RollbackTable

    Used by actions: DescribeTasks, RollBackCluster, RollbackToNewCluster.

    Name Type Required Description
    Database String Yes
    Tables Array of RollbackTableInfo Yes

    RollbackTableInfo

    Used by actions: RollBackCluster, RollbackToNewCluster.

    Name Type Required Description
    OldTable String Yes Old table name.
    NewTable String Yes New table name.

    RollbackTimeRange

    Rollback time range

    Used by actions: DescribeRollbackTimeRange.

    Name Type Description
    TimeRangeStart String Start time
    TimeRangeEnd String End time

    RuleFilters

    Filter of the audit rule

    Used by actions: CreateAuditRuleTemplate, DescribeAuditRuleTemplates, DescribeAuditRuleWithInstanceIds, ModifyAuditRuleTemplates, ModifyAuditService.

    Name Type Required Description
    Type String Yes Filter parameter name of the audit rule. Valid values: host (client IP), user (database account), dbName (database name), sqlType (SQL type), sql (SQL statement).
    Compare String Yes Filter match type of the audit rule. Valid values: INC (including), EXC (excluding), EQS (equal to), NEQ (not equal to).
    Value Array of String Yes Filter match value of the audit rule

    RuleTemplateInfo

    Used by actions: DescribeAuditRuleWithInstanceIds.

    Name Type Description
    RuleTemplateId String Rule template ID.
    RuleTemplateName String Rule template name.
    RuleFilters Array of RuleFilters The rule content.
    AlarmLevel Integer Alarm level. valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
    AlarmPolicy Integer Alarm policy. 0 - no alert, 1 - alert.
    Description String Rule description.

    SalePackageSpec

    Resource pack details

    Used by actions: DescribeResourcePackageSaleSpec.

    Name Type Description
    PackageRegion String Resource package region of use.
    PackageType String Specifies the resource package type.
    CCU - compute resource package.
    Storage resource package.
    PackageVersion String Resource pack version.
    base - basic version; common - general version; enterprise - enterprise edition.
    MinPackageSpec Float Minimum number of resources in the current version of the resource package. compute resource unit: pieces; storage resource: GB.
    MaxPackageSpec Float Specifies the maximum number of resources in the current version of the resource package. valid values: compute resource unit: pieces; storage resource: GB.
    ExpireDay Integer Specifies the resource pack validity period. the measurement unit is day.

    SaleRegion

    Information of a purchasable region

    Used by actions: DescribeZones.

    Name Type Description
    Region String Region name
    RegionId Integer Numeric ID of a region
    RegionZh String Region name
    ZoneSet Array of SaleZone List of purchasable AZs
    DbType String Engine type
    Modules Array of Module Supported modules in a region

    SaleZone

    Information of a purchasable AZ

    Used by actions: DescribeZones.

    Name Type Description
    Zone String AZ name
    ZoneId Integer Numeric ID of an AZ
    ZoneZh String AZ name
    IsSupportServerless Integer Whether serverless cluster is supported. Valid values:

    0: No

    1: Yes
    IsSupportNormal Integer Whether standard cluster is supported. Valid values:

    0: No

    1: Yes
    PhysicalZone String Physical zone
    HasPermission Boolean Whether the user has AZ permission.
    IsWholeRdmaZone String Whether it is a full-linkage RDMA AZ.
    IsSupportCreateCluster Integer Specifies whether a newly purchased cluster is allowed in the current availability zone. valid values: 1 (allowed), 0 (not allowed).

    SecurityGroup

    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 PolicyRule Inbound rule
    Outbound Array of PolicyRule Outbound rule
    SecurityGroupId String Security group ID
    SecurityGroupName String Security group name
    SecurityGroupRemark String Security group remarks

    ServerlessSpec

    serverless specification.

    Used by actions: DescribeServerlessInstanceSpecs.

    Name Type Description
    MinCpu Float Specifies the minimum value of the cpu.
    MaxCpu Float Maximum value of cpu.
    MaxStorageSize Integer Maximum storage space.
    IsDefault Integer Specifies whether it is the default specification.
    HasStock Boolean Whether there is inventory.
    StockCount Integer Inventory quantity.
    ZoneStockInfos Array of ServerlessZoneStockInfo Availability zone inventory information.
    Note: This field may return null, indicating that no valid values can be obtained.

    ServerlessZoneStockInfo

    serverless type availability zone inventory information.

    Used by actions: DescribeServerlessInstanceSpecs.

    Name Type Description
    Zone String Availability zone
    StockCount Integer Specifies the stored amount.
    HasStock Boolean Whether it contains inventory.
    SlaveZoneStockInfos Array of SlaveZoneStockInfo Inventory information from availability zone.

    SlaveZoneAttrItem

    Used by actions: DescribeClusterDetail, DescribeTasks.

    Name Type Description
    Zone String Availability zone
    BinlogSyncWay String binlog synchronization mode.

    SlaveZoneStockInfo

    Used by actions: DescribeInstanceSpecs, DescribeServerlessInstanceSpecs.

    Name Type Description
    SlaveZone String Replica AZ.
    StockCount Integer Inventory quantity in spare availability zone.
    HasStock Boolean Whether there is inventory in the spare availability zone.

    SlowQueriesItem

    Slow query information of the instance

    Used by actions: DescribeInstanceSlowQueries.

    Name Type Description
    Timestamp Integer Execution timestamp
    QueryTime Float Execution duration in seconds
    SqlText String SQL statement
    UserHost String Client host
    UserName String Username
    Database String Database name
    LockTime Float Lock duration in seconds
    RowsExamined Integer Number of scanned rows
    RowsSent Integer Number of returned rows
    SqlTemplate String SQL template
    SqlMd5 String MD5 value of the SQL statement
    SyncReadCountRemote Integer Remote reading count.
    Specifies that the database kernel version is larger than 3.1.12.
    SyncReadBytesRemote Integer Number of remote read bytes.
    Specifies that the database kernel version is larger than 3.1.12.
    SyncReadTimeRemote Integer Time spent on remote reads (µs).
    Specifies that the database kernel version is larger than 3.1.12.
    SyncWriteCountRemote Integer Remote write count.
    Specifies that the database kernel version is larger than 3.1.12.
    SyncWriteBytesRemote Integer Specifies the number of remote written bytes.
    Specifies that the database kernel version is larger than 3.1.12.
    SyncWriteTimeRemote Integer Time spent on remote writing (µs).
    Specifies that the database kernel version is larger than 3.1.12.
    TrxCommitDelay Integer Transaction submission delay (µs).
    Specifies that the database kernel version is larger than 3.1.12.

    SwitchClusterLogBin

    Used by actions: DescribeTasks.

    Name Type Description
    Status String Status

    TablePrivileges

    MySQL table permission

    Used by actions: ModifyAccountPrivileges.

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

    Tag

    Information of tags associated with cluster, including TagKey and TagValue

    Used by actions: CreateClusters, CreateIntegrateCluster, DescribeAuditInstanceList, DescribeClusterDetail, DescribeClusters, DescribeInstances, DescribeIsolatedInstances, RollbackToNewCluster.

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

    TaskMaintainInfo

    TaskMaintainInfo

    Used by actions: DescribeTasks.

    Name Type Description
    MaintainStartTime Integer Execution start time (seconds from 0 o'clock).
    MaintainDuration Integer Specifies the continuous time. the unit is second.
    MaintainWeekDays Array of String Specifies the time when it can be executed. valid values: ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"].

    TaskProgressInfo

    Task progress query.

    Used by actions: DescribeTasks.

    Name Type Description
    CurrentStep String Current step.
    CurrentStepProgress Integer Current progress.
    CurrentStepRemainingTime String Estimated Time

    TemplateParamInfo

    Parameter template details

    Used by actions: DescribeParamTemplates.

    Name Type Description
    CurrentValue String Current value
    Default String Default value
    EnumValue Array of String The collection of optional value types when the parameter type is enum.
    Max String The maximum value when the parameter type is float/integer.
    Min String Minimum value when the parameter type is float/integer.
    ParamName String Parameter name
    NeedReboot Integer Whether to restart the instance for the parameter to take effect
    Description String Parameter description
    ParamType String Parameter type. Valid value: integer, float, string, enum.

    TradePrice

    Billing details

    Used by actions: InquirePriceCreate, InquirePriceModify, InquirePriceMultiSpec, InquirePriceRenew.

    Name Type Description
    TotalPrice Integer Resource total price under prepaid mode, excluding discounts. unit: cent.
    Discount Float Total discount. 100 means no discount.
    TotalPriceDiscount Integer Discounted total price under prepaid mode, unit: fen. for example, the user enjoys a Discount = TotalPrice × Discount.
    UnitPrice Integer Unit resource price in postpaid mode, excluding discounts. unit: cent.
    UnitPriceDiscount Integer Unit resource price in postpaid mode after Discount, unit: fen. for example, the user enjoys a Discount = unitprice × Discount.
    ChargeUnit String Price unit

    UserHostPrivilege

    User host permissions

    Used by actions: CreateClusterDatabase, DescribeClusterDetailDatabases, ModifyClusterDatabase.

    Name Type Required Description
    DbUserName String Yes Authorized user
    DbHost String Yes Client IP
    DbPrivilege String Yes User permission

    ZoneStockInfo

    Inventory information in an AZ

    Used by actions: DescribeInstanceSpecs.

    Name Type Description
    Zone String AZ
    HasStock Boolean Whether there is an inventory.
    StockCount Integer Quantity in stock
    SlaveZoneStockInfos Array of SlaveZoneStockInfo Available zone inventory information.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback