AI optimizer status
Used by actions: DescribeClusterDetail.
| Name | Type | Description |
|---|---|---|
| Status | String | Status. closing-Closing, closed-Closed, opening-Opening, training-Training, trained-Trained, train_failed-Training failed. |
| OpenTime | String | Start time. |
| TrainingProgress | Integer | Training progress |
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. |
| IsSupportGlobalEncryption | String | No | Enable global encryption. |
| NoSupportGlobalEncryptionReason | String | No | The causes for unsupported global encryption. |
| NoSupportTransparentDataEncryptionReasonCode | String | No | Status code for unsupported tde reason. |
| NoSupportGlobalEncryptionReasonCode | String | No | Status code for unsupported global encryption. |
Database account information
Used by actions: DescribeAccounts, DescribeLibraDBClusterAccounts.
| Name | Type | Description |
|---|---|---|
| AccountName | String | Database account name |
| Host | String | Host |
| Description | String | Database account description |
| CreateTime | Timestamp | Creation time |
| UpdateTime | Timestamp | Update time |
| MaxUserConnections | Integer | The max connections |
| PasswordRotation | Integer | Whether password rotation is enabled (0: turn off; 1: turn on) |
Database address
Used by actions: DescribeClusterDetail.
| Name | Type | Description |
|---|---|---|
| IP | String | IP address |
| Port | Integer | Port |
Used by actions: DescribeAuditInstanceList.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | |
| ExactMatch | Boolean | Yes | |
| Values | Array of String | Yes |
Used by actions: DescribeAuditInstanceList.
| Name | Type | Description |
|---|---|---|
| ProjectId | Integer | Project ID. |
| TagList | Array of Tag | Tag information |
Filter of rule audit
Used by actions: DescribeAuditRuleWithInstanceIds, ModifyAuditService.
| Name | Type | Required | Description |
|---|---|---|---|
| RuleFilters | Array of RuleFilters | Yes | A single audit rule. |
Details of an audit rule template
Used by actions: DescribeAuditRuleTemplates.
| Name | Type | Description |
|---|---|---|
| RuleTemplateId | String | Rule template ID |
| RuleTemplateName | String | Rule template name |
| RuleFilters | Array of RuleFilters | Filter 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. |
Safe automatically deliver relationship
Used by actions: DescribeVaults.
| Name | Type | Required | Description |
|---|---|---|---|
| ClusterId | String | No | Cluster ID. |
| VaultId | String | No | Safe ID |
| VaultRegion | String | No | Safe region |
| CopyType | String | No | Delivery Type: binlog, redolog, snapshot, logic |
Advanced mapping, automated mapping rule
Used by actions: DescribeLibraDBClusterAutoMapRule, ModifyLibraDBClusterReplicationObject.
| Name | Type | Required | Description |
|---|---|---|---|
| SrcInstanceId | String | Yes | Source instance Id |
| SrcDatabaseRegex | String | Yes | Source database regular |
| SrcTableRegex | String | Yes | Source table regular |
| DstDatabaseRegex | String | Yes | Target database regular |
| DstTableRegex | String | Yes | Target table regular |
Backup setting.
Used by actions: DescribeBackupConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| BackupCustomAutoTime | Boolean | No | System automation time. |
| BackupTimeBeg | Integer | No | Indicates the full backup start time. value range: [0-24*3600]. for example, 0:00, 1:00, and 2:00 are 0, 3600, and 7200 respectively. |
| BackupTimeEnd | Integer | No | Indicates the full backup end time. value range: [0-24*3600]. for example, 0:00, 1:00, and 2:00 are 0, 3600, and 7200 respectively. |
| BackupWeekDays | Array of String | No | Currently this parameter cannot be modified. no need to specify. backup frequency is an array of length 7, corresponding to the backup method from sunday to saturday, full for full backup and increment for incremental backup. Note: This field may return null, indicating that no valid values can be obtained. |
| BackupIntervalTime | Integer | No | Interval. |
| ReserveDuration | Integer | No | Indicates the backup retention period in seconds. data will be cleaned up longer than this time. 7 days means 3600247=604800. the maximum is 158112000. |
| CrossRegionsEnable | String | No | Enable cross-region backup. Enable. 0: disabled. |
| CrossRegions | Array of String | No | Cross-Regional backup region. Note: This field may return null, indicating that no valid values can be obtained. |
| BackupTriggerStrategy | String | No | Automatic data backup trigger policy, periodically: automatic periodic backup, frequent: high-frequency backup |
| AutoCopyVaults | Array of CreateBackupVaultItem | No | Backup delivery relationship |
Backup file information
Used by actions: DescribeBackupList, DescribeBackupListByVault.
| Name | Type | Description |
|---|---|---|
| SnapshotId | Integer | Snapshot file ID, abandoned, please use BackupId |
| FileName | String | Backup file name |
| FileSize | Integer | Backup file size |
| StartTime | String | Backup start time. |
| FinishTime | String | Backup completion time. |
| BackupType | String | Backup type: snapshot, snapshot backup; logic, logical backup |
| BackupMethod | String | Backup method: auto, automatic backup; manual, manual backup |
| BackupStatus | String | Backup file status: success: backup successful; fail: backup failed; creating: backup file being created; deleting: backup file deleting |
| SnapshotTime | String | Backup file time |
| BackupId | Integer | Backup ID |
| SnapShotType | String | Snapshot type. Value range: full, full; increment, incremental |
| BackupName | String | Backup file remark |
| CopyStatus | String | Delivery status |
| EncryptKeyId | String | Key id |
| EncryptRegion | String | Key region |
| VaultInfos | Array of VaultInfo | Safe info |
| BackupPeriodStrategy | String | Backup cycle policy |
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. |
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. |
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. |
Region where backup files are located and ID.
Used by actions: DescribeRedoLogListByVault, DescribeRedoLogs.
| Name | Type | Description |
|---|---|---|
| BackupRegion | String | Backup region. |
| BackupId | Integer | Backup ID. |
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 |
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. |
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. |
| AutoCopyVaults | Array of CreateBackupVaultItem | No | Safe info |
Binlog description
Used by actions: DescribeBinlogListByVault, 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 |
| CrossRegions | Array of String | binlog cross-region coverage |
| CopyStatus | String | Backup delivery status |
| VaultInfos | Array of VaultInfo | Safe info |
| EncryptKeyId | String | Encryption key |
| EncryptRegion | String | Encrypt key region |
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. |
| GdnTaskInfo | GdnTaskInfo | Global Database Network Task |
| VaultId | String | Safe id |
| VaultName | String | Safe name |
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | |
| ModifyInstanceParamList | Array of ModifyParamItem | Details of instance parameter modification task. |
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. |
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 |
Check item
Used by actions: CheckCreateLibraDBInstance.
| Name | Type | Description |
|---|---|---|
| Item | String | Check item name Note: This field may return null, indicating that no valid values can be obtained. |
| Result | String | Verification result of this item Note: This field may return null, indicating that no valid values can be obtained. |
| CurrentValue | String | Detailed explanation of validation failure and modification suggestions Note: This field may return null, indicating that no valid values can be obtained. |
| ExpectedValue | String | Details of validation failure and modification suggestions Note: This field may return null, indicating that no valid values can be obtained. |
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 | cpu cores |
| InstanceMemory | Integer | Memory |
| InstanceStorage | Integer | hard disk |
| InstanceRole | String | Instance role |
| MaintainStartTime | Integer | Execution start time (seconds from 00:00). |
| MaintainDuration | Integer | Duration (unit: s) |
| MaintainWeekDays | Array of String | The time when it can be executed, enumeration value: ["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 |
| AIOptimizerStatus | AIOptimizerStatus | AI optimizer status |
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. |
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. |
Cluster task ID.
Used by actions: ModifyClusterReadOnly.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID |
| TaskId | String | Task ID |
Safe info
Used by actions: CreateBackup, DescribeBackupConfig, DescribeBinlogConfig, ModifyBackupConfig, ModifyBinlogConfig, ModifyClusterBinlogRedoLogAutoCopyVault.
| Name | Type | Required | Description |
|---|---|---|---|
| VaultId | String | No | Safe id Note: This field may return null, indicating that no valid values can be obtained. |
| VaultRegion | String | No | Safe region Note: This field may return null, indicating that no valid values can be obtained. |
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| Cpu | Integer | |
| Memory | Integer | |
| StorageLimit | Integer |
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. |
Cluster information
Used by actions: DescribeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| Status | String | Yes | Cluster status. Valid values include: |
| 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 | End time |
| Vip | String | Yes | Cluster read/write vip |
| Vport | Integer | Yes | Cluster read/write vport |
| ProjectID | Integer | Yes | Project ID. |
| VpcId | String | No | VPC ID |
| SubnetId | String | No | Subnet ID. |
| CynosVersion | String | No | cynos kernel version |
| CynosVersionTag | String | No | cynos version tag |
| StorageLimit | Integer | No | Storage capacity |
| RenewFlag | Integer | No | Renewal flag |
| ProcessingTask | String | No | Currently processing task |
| Tasks | Array of ObjectTask | No | Task array of the cluster |
| ResourceTags | Array of Tag | No | tag Array of cluster binding |
| DbMode | String | No | Db type (NORMAL, SERVERLESS) |
| ServerlessStatus | String | No | When the Db type is SERVERLESS, the SERVERLESS cluster status. Available values: |
| Storage | Integer | No | Cluster Prepaid storage size |
| StorageId | String | No | Storage ID of cluster storage in prepayment, used for prepaid storage configuration change |
| StoragePayMode | Integer | No | Cluster storage payment mode. 0: pay-as-you-go; 1: monthly subscription |
| MinStorageSize | Integer | No | Minimum storage of the cluster compute specification |
| MaxStorageSize | Integer | No | Maximum storage value of the cluster compute specification |
| NetAddrs | Array of NetAddr | No | Cluster network information |
| PhysicalZone | String | No | Physical AZ |
| MasterZone | String | No | Primary AZ |
| HasSlaveZone | String | No | Whether there is a secondary AZ |
| SlaveZones | Array of String | No | Secondary AZ |
| BusinessType | String | No | Business type |
| IsFreeze | String | No | Freeze or not |
| OrderSource | String | No | Order source |
| Ability | Ability | No | Capacity |
| ResourcePackages | Array of ResourcePackage | No | Instance bind resource package info (here only return storage resource package, for example packageType=DISK) |
| GdnId | String | No | Global database unique ID |
| GdnRole | String | No | Cluster role. Primary cluster - primary, slave cluster - standby. If GdnId is empty, the field is invalid. |
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. supported values are as follows:. -Creating: creating. - running: running. -isolating. -Isolated: isolated. -activating: restore from recycle bin. -offlining: offline. -offlined: offline. - deleting: deleting. - deleted: deleted. |
| 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 yearly/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: |
| 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. |
| GdnId | String | Global database network unique id. |
| GdnRole | String | The role of clusters in the global data network. primary cluster. Slave cluster - standby. If empty, the field is invalid. |
| UsedArchiveStorage | Integer | Secondary storage usage, unit: G. |
| ArchiveStatus | String | Archiving status, enumeration value |
| ArchiveProgress | Integer | Archive progress, percentage. |
| IsOpenTDE | Boolean | Whether transparent encryption is enabled. |
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. |
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 in Chinese |
| DbMode | String | Instance form, whether it is a serverless instance |
| DbType | String | Database type |
| DbVersion | String | Database version. |
| Cpu | Integer | Cpu, unit: core |
| Memory | Integer | Memory, unit: GB |
| Storage | Integer | Stored amount, unit: GB |
| InstanceType | String | Instance type Enumeration value:
|
| InstanceRole | String | Current instance role |
| UpdateTime | Timestamp | Update time. |
| CreateTime | Timestamp | Creation time. |
| VpcId | String | VPC network ID |
| SubnetId | String | Subnet ID. |
| Vip | String | Instance private IP address |
| Vport | Integer | Instance Intranet Port |
| PayMode | Integer | Payment mode |
| PeriodEndTime | Timestamp | Instance expiration time |
| DestroyDeadlineText | String | Termination phase |
| IsolateTime | Timestamp | Isolation time |
| NetType | Integer | Network type |
| WanDomain | String | Public network domain name |
| WanIP | String | Public network IP |
| WanPort | Integer | Public network port |
| WanStatus | String | Public network status |
| DestroyTime | String | Instance destruction time |
| CynosVersion | String | Cynos kernel version |
| ProcessingTask | String | Currently processing task |
| RenewFlag | Integer | Renewal flag |
| MinCpu | Float | serverless instance cpu minimum |
| MaxCpu | Float | cpu cap of the serverless instance |
| ServerlessStatus | String | serverless instance status, available values: |
| StorageId | String | Prepayment storage Id |
| StoragePayMode | Integer | Storage billing type |
| PhysicalZone | String | Physical zone |
| BusinessType | String | Business type |
| Tasks | Array of ObjectTask | Task |
| IsFreeze | String | Whether to freeze |
| ResourceTags | Array of Tag | Resource tag Note: This field may return null, indicating that no valid values can be obtained. |
| MasterZone | String | Primary AZ |
| SlaveZones | Array of String | Standby availability zone Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceNetInfo | Array of InstanceNetInfo | Instance network info |
| ResourcePackages | Array of ResourcePackage | Instance bind resource package info (only return compute resource package, packageType=CCU) Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceIndexMode | String | Instance index form, available values [mixedRowColumn (hybrid row-column storage), onlyRowIndex (row storage only)] |
| InstanceAbility | InstanceAbility | Supported capabilities of the current instance |
| DeviceType | String | Instance Machine Type
|
| InstanceStorageType | String | Instance storage type |
| CynosVersionTag | String | Unknown field |
| NodeList | Array of String | libradb node information |
| GdnId | String | Unique ID of the global database |
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 | Status description in Chinese of the instance |
| ServerlessStatus | String | Status of the serverless instance. Possible value: |
| DbType | String | Database type. |
| DbVersion | String | Database version |
| Cpu | Integer | Cpu, unit: cores |
| Memory | Integer | Memory, unit: GB |
| Storage | Integer | Stored amount, unit: GB |
| InstanceType | String | Instance type |
| InstanceRole | String | Current instance role |
| UpdateTime | Timestamp | Update time. |
| CreateTime | Timestamp | Creation time. |
| PayMode | Integer | Payment mode |
| PeriodEndTime | Timestamp | Instance expiration time |
| NetType | Integer | Network type. |
| VpcId | String | VPC network ID |
| SubnetId | String | Subnet ID. |
| Vip | String | Instance private IP address |
| Vport | Integer | Instance Intranet Port |
| WanDomain | String | Instance public network domain name |
| Charset | String | Character set |
| CynosVersion | String | Cynos kernel version |
| RenewFlag | Integer | Renewal flag |
| MinCpu | Float | serverless instance cpu minimum |
| MaxCpu | Float | cpu cap of the serverless instance |
| DbMode | String | Db type: |
| MasterZone | String | Cluster read/write instance Availability Zone |
Data source item
Used by actions: DescribeLibraDBDataSource.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceId | String | No | Source instance ID |
| ClusterId | String | No | Source cluster ID |
| DBType | String | No | Source database type |
| IP | String | No | Source database IP |
| Port | Integer | No | Source database port |
| Region | String | No | Source instance region |
| Zone | String | No | Source instance availability zone |
| SrcUin | String | No | Source main account uin |
| AccountMode | String | No | Account type |
| ReplicationJobStatus | String | No | sync task status |
Database permission list
Used by actions: DescribeLibraDBClusterAccountAllPrivileges, ModifyAccountPrivileges, ModifyLibraDBClusterAccountPrivilege.
| Name | Type | Required | Description |
|---|---|---|---|
| Db | String | Yes | Database. |
| Privileges | Array of String | Yes | Permission list |
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. |
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 |
Database table
Used by actions: GrantAccountPrivileges.
| Name | Type | Required | Description |
|---|---|---|---|
| Db | String | Yes | Database name. |
| TableName | String | No | Database table name |
Delete safe task info
Used by actions: DeleteVaults.
| Name | Type | Description |
|---|---|---|
| VaultId | String | Safe ID |
| TaskId | Integer | Task ID. |
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. |
| DeliverError | String | Exception error in delivery |
DescribeBackupListByVaultItem
Used by actions: DescribeBackupListByVault.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID. |
| ClusterName | String | Cluster name |
| BackupFileInfo | BackupFileInfo | Backup information |
binlog backup info
Used by actions: DescribeBinlogListByVault.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID. |
| ClusterName | String | Cluster name. |
| BinlogFileInfo | BinlogItem | Binlog file information |
log message
Used by actions: DescribeRedoLogListByVault.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID. |
| ClusterName | String | Cluster name. |
| RedoFileInfo | RedoLogItem | RedoLog file information |
Cluster information.
Used by actions: DescribeVaultBackupClusterInfo.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID |
| ClusterName | String | Cluster name. |
| ClusterStatus | String | Cluster status |
| ClusterRegion | String | cluster region |
| ClusterZone | String | AZ of the cluster |
Safe info
Used by actions: DescribeVaults.
| Name | Type | Required | Description |
|---|---|---|---|
| VaultId | String | No | Safe ID |
| VaultName | String | No | Safe name |
| VaultDescribe | String | No | Safe description |
| KeyId | String | No | Encryption key ID. |
| KeyRegion | String | No | Key region |
| KeyType | String | No | Key type |
| BackupFileCount | Integer | No | Number of backup files |
| BackupFileSize | Integer | No | Total size of backup files (byte) |
| BinlogFileCount | Integer | No | Binlog file count |
| BinlogFileSize | Integer | No | Total size of the Binlog file (byte) |
| RedoLogFileCount | Integer | No | Number of RedoLog files |
| RedoLogFileSize | Integer | No | Total size of RedoLog files (byte) |
| Status | String | No | Safe status |
| BackupSaveSeconds | Integer | No | Backup retention period (seconds) |
| LockedTime | String | No | lock time |
| Tasks | Array of ObjectTask | No | Associated task list |
| VaultRegion | String | No | Safe region |
| AutoCopyConfigs | Array of AutoCopyConfig | No | Automatically deliver relationship |
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. |
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| SrcInstanceInfo | RollbackInstanceInfo | Source instance information. |
| DstInstanceInfo | RollbackInstanceInfo | Target instance information. |
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| SrcRoGroupInfo | RollbackRoGroupInfo | Source RO group information. |
| DstRoGroupInfo | RollbackRoGroupInfo | Target RO group information. |
Execution plan details
Used by actions: DescribeSQLExecutionPlan.
| Name | Type | Description |
|---|---|---|
| TemplateID | String | Template ID |
| Db | String | Database name. |
| SQLSample | String | Original SQL sample |
| SQLSampleRewritten | String | Sample SQL after rewrite |
| TablePlanBefore | Array of ExplainRow | Execution plan before optimization - List |
| TablePlanAfter | Array of ExplainRow | Execution plan after optimization - List |
| TreePlanBefore | String | Tree execution plan before optimization |
| TreePlanAfter | String | Tree execution plan after optimization |
| QueryTimeBefore | Float | Query time before optimization |
| QueryTimeAfter | Float | Query time after optimization |
| SQLScanRowsBefore | Integer | Number of scanned rows before optimization |
| SQLScanRowsAfter | Integer | Number of scanned rows after optimization |
Execution plan list
Used by actions: DescribeSQLExecutionPlan.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Serial number of the query |
| SelectType | String | Query type. Common values: SIMPLE (simple query, excluding subqueries or UNION), PRIMARY (outermost query), SUBQUERY (first SELECT in a subquery), DERIVED (derivative table/subquery in FROM clause), UNION (second and subsequent SELECTs in UNION), UNION RESULT (result set of UNION). |
| Table | String | Data table name |
| Partitions | String | Query matching partition |
| Type | String | Access type (very important, a key metric for measuring query efficiency), ranked from best to worst: system > const > eq_ref > ref > fulltext > ref_or_null > index_merge > unique_subquery > index_subquery > range > index > ALL. Common value descriptions: • system: The table has only one row (system table). • const: Matches one row through primary key or unique index, commonly seen in WHERE pk = 1. • eq_ref: Uses primary key or unique index when connecting, each index value matches only one row. • ref: Uses non-unique index to search, may match multiple rows. • range: Index range scan, such as BETWEEN, >, <, IN. • index: Full index scan (traversal of the entire index tree). • ALL: Full-table scan (worst, requires optimization). |
| PossibleKeys | String | Indexes that may be used in querying. NULL means no available index. |
| Key | String | Indexes actually used. NULL means no index is used. |
| KeyLen | String | The length of the actual used index (number of bytes). It can be used to determine which columns are actually used in the composite index. A shorter value indicates fewer index columns are used. |
| Ref | String | Display which columns or constants are compared with indexes in the key column. Common values: const (constant), certain column name, func (function result). |
| Rows | Integer | Estimate the number of rows to scan |
| Filtered | Float | Indicates the estimation of the percentage of rows remaining after table conditional filtering. 100% means no additional filtering. The higher the value, the better. |
| Extra | String | Additional information (very important), common values: • Using index: covering index, no need to return to the table (good) • Using where: filter with WHERE after the storage engine returns rows • Using temporary: used a temporary table (commonly used in GROUP BY/ORDER BY, needs optimization) • Using filesort: used file sort instead of index sorting (needs optimization) • Using index condition: used pushdown of index (ICP) |
Forward instance information
Used by actions: DescribeLibraDBForwardConfig, ModifyLibraDBForwardConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceId | String | No | Forward the instance id Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | No | Forward instance region Note: This field may return null, indicating that no valid values can be obtained. |
Global database task info
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| GdnId | String | Unique ID of the global database |
| GdnName | String | unique alias of the global database |
| PrimaryClusterId | String | Primary Cluster ID |
| PrimaryClusterRegion | String | Master cluster region |
| StandbyClusterRegion | String | from the cluster region |
| StandbyClusterId | String | Slave cluster ID |
| StandbyClusterName | String | From the cluster name |
| ForceSwitchGdn | String | Whether forced switchover is performed |
| Code | Integer | Return code |
| Message | String | prompt message |
| IsSupportForce | String | Whether forced switchover is supported |
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. |
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 | Instance machine type 1. common, universal type. 2. exclusive, dedicated. |
Account. Valid values: accountName, host.
Used by actions: DeleteAccounts, DeleteLibraDBClusterAccounts, DescribeLibraDBClusterAccountAllPrivileges, GrantAccountPrivileges, ModifyAccountHost, ModifyAccountPrivileges, ModifyLibraDBClusterAccountHost, ModifyLibraDBClusterAccountPrivilege.
| Name | Type | Required | Description |
|---|---|---|---|
| AccountName | String | Yes | Account |
| Host | String | No | Host. Default value: % |
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. |
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. |
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. |
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. |
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 rw/ro |
| InstanceCount | Integer | Yes | Number of instances, range [1,15] |
| MinRoCount | Integer | No | Minimum count of Serverless instance, range [1,15] |
| MaxRoCount | Integer | No | Maximum count of Serverless instances, range [1,15] |
| MinRoCpu | Float | No | Minimum specification of Serverless instance |
| MaxRoCpu | Float | No | Maximum specification of Serverless instance |
| DeviceType | String | No | Instance Machine Type
|
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 |
Instance network information
Used by actions: DescribeInstances, DescribeIsolatedInstances, DescribeLibraDBInstanceDetail.
| 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. |
Instance parameter information
Used by actions: DescribeInstanceParams.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| ParamsItems | Array of ParamItemDetail | List of instance parameters |
Instance information
Used by actions: DescribeLibraDBClusterDetail.
| Name | Type | Required | Description |
|---|---|---|---|
| DbMode | String | No | Database schema |
| InstanceCpu | Integer | No | Number of CPU cores |
| InstanceDeviceType | String | No | Instance type |
| InstanceId | String | No | Instance ID. |
| InstanceMemory | Integer | No | memory |
| InstanceName | String | No | Instance name. |
| InstanceRole | String | No | Instance role |
| InstanceStatus | String | No | Instance status |
| InstanceStatusDesc | String | No | Status description. |
| InstanceStorage | Integer | No | hard disk |
| InstanceStorageType | String | No | Hard disk type. |
| InstanceType | String | No | Engine type. |
| MaintainDuration | Integer | No | Duration. |
| MaintainStartTime | Integer | No | Execution start time (seconds from 00:00) |
| MaintainWeekDays | Array of String | No | The time when it can be executed. Enumeration value: ["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"]. |
| NodeList | Array of String | No | Node list |
| InstanceTasks | Array of ObjectTask | No | Instance task |
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, DescribeInstanceSpecsByOperationType.
| 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. |
| MaxCpu | Float | Maximum cpu |
| MinCpu | Float | Minimum cpu |
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. |
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. |
libra cluster information
Used by actions: DownloadLibraDBClusterList.
| Name | Type | Required | Description |
|---|---|---|---|
| AppId | Integer | No | User ID |
| ClusterId | String | No | Cluster ID |
| ClusterName | String | No | Cluster name. |
| CreateTime | String | No | Creation time. |
| DbVersion | String | No | Database version. |
| InstanceSet | Array of LibraInstanceSet | No | instance information |
| PayMode | Integer | No | Payment mode |
| PeriodEndTime | String | No | Expiration time. |
| ProjectID | Integer | No | Project ID |
| Region | String | No | Region. |
| RenewFlag | Integer | No | Auto-renewal flag. 1: Automatic renewal. 0: Non-renewal upon expiration. |
| Status | String | No | Status. |
| StatusDesc | String | No | Status description. |
| Storage | Integer | No | Storage size |
| UsedStorage | Integer | No | Used Capacity |
| Vip | String | No | VIP address |
| Vport | Integer | No | vport port |
libra cluster detail
Used by actions: DescribeLibraDBClusterDetail.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID. |
| ClusterName | String | Cluster name. |
| Region | String | Region |
| Status | String | Status |
| StatusDesc | String | Status description |
| Storage | Integer | Storage size |
| VpcName | String | VPC name |
| VpcId | String | vpc Unique id |
| SubnetName | String | Subnet name. |
| SubnetId | String | Subnet ID. |
| CreateTime | String | Creation time. |
| DbVersion | String | Database version |
| UsedStorage | Integer | Used capacity |
| Vip | String | vip address |
| Vport | Integer | vport |
| RoAddr | Array of RoAddr | vip address and vport of the cluster read-only instance |
| CynosVersion | String | cynos version |
| IsFreeze | String | Freeze or not |
| Tasks | Array of ObjectTask | Task List |
| MasterZone | String | Primary AZ |
| InstanceSet | Array of InstanceSet | Instance collection |
| PayMode | Integer | Payment mode |
| PeriodEndTime | String | Expiry time |
| ProjectID | Integer | Project ID. |
| RenewFlag | Integer | Auto-renewal flag |
| CynosVersionTag | String | Version tag |
| NoSupportAddRo | String | Additions are not supported when ro is yes. Additions are supported when ro is no/null/"". |
| Zone | String | AZ. |
| PhysicalZone | String | Physical AZ |
| AnalysisUpgradeVersionInfo | UpgradeAnalysisInstanceVersionInfo | Grayscale information for version upgrade Note: This field may return null, indicating that no valid values can be obtained. |
Cluster list information
Used by actions: DescribeLibraDBClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| AppId | Integer | No | User ID |
| ClusterId | String | No | Cluster ID |
| ClusterName | String | No | Cluster name. |
| CreateTime | String | No | Creation time. |
| CynosVersion | String | No | cynos version |
| CynosVersionTag | String | No | Version tag |
| DbVersion | String | No | Database version. |
| InstanceNum | Integer | No | Instance count |
| IsFreeze | String | No | Whether to freeze |
| NetAddrs | Array of NetAddr | No | Network address. |
| PayMode | Integer | No | Payment mode |
| PeriodEndTime | String | No | Expiration time. |
| ProjectID | Integer | No | Project ID |
| Region | String | No | Region. |
| RenewFlag | Integer | No | Auto-renewal flag. 1: Automatic renewal. 0: Non-renewal upon expiration. |
| Status | String | No | Status. |
| StatusDesc | String | No | Status description. |
| Storage | Integer | No | Storage size in GB |
| SubnetId | String | No | Subnet ID. |
| Tasks | Array of ObjectTask | No | Task list |
| Uin | String | No | Account ID. |
| Vip | String | No | VIP address |
| VpcId | String | No | Unique ID of VPC |
| Vport | Integer | No | vport port |
| UpdateTime | String | No | Update time |
| MasterZone | String | No | Primary AZ. |
| PhysicalZone | String | No | physical AZ |
| Zone | String | No | Availability zone |
Source database information of the libra analysis cluster
Used by actions: ModifyLibraDBClusterDataSource.
| Name | Type | Required | Description |
|---|---|---|---|
| SrcInstanceType | String | Yes | Source endpoint type |
| AccessType | String | No | Network type. |
| SrcInstanceId | String | No | Source instance ID |
| SrcClusterId | String | No | Source cluster ID |
| IP | String | No | Address. |
| Port | String | No | Port. |
| User | String | No | Username. |
| Password | String | No | Password. |
| SqlMode | String | No | Source sql mode |
| SrcAppId | Integer | No | Source application id |
| SrcUin | String | No | source account |
| SrcSubAccountUin | String | No | sub-account |
| AccountMode | String | No | Account |
| Region | String | No | Source instance region |
| Operation | String | No | Operation of the source instance |
libra instance initialization info
Used by actions: CreateLibraDBClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| Cpu | Integer | No | cpu |
| Memory | Integer | No | memory |
| StorageSize | Integer | No | hard disk |
| StorageType | String | No | Storage type |
| InstanceType | String | No | Instance type |
| LibraDBVersion | String | No | Instance version |
| InstanceCount | Integer | No | Instance count |
| VpcId | String | No | vpc id |
| SubnetId | String | No | subnet id |
| Port | Integer | No | Port. |
| ReplicasNum | Integer | No | Number of instance replicas to purchase |
LibraDB node information
Used by actions: DescribeLibraDBInstanceDetail.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeId | String | No | LibraDB Node ID |
| Status | String | No | Node status |
| DataStatus | String | No | syncing data |
| Cpu | Integer | No | Number of CPU cores. |
| Memory | Integer | No | Memory size. Unit: GB. |
| Storage | Integer | No | Disk size, in GB |
| Message | String | No | Error message |
LibraDB version information
Used by actions: DescribeLibraDBVersion.
| Name | Type | Description |
|---|---|---|
| Version | String | Version |
| Tag | String | Version tag |
| HasPermission | Boolean | Can be used this version |
libra instance information
Used by actions: DownloadLibraDBClusterList.
| Name | Type | Required | Description |
|---|---|---|---|
| DbMode | String | No | Database schema |
| InstanceCpu | Integer | No | Number of CPU cores |
| InstanceDeviceType | String | No | Instance type |
| InstanceGroupId | String | No | Group ID |
| InstanceId | String | No | Instance ID. |
| InstanceMemory | Integer | No | memory |
| InstanceName | String | No | Instance name. |
| InstancePayMode | Integer | No | Payment mode |
| InstancePeriodEndTime | String | No | Payment end time |
| InstanceRole | String | No | Instance role |
| InstanceStatus | String | No | Instance status |
| InstanceStatusDesc | String | No | Instance status description |
| NetType | String | No | Network type. |
| UniqSubnetId | String | No | Subnet ID |
| UniqVpcId | String | No | vpcid |
| Vip | String | No | Virtual IP |
| Vport | Integer | No | Virtual port |
| WanDomain | String | No | Public network region |
| WanIP | String | No | Public IP address |
| WanPort | Integer | No | Public network port |
| WanStatus | String | No | Public network status |
| InstanceStorage | Integer | No | hard disk |
| InstanceStorageType | String | No | Hard disk type. |
Log filter criteria
Used by actions: DescribeLibraDBSlowLogs.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | Filter items. |
| Compare | String | No | Filter criteria. Support the following conditions: WINC-include (segment dimension), WEXC-exclude (segment dimension), INC-include, EXC-exclude, EQS-equal, NEQ-not equal to, RA-range. |
| Value | Array of String | No | Filtered value. For reverse query, multiple values have an AND relationship. For forward query, multiple values have an OR relationship. |
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 | Automatic logical backup retention time. Unit: seconds. |
| LogicCrossRegionsEnable | String | No | Is cross-regional logical backup enabled?. Valid values: ON/OFF. |
| LogicCrossRegions | Array of String | No | |
| AutoCopyVaults | Array of CreateBackupVaultItem | No | Backup delivery relationship |
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. |
Synchronized database and table objects.
Used by actions: AddLibraDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| DbName | String | No | Database name. Note: This field may return null, indicating that no valid values can be obtained. |
| MigrateTableMode | String | No | Data table migration mode Note: This field may return null, indicating that no valid values can be obtained. |
| Tables | Array of MigrateTableItem | No | Data table information Note: This field may return null, indicating that no valid values can be obtained. |
Synchronize data objects
Used by actions: AddLibraDBInstances, ModifyLibraDBClusterReplicationObject.
| Name | Type | Required | Description |
|---|---|---|---|
| MigrateDBMode | String | No | Database migration mode Note: This field may return null, indicating that no valid values can be obtained. |
| Databases | Array of MigrateDBItem | No | Database information Note: This field may return null, indicating that no valid values can be obtained. |
Sync object details
Used by actions: ModifyLibraDBClusterReplicationObject.
| Name | Type | Required | Description |
|---|---|---|---|
| DatabaseTables | MigrateObject | No | Database table information |
Synchronize data table name
Used by actions: AddLibraDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| TableName | String | No | Data table name Note: This field may return null, indicating that no valid values can be obtained. |
Details of whether the parameter can be modified
Used by actions: DescribeClusterParams, DescribeClusterPasswordComplexity, DescribeInstanceParams, DescribeParamTemplateDetail.
| Name | Type | Description |
|---|---|---|
| IsModifiable | Integer |
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| OldVersion | String | |
| NewVersion | String | |
| UpgradeType | String |
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 1. common, universal type. 2. exclusive, dedicated. |
| DeviceType | String | Instance Machine Type After Scaling 1. common, universal type. 2. exclusive, dedicated. |
| UpgradeType | String | |
| LibraNodeCount | Integer | Specifies the quantity of libra nodes. |
| OldLibraNodeCount | Integer | Specifies the original quantity of libra nodes. |
Information of the modified instance parameter
Used by actions: AddInstances, AddServerlessRoInstances, 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. |
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 |
month date info
Used by actions: DescribeBackupConfig, ModifyBackupConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| Month | Integer | Yes | Month info |
| Day | Integer | Yes | date info |
Network information
Used by actions: DescribeClusters, DescribeLibraDBClusters, 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 |
Create account
Used by actions: CreateAccounts, CreateLibraDBClusterAccounts.
| 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. |
| Host | String | Yes | Host |
| AccountPassword | String | Yes | Password, which can contain 8-64 characters. |
| PasswordRotation | Integer | No | Whether password rotation is enabled (0: turn off; 1: turn on) |
| Description | String | No | Description |
| MaxUserConnections | Integer | No | Maximum number of user connections, which cannot be above 10,240. |
Task information
Used by actions: DescribeClusterDetail, DescribeClusters, DescribeInstances, DescribeIsolatedInstances, DescribeLibraDBClusterDetail, DescribeLibraDBClusters, DescribeProxies, DescribeSaveBackupClusters, DescribeVaults.
| 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 |
| ObjectType | String | No | Task type |
sync object list
Used by actions: AddLibraDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| DatabaseTables | MigrateObject | No | Database table information Note: This field may return null, indicating that no valid values can be obtained. |
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. |
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 |
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. |
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. |
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. |
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 |
Instance parameter information
Used by actions: DescribeInstanceParams.
| Name | Type | Description |
|---|---|---|
| CurrentValue | String | Current value |
| Default | String | Default value |
| EnumValue | Array of String | Optional enumerated value of the parameter. If it is a non-enumerated value, it is empty. |
| IsGlobal | Integer | 1: Global parameter, 0: Non-global parameter |
| Max | String | Maximum value |
| Min | String | Minimum value |
| NeedReboot | Integer | After modifying parameters, whether database restart is required to take effect. 0-no restart required, 1-restart required. |
| ParamName | String | Parameter name |
| ParamType | String | Parameter type: integer, enum, float, string, func |
| ModifiableInfo | ModifiableInfo | Whether the parameter is modifiable |
| Description | String | Parameter description |
| IsFunc | Boolean | Whether the type is formula |
| Func | String | Parameter configuration formula |
| FuncPattern | String | Default formula style for parameters that support formulas |
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. |
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. |
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 |
Access proxy configuration.
Used by actions: CreateClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| Cpu | Integer | No | cpu cores |
| Mem | Integer | No | Memory |
| ConnectionPoolType | String | No | Connection pool type: SessionConnectionPool (session-level connection pool) |
| OpenConnectionPool | String | No | Whether the connection pool is enabled, yes-enable, no-disable |
| ConnectionPoolTimeOut | Integer | No | Connection pool threshold: Measurement unit (seconds) |
| Description | String | No | description |
| ProxyZones | Array of ProxyZone | No | Database node information (this parameter is used in combination with ProxyCount and either one must be input) |
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). |
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). |
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. |
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. |
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. |
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. |
| ApNodeAsRoNode | Boolean | No | Whether to treat the libra node as an ordinary RO node |
| ApQueryToOtherNode | Boolean | No | libra node fault, whether to forward to other nodes |
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 |
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 |
Database proxy specifications
Used by actions: DescribeProxySpecs.
| Name | Type | Description |
|---|---|---|
| Cpu | Integer | Number of database proxy CPU cores |
| Mem | Integer | Database proxy memory |
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. |
Number of proxy nodes and their AZs
Used by actions: AddInstances, CheckTransferClusterZone, CreateClusters, CreateIntegrateCluster, CreateProxy, TransferClusterZone, UpgradeInstance, UpgradeProxy.
| Name | Type | Required | Description |
|---|---|---|---|
| ProxyNodeZone | String | No | AZ of the proxy node |
| ProxyNodeCount | Integer | No | The number of proxy nodes |
Query filter
Used by actions: DescribeClusters, DescribeInstances, DescribeIsolatedInstances, DescribeLibraDBClusters, DescribeProxyNodes, DescribeTasks, DownloadLibraDBClusterList.
| 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 |
Filters for query
Used by actions: DescribeProxies.
| Name | Type | Required | Description |
|---|---|---|---|
| Names | Array of String | Yes | Search field. Currently supports: ProxyGroupId |
| Values | Array of String | Yes | Search string |
| ExactMatch | Boolean | No | Whether to use exact match |
Blurry query filter.
Used by actions: DescribeSaveBackupClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| Names | Array of String | No | Field name |
| Values | Array of String | No | Field value. |
| ExactMatch | Boolean | No | Fuzzy matching. valid values: true (yes), false (no). |
redo log details.
Used by actions: DescribeRedoLogListByVault, DescribeRedoLogs.
| Name | Type | Description |
|---|---|---|
| FileName | String | Filename. |
| FileSize | Integer | File size |
| BackupTime | String | Backup time |
| RedoLogId | Integer | redoLogId |
| RedoCrossRegions | Array of BackupRegionAndIds | Cross-Region information. |
| Status | String | Status. |
| StartTime | String | Start time. |
| FinishTime | String | Completion time. |
| VaultInfos | Array of VaultInfo | Safe info |
| CopyStatus | String | Backup delivery status |
| EncryptKeyId | String | Encryption key |
| EncryptRegion | String | Key region for encryption |
Instance specifications in this region
Used by actions: DescribeLibraDBInstanceSpecs.
| Name | Type | Description |
|---|---|---|
| Cpu | Integer | Number of CPU cores Note: This field may return null, indicating that no valid values can be obtained. |
| Memory | Integer | Memory size. Note: This field may return null, indicating that no valid values can be obtained. |
| MinStorageSize | Integer | Minimum storage size Note: This field may return null, indicating that no valid values can be obtained. |
| MaxStorageSize | Integer | Maximum storage size Note: This field may return null, indicating that no valid values can be obtained. |
| HasStock | Boolean | Whether there is inventory Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceType | String | Instance type Note: This field may return null, indicating that no valid values can be obtained. |
| StorageType | String | Storage type Note: This field may return null, indicating that no valid values can be obtained. |
| MinReplicaNum | Integer | minimum replica count Note: This field may return null, indicating that no valid values can be obtained. |
| MaxReplicaNum | Integer | Maximum number of replicas Note: This field may return null, indicating that no valid values can be obtained. |
| ZoneStockInfos | Array of ZoneStockInfo4Libra | Availability zone inventory information list Note: This field may return null, indicating that no valid values can be obtained. |
Analysis engine sync object
Used by actions: ModifyLibraDBClusterReplicationObject.
| Name | Type | Required | Description |
|---|---|---|---|
| SrcInstanceType | String | Yes | Source instance type Note: This field may return null, indicating that no valid values can be obtained. |
| SrcClusterId | String | No | Source Cluster Id Note: This field may return null, indicating that no valid values can be obtained. |
| SrcInstanceId | String | No | Source instance ID Note: This field may return null, indicating that no valid values can be obtained. |
| ReplicationJobId | String | No | Copy task ID Note: This field may return null, indicating that no valid values can be obtained. |
| MigrateObjects | MigrateOpt | No | sync object details Note: This field may return null, indicating that no valid values can be obtained. |
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. |
Read-only instance address
Used by actions: DescribeLibraDBClusterDetail.
| Name | Type | Required | Description |
|---|---|---|---|
| IP | String | No | IP address |
| Port | Integer | No | Port. |
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| Cpu | Integer | |
| Memory | Integer | |
| StorageLimit | Integer | |
| OriginalClusterId | String | |
| OriginalClusterName | String | |
| RollbackStrategy | String | |
| SnapshotTime | String | |
| MinCpu | Integer | Roll back to the Serverless cluster with minimum CPU |
| MaxCpu | Integer | Roll back to the Serverless cluster with maximum CPU |
| SnapShotId | Integer | Snapshot ID. |
| RollbackDatabases | Array of RollbackDatabase | |
| RollbackTables | Array of RollbackTable | |
| BackupFileName | String | Specifies the backup file name. |
| RollbackProcess | RollbackProcessInfo | Rollback process. |
Used by actions: DescribeTasks, RollBackCluster, RollbackToNewCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| OldDatabase | String | Yes | |
| NewDatabase | String | Yes |
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 |
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. |
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. |
Used by actions: DescribeTasks, RollBackCluster, RollbackToNewCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| Database | String | Yes | |
| Tables | Array of RollbackTableInfo | Yes |
Used by actions: RollBackCluster, RollbackToNewCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| OldTable | String | Yes | Old table name. |
| NewTable | String | Yes | New table name. |
Rollback time range
Used by actions: DescribeRollbackTimeRange.
| Name | Type | Description |
|---|---|---|
| TimeRangeStart | String | Start time |
| TimeRangeEnd | String | End time |
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 |
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. |
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. |
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 |
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: No1: Yes |
| IsSupportNormal | Integer | Whether standard cluster is supported. Valid values: 0: No1: 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). |
Legacy backup list.
Used by actions: DescribeSaveBackupClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| BackupId | Integer | No | Backup id of the deceased. |
| ClusterId | String | No | Cluster ID. |
| ClusterName | String | No | Cluster name. |
| Region | String | No | Region. |
| Zone | String | No | Availability zone |
| BackupTime | String | No | Backup time |
| DbVersion | String | No | Database version. |
| DbMode | String | No | Db type (NORMAL, SERVERLESS). |
| ClusterStatus | String | No | Cluster status. |
| Tasks | Array of ObjectTask | No | Task list. |
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 |
serverless specification.
Used by actions: DescribeServerlessInstanceSpecs.
| Name | Type | Description |
|---|---|---|
| MinCpu | Float | cpu minimum value |
| MaxCpu | Float | Maximum value of cpu |
| MaxStorageSize | Integer | Maximum storage space |
| IsDefault | Integer | 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. |
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. |
Used by actions: DescribeClusterDetail, DescribeTasks.
| Name | Type | Description |
|---|---|---|
| Zone | String | Availability zone |
| BinlogSyncWay | String | binlog synchronization mode. |
| SemiSyncTimeout | Integer | Semi-Sync timeout period in milliseconds. |
Used by actions: DescribeInstanceSpecs, DescribeInstanceSpecsByOperationType, 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. |
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. |
Snapshot backup settings.
Used by actions: ModifyBackupConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| BackupCustomAutoTime | Boolean | No | System automation time. |
| BackupTimeBeg | Integer | No | Indicates the full backup start time. value range: [0-24*3600]. for example, 0:00, 1:00, and 2:00 are 0, 3600, and 7200 respectively. |
| BackupTimeEnd | Integer | No | Indicates the full backup end time. value range: [0-24*3600]. for example, 0:00, 1:00, and 2:00 are 0, 3600, and 7200 respectively. |
| BackupWeekDays | Array of String | No | This parameter currently does not support modification and no need to specify. backup frequency is an array of length 7, corresponding to the backup method from sunday to saturday, full for full backup and increment for incremental backup. |
| BackupIntervalTime | Integer | No | Interval. |
| ReserveDuration | Integer | No | Indicates the backup retention period in seconds. data will be cleaned up longer than this time. 7 days means 3600247=604800. the maximum is 158112000. |
| BackupTriggerStrategy | String | No | Automatic data backup trigger policy, periodically: automatic periodic backup, frequent: high-frequency backup |
| AutoCopyVaults | Array of CreateBackupVaultItem | No | Safe info |
Sparse backup configuration
Used by actions: ModifyBackupConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| SparseBackupSwitch | String | No | Sparse backup switch: ON/OFF |
| SparseBackupConfigInfos | Array of SparseBackupConfigInfo | No | Sparse backup policy list (1-3) |
Sparse backup policy configuration info
Used by actions: DescribeBackupConfig, ModifyBackupConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| OpType | String | Yes | Operation type: add, modify, remove |
| ConfigId | String | No | Configuration ID |
| SparsePeriodConfig | String | No | Policy type: weekly/monthly/yearly |
| SparsePeriodTime | SparsePeriodTime | No | Cycle time configuration |
| SparseBackupSaveDays | Integer | No | Retention days (7-7320 days, longest 20 years) |
Sparse backup configuration
Used by actions: DescribeBackupConfig.
| Name | Type | Description |
|---|---|---|
| SparseBackupSwitch | String | Sparse backup switch: ON/OFF Note: This field may return null, indicating that no valid values can be obtained. |
| SparseBackupConfigInfos | Array of SparseBackupConfigInfo | Sparse backup policy list (1-3) Note: This field may return null, indicating that no valid values can be obtained. |
Sparse backup cycle info
Used by actions: DescribeBackupConfig, ModifyBackupConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| WeekDays | Array of Integer | No | Weekly: List of days of the week, 1-7, 1=Monday, 7=Sunday (Only used for weekly cycle, up to 7). |
| Days | Array of Integer | No | By month: Date list, 1-31 (for monthly cycle only, up to 7) |
| MonthDays | Array of MonthDay | No | Yearly: Month-day composite column (Only for yearly cycle, up to 7) |
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| Status | String | Status |
Mapping relationship
Used by actions: DescribeLibraDBClusterTableMapping.
| Name | Type | Required | Description |
|---|---|---|---|
| SrcInstanceId | String | No | Source instance Id |
| DatabaseName | String | No | Database name. |
| TableName | String | No | Table name |
| MapDatabaseName | String | No | Map database name |
| MapTableName | String | No | Mapping table name |
| Status | String | No | Synchronization status |
| Process | Float | No | Sync progress |
| Lag | Integer | No | Delay |
| Message | String | No | Message |
| IsPrimary | Boolean | No | Whether it is the main table |
| VirtualColValue | String | No | Virtual column padding value |
MySQL table permission
Used by actions: DescribeLibraDBClusterAccountAllPrivileges, ModifyAccountPrivileges, ModifyLibraDBClusterAccountPrivilege.
| Name | Type | Required | Description |
|---|---|---|---|
| Db | String | Yes | Database name |
| TableName | String | Yes | Table name |
| Privileges | Array of String | Yes | Permission list |
Information of tags associated with cluster, including TagKey and TagValue
Used by actions: CreateClusters, CreateIntegrateCluster, CreateLibraDBClusters, DescribeAuditInstanceList, DescribeClusterDetail, DescribeClusters, DescribeInstances, DescribeIsolatedInstances, DescribeLibraDBInstanceDetail, RollbackToNewCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
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"]. |
Task progress query.
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| CurrentStep | String | Current step. |
| CurrentStepProgress | Integer | Current progress. |
| CurrentStepRemainingTime | String | Estimated Time |
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. |
Billing details
Used by actions: InquirePriceCreate, InquirePriceModify, InquirePriceMultiSpec, InquirePriceRenew.
| Name | Type | Description |
|---|---|---|
| TotalPrice | Integer | Resource total price under prepaid mode, excluding discounts. unit: microCent. 1 US dollar equals 1e8 microCents. |
| Discount | Float | Total discount. 100 means no discount. |
| TotalPriceDiscount | Integer | Discounted total price under prepaid mode, unit: cent. 1 US dollar equals 1e8 microCents. for example, the user enjoys a Discount = TotalPrice * Discount. |
| UnitPrice | Integer | Unit resource price in postpaid mode, excluding discounts. unit: cent. 1 US dollar equals 1e2 cents |
| UnitPriceDiscount | Integer | Unit resource price in postpaid mode after Discount, unit: cent. 1 US dollar equals 1e2 cents. for example, the user enjoys a Discount = unitprice * Discount. |
| ChargeUnit | String | Price unit |
| UnitPriceHighPrecision | String | Excludes discounted rates under high precision. |
| UnitPriceDiscountHighPrecision | String | Discounted price under high precision. |
| AmountUnit | String | Currency unit. |
Analyze instance version upgrade, connection information used for grayscale after the upgrade
Used by actions: DescribeLibraDBClusterDetail, DescribeLibraDBInstanceDetail.
| Name | Type | Description |
|---|---|---|
| Vip | String | ip |
| Vport | Integer | Port |
| EngineVersion | String | Version |
| ExpiredTime | Integer | Expiry time |
Used by actions: AddInstances, UpgradeInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Cpu | Integer | Yes | cpu |
| Mem | Integer | Yes | memory |
| ProxyZones | Array of ProxyZone | Yes | |
| ReloadBalance | String | No |
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 |
Safe info
Used by actions: DescribeBackupList, DescribeBinlogs, DescribeRedoLogListByVault, DescribeRedoLogs.
| Name | Type | Required | Description |
|---|---|---|---|
| VaultId | String | No | Safe id |
| VaultName | String | No | Safe name |
| VaultRegion | String | No | Safe region |
| VaultStatus | String | No | Safe status |
| BackupSaveSeconds | Integer | No | Backup retention period |
Backup file list that will be deleted
Used by actions: CalculateBackupSaveSecExpires.
| Name | Type | Description |
|---|---|---|
| BackupId | Integer | Backup file ID |
| BackupName | String | Backup file name |
Inventory information in an AZ
Used by actions: DescribeInstanceSpecs, DescribeInstanceSpecsByOperationType.
| 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. |
Inventory information of regions sold by Libra
Used by actions: DescribeLibraDBInstanceSpecs.
| Name | Type | Description |
|---|---|---|
| Zone | String | Availability zone Note: This field may return null, indicating that no valid values can be obtained. |
| HasStock | Boolean | whether there is inventory Note: This field may return null, indicating that no valid values can be obtained. |
文档反馈