AI optimizer status
Used by actions: DescribeClusterDetail.
| Name | Type | Description |
|---|---|---|
| Status | String | Status. closing: turning off, closed: closed, opening: enabling, training: training, trained: training completed, train_failed: training failed. |
| OpenTime | String | Activation time. |
| TrainingProgress | Integer | Training progress |
Task data of the AI optimizer
Used by actions: DescribeTasks.
| Name | Type | Required | Description |
|---|---|---|---|
| TemplateID | String | No | Template ID |
Functions supported by the cluster
Used by actions: DescribeClusterDetail, DescribeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| IsSupportSlaveZone | String | Yes | Whether a secondary AZ is supported |
| NonsupportSlaveZoneReason | String | Yes | The causes for no support from the availability zone |
| IsSupportRo | String | Yes | Whether RO instance is supported |
| NonsupportRoReason | String | Yes | Reasons for no support for RO instances |
| 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 for transparent data encryption |
| IsSupportManualLogic | String | No | Whether manual initiation of logical backup is supported. |
| IsSupportGlobalEncryption | String | No | Whether global encryption can be enabled |
| NoSupportGlobalEncryptionReason | String | No | The causes for no support for global encryption |
| NoSupportTransparentDataEncryptionReasonCode | String | No | Status code for reasons of no support for transparent encryption |
| NoSupportGlobalEncryptionReasonCode | String | No | Status code for the reason why global encryption is not supported |
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 | Maximum user 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. |
Filter conditions for querying audit instances.
Used by actions: DescribeAuditInstanceList.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Filter condition value. Supports InstanceId (instance ID), InstanceName (instance name), ProjectId (project ID), TagKey (tag key), and Tag (tag, separated by vertical bars, for example: Tagkey|Tagvalue). |
| ExactMatch | Boolean | Yes | true indicates exact matching; false indicates fuzzy matching. |
| Values | Array of String | Yes | Filter value. |
Audit instance details.
Used by actions: DescribeAuditInstanceList.
| Name | Type | Description |
|---|---|---|
| ProjectId | Integer | Project ID. |
| TagList | Array of Tag | Tag information. |
Audit log details
Used by actions: DescribeAuditLogs.
| Name | Type | Description |
|---|---|---|
| AffectRows | Integer | Number of affected rows. |
| ErrCode | Integer | Error code. |
| SqlType | String | SQL type. |
| TableName | String | Table name. |
| InstanceName | String | Instance name. |
| PolicyName | String | Audit policy name. |
| DBName | String | Database name. |
| Sql | String | SQL statement. |
| Host | String | Client address. |
| User | String | Username. |
| ExecTime | Integer | Execution time, in microseconds. |
| Timestamp | String | Time. |
| SentRows | Integer | Number of rows returned. |
| ThreadId | Integer | Execution thread ID. |
| CheckRows | Integer | Number of scanned rows. |
| CpuTime | Float | cpu execution time, in microseconds. |
| IoWaitTime | Integer | IO wait time, in microseconds. |
| LockWaitTime | Integer | Lock waiting time in microseconds. |
| TrxLivingTime | Integer | Transaction continuous waiting time, in µs. |
| NsTime | Integer | Start time. Together with timestamp, it forms a nanosecond-precision time. |
| TemplateInfo | Array of LogRuleTemplateInfo | Basic information of the log hit rule template |
| TrxId | Integer | Transaction ID |
| ClientPort | Integer | Client port. |
Filter criteria for 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 criteria of the rule template |
| Description | String | Rule template description. |
| CreateAt | String | Rule template creation time. |
| 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. Valid values: 0 - Alarm disabled, 1 - Alarm enabled. |
| Status | Integer | Template status. Valid values: 0 - No task, 1 - modifying. |
| AffectedInstances | Array of String | Instances to which this rule template is applied. |
Relationship for automatically delivering to a safe
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, automatic 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 | Refers to the full backup start time, [0-24*3600], for example, 0:00, 1:00, 2:00 are 0, 3600, 7200 respectively |
| BackupTimeEnd | Integer | No | Indicates the full backup end time, [0-24*3600], for example, 0:00, 1:00, 2:00 are 0, 3600, 7200 respectively |
| BackupWeekDays | Array of String | No | Currently this parameter cannot be modified and no need to specify. Backup frequency is an array of length 7, corresponding to the backup method from Sunday to Saturday, full-full backup, increment-incremental backup. |
| BackupIntervalTime | Integer | No | Interval |
| ReserveDuration | Integer | No | Indicates the backup retention period in seconds. Data will be cleaned up after this time. Seven days is represented as 3600247=604800, with a maximum of 158112000. |
| CrossRegionsEnable | String | No | Cross-region backup enabled |
| CrossRegions | Array of String | No | Cross-regional backup region |
| CrossRegionSaveDays | Integer | No | Cross-region backup retention period Unit: day |
| 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. This field is 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 being deleted |
| SnapshotTime | String | Backup file time |
| BackupId | Integer | Backup ID |
| SnapShotType | String | Snapshot type. Available values: full (full); increment (incremental) |
| BackupName | String | Backup file remarks |
| ExistRegions | Array of BackupRegionAndIds | Region where backup files are located |
| CopyStatus | String | Delivery status |
| EncryptKeyId | String | Secret key id. |
| EncryptRegion | String | Key region |
| VaultInfos | Array of VaultInfo | Safe information. |
| BackupPeriodStrategy | String | Backup periodic policy |
Backup download cluster limit parameter
Used by actions: DescribeBackupDownloadRestriction, DescribeBackupDownloadUserRestriction.
| Name | Type | Required | Description |
|---|---|---|---|
| ClusterId | String | No | Cluster ID. |
| BackupLimitRestriction | BackupLimitRestriction | No | Download limit configuration |
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 means the vpc specified by LimitVpc can be downloaded. The default is In. |
| IpComparisonSymbol | String | No | In: Download is allowed from the specified ip; NotIn: Download is not allowed from the specified ip |
| LimitVpcs | Array of BackupLimitVpcItem | No | Limit download vpc settings |
| LimitIps | Array of String | No | Limit download ip settings |
VPC setting item for restricting the download source of backup files
Used by actions: DescribeBackupDownloadUrl, DescribeBinlogDownloadUrl, ModifyBackupDownloadRestriction, ModifyBackupDownloadUserRestriction.
| Name | Type | Required | Description |
|---|---|---|---|
| Region | String | No | Limit the region of the download source. Currently only support the current region. |
| VpcList | Array of String | No | vpc list with download restrictions |
Region and ID of the backup file
Used by actions: DescribeBackupList, DescribeRedoLogListByVault, DescribeRedoLogs.
| Name | Type | Description |
|---|---|---|
| BackupRegion | String | Backup region |
| BackupId | Integer | Backup ID |
Backup usage information
Used by actions: DescribeBackupOverview.
| Name | Type | Description |
|---|---|---|
| BackupVolume | Float | Backup usage |
| BackupType | String | Backup type |
| BackupMethod | String | Backup method. |
Billing 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 package
Used by actions: DescribeResourcePackageList.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Bound cluster ID. |
| InstanceRegion | String | Region of the bound instance |
| InstanceType | String | Bound instance type |
| ExtendIds | Array of String | Instance ID under the bound cluster |
Binlog configuration information.
Used by actions: DescribeBinlogConfig, ModifyBinlogConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| BinlogSaveDays | Integer | Yes | binlog retention time |
| BinlogCrossRegionsEnable | String | Yes | Whether binlog cross-region backup is enabled |
| BinlogCrossRegions | Array of String | No | Cross-region binlog |
| BinlogCrossRegionSaveDays | Integer | No | Cross-region backup retention period Unit: day |
| AutoCopyVaults | Array of CreateBackupVaultItem | No | Safe information |
Binlog description
Used by actions: DescribeBinlogListByVault, DescribeBinlogs.
| Name | Type | Description |
|---|---|---|
| FileName | String | Binlog file name |
| FileSize | Integer | File size, unit: byte |
| StartTime | String | Earliest transaction time |
| FinishTime | String | Latest transaction time |
| BinlogId | Integer | Binlog file ID |
| CrossRegions | Array of String | Cross-region of binlog |
| CopyStatus | String | Backup delivery status |
| VaultInfos | Array of VaultInfo | Safe information. |
| EncryptKeyId | String | Encryption key |
| EncryptRegion | String | Key region for encryption |
| ExistRegions | Array of BinlogRegionInfo | Geographical distribution information of backups |
binlog retention info in each region
Used by actions: DescribeBinlogs.
| Name | Type | Description |
|---|---|---|
| BackupRegion | String | Backup region. |
| BackupId | Integer | Backup ID |
Task information
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| ID | Integer | Task ID. |
| AppId | Integer | User AppID. |
| ClusterId | String | Cluster ID. |
| Region | String | Region. |
| CreateTime | String | Task creation time |
| DelayTime | String | Delayed execution time |
| ErrMsg | String | Task failure information |
| FlowId | Integer | Asynchronous task flow id |
| Input | String | Task input information |
| InstanceGroupId | String | Instance group id |
| InstanceId | String | Instance id |
| ObjectId | String | Task operation object id. |
| ObjectType | String | Task operation object type |
| Operator | String | Operator uin |
| Output | String | Task output information |
| Status | String | Task status. |
| TaskType | String | Task type |
| TriggerTaskId | Integer | ID of the parent task that triggers this task |
| UpdateTime | String | Update time. |
| StartTime | String | Task start time |
| EndTime | String | Task end time |
| ClusterName | String | Cluster name. |
| InstanceName | String | Instance name. |
| Process | Integer | Task Progress |
| CreateClustersData | CreateClustersData | Create cluster task information |
| RollbackData | RollbackData | Cluster rollback task information |
| ModifyInstanceData | ModifyInstanceData | Instance configuration change task information |
| ManualBackupData | ManualBackupData | Manual backup task information |
| ModifyDbVersionData | ModifyDbVersionData | Modify kernel version task information |
| ClusterSlaveData | ClusterSlaveData | Cluster Availability Zone Information |
| SwitchClusterLogBin | SwitchClusterLogBin | Convert cluster logs |
| ModifyInstanceParamsData | BizTaskModifyParamsData | Modify instance parameter data |
| 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 |
| AIOptimizerTaskData | AIOptimizerTaskData | AI optimizer task information |
Parameter modification task details of an instance
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| ModifyInstanceParamList | Array of ModifyParamItem | Instance parameter modification task details |
Parameter modification task data
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID |
| ClusterParamList | Array of ModifyParamItem | Cluster parameter modification data |
| ModifyInstanceParams | Array of BizTaskModifyInstanceParam | Instance parameter modification data |
CLS log shipping configuration
Used by actions: CreateCLSDelivery.
| Name | Type | Required | Description |
|---|---|---|---|
| TopicOperation | String | Yes | Log topic operation. Options: create, reuse. Create: Add a log topic. Use TopicName to create a log topic. reuse: Use an existing log topic and specify it by TopicId. It is not allowed to use a combination of an existing log topic and a new log set. |
| GroupOperation | String | Yes | Logset operation. Options: create, reuse. create: add a new log set using GroupName. reuse: utilize an existing logset and specify the logset by GroupId. It is not allowed to use a combination of an existing log topic and a new log set. |
| Region | String | Yes | Log delivery region |
| TopicId | String | No | Log topic id |
| TopicName | String | No | Log topic name |
| GroupId | String | No | Logset id |
| GroupName | String | No | Log set name. |
Check item
Used by actions: CheckCreateLibraDBInstance.
| Name | Type | Description |
|---|---|---|
| Item | String | Check item name |
| Result | String | Verification result of this item |
| CurrentValue | String | Details of validation failed and modification suggestions |
| ExpectedValue | String | Detailed explanation of validation failure and modification suggestions |
Cluster information.
Used by actions: DescribeClusterDetail.
| 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. |
| InstanceType | String | Engine type |
| Status | String | Instance status Enumeration values:
|
| StatusDesc | String | Status description in Chinese of the instance |
| Cpu | Integer | Cpu Unit: core |
| MinCpu | Float | Lower limit of cpu for serverless instance Unit: core |
| MaxCpu | Float | cpu upper limit of the serverless instance Unit: core |
| Memory | Integer | Memory Unit: GB |
| InstanceStorage | Integer | Hard disk. |
| InstanceRole | String | Instance role |
| MaintainStartTime | Integer | Execution start time (seconds from 00:00:00) |
| MaintainDuration | Integer | Continuous time (unit: second) |
| MaintainWeekDays | Array of String | The time when it can be executed. Enumeration values: ["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"] |
| InstanceTasks | Array of ObjectTask | Instance task information |
| DeviceType | String | Instance Machine Type Enumeration values:
|
| InstanceStorageType | String | Instance storage type |
| DbMode | String | Database type |
| NodeList | Array of String | Node list |
| ServerlessStatus | String | serverless instance sub-status |
| AIOptimizerStatus | AIOptimizerStatus | AI optimizer status |
| ProjectId | Integer | Project ID. |
| Region | String | Region. |
| Zone | String | AZ. |
| PhysicalZone | String | Physical AZ of the instance location |
| DbType | String | Database type |
| DbVersion | String | Database version. |
| Storage | Integer | Stored amount Unit: GB |
| StorageId | String | Prepaid storage Id. |
| StoragePayMode | Integer | Storage billing type. Valid values:
|
| CreateTime | Timestamp ISO8601 | Creation time. |
| UpdateTime | Timestamp ISO8601 | Update time. |
| IsolateTime | Timestamp ISO8601 | Isolation time |
| DestroyTime | String | Instance destruction time |
| DestroyDeadlineText | String | Termination phase |
| PeriodEndTime | Timestamp ISO8601 | Instance expiration time |
| VpcId | String | VPC network ID |
| SubnetId | String | Subnet ID. |
| Vip | String | Instance private IP address |
| Vport | Integer | Instance Intranet Port |
| NetType | Integer | Network type |
| WanIP | String | Public network IP |
| WanPort | Integer | External port |
| WanStatus | String | Public network enabled status |
| WanDomain | String | Instance public domain name. |
| InstanceNetInfo | Array of InstanceNetInfo | Network information of the instance |
| PayMode | Integer | Payment mode. Valid values:
|
| ProcessingTask | String | Currently processing task |
| RenewFlag | Integer | Renewal flag. |
| Tasks | Array of ObjectTask | Task |
| IsFreeze | String | Whether to freeze |
| ResourceTags | Array of Tag | Resource label. |
| InstanceAbility | InstanceAbility | Supported capabilities of the current instance |
| GdnId | String | Global database unique ID |
List of cluster read-only switches
Used by actions: DescribeClusterReadOnly.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID |
| ReadOnlyValue | String | Read-only switch value |
Cluster AZ information.
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| OldMasterZone | String | Old primary AZ |
| OldSlaveZone | Array of String | Secondary availability zone |
| NewMasterZone | String | New primary AZ |
| NewSlaveZone | Array of String | Secondary AZ |
| NewSlaveZoneAttr | Array of SlaveZoneAttrItem | New secondary 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 information
Used by actions: CreateBackup, DescribeBackupConfig, DescribeBinlogConfig, ModifyBackupConfig, ModifyBinlogConfig, ModifyClusterBinlogRedoLogAutoCopyVault.
| Name | Type | Required | Description |
|---|---|---|---|
| VaultId | String | No | Safe id |
| VaultRegion | String | No | Safe region |
Create cluster task information
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| Cpu | Integer | Instance CPU |
| Memory | Integer | Instance memory |
| StorageLimit | Integer | Cluster storage limit |
Cross-region backup information in each region
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| CrossRegion | String | Target region for backup |
| BackupId | Integer | Backup task ID in the target region |
| 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. Valid values: 0 (pay-as-you-go) and 1 (yearly/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 Tasks |
| Tasks | Array of ObjectTask | No | Task array of the cluster |
| ResourceTags | Array of Tag | No | tag Array bound to the cluster |
| DbMode | String | No | Db type (NORMAL, SERVERLESS) |
| ServerlessStatus | String | No | When the Db type is SERVERLESS, the status of the SERVERLESS cluster. Available values: |
| Storage | Integer | No | Cluster prepaid storage size. |
| StorageId | String | No | Storage ID when cluster storage is prepaid, used for prepaid storage configuration changes |
| StoragePayMode | Integer | No | Cluster storage payment mode. Valid values: 0 (pay-as-you-go) and 1 (yearly/monthly subscription). |
| MinStorageSize | Integer | No | Minimum storage corresponding to the cluster compute specification. |
| MaxStorageSize | Integer | No | Maximum storage value corresponding to 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 | Whether to freeze |
| OrderSource | String | No | Order source |
| Ability | Ability | No | Capacity |
| ResourcePackages | Array of ResourcePackage | No | Instance-bound resource package information (only storage resource packages are returned here, that is, packageType=DISK) |
| GdnId | String | No | Global database unique ID |
| GdnRole | String | No | Cluster role. Primary cluster - primary, slave cluster - standby. If GdnId is empty, this field is invalid. |
Cluster detail information
Used by actions: DescribeClusterDetail.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID. |
| ClusterName | String | Cluster name. |
| Region | String | Region. |
| Zone | String | Primary availability zone of the cluster |
| PhysicalZone | String | Physical AZ |
| Status | String | Status. Supported values are as follows:
|
| StatusDesc | String | Status description. |
| ServerlessStatus | String | When the Db type is SERVERLESS, the status of the SERVERLESS cluster. Available values: |
| StorageId | String | Storage Id |
| Storage | Integer | Storage size, in GB. |
| MaxStorageSize | Integer | Maximum storage specification, in GB |
| MinStorageSize | Integer | Minimum storage specification, in GB. |
| StoragePayMode | Integer | Storage billing type. Valid values: 1 (yearly/monthly subscription) and 0 (pay-as-you-go). |
| VpcName | String | VPC name. |
| VpcId | String | vpc Unique 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 | Maximum storage space |
| UsedStorage | Integer | Used capacity |
| Vip | String | vip address |
| Vport | Integer | vport |
| RoAddr | Array of Addr | vip address and vport of the cluster read-only instance |
| Ability | Ability | Functions supported by the cluster |
| CynosVersion | String | cynos version. |
| BusinessType | String | Business type |
| HasSlaveZone | String | Whether there is a secondary AZ |
| IsFreeze | String | Whether to freeze |
| Tasks | Array of ObjectTask | Task List |
| MasterZone | String | Current instance located availability zone for read-write |
| SlaveZones | Array of String | From the availability zone list |
| InstanceSet | Array of ClusterInstanceDetail | Instance information |
| PayMode | Integer | Payment mode |
| PeriodEndTime | String | Expiration time. |
| ProjectID | Integer | Project ID. |
| ResourceTags | Array of Tag | tag Array information bound to the instance |
| ProxyStatus | String | Proxy status. |
| LogBin | String | binlog switch. Available values: ON, OFF |
| IsSkipTrade | String | Whether to skip transaction |
| PitrType | String | PITR type. Available values: normal, redo_pitr |
| IsOpenPasswordComplexity | String | Whether to enable password complexity |
| NetworkStatus | String | Network type |
| ResourcePackages | Array of ResourcePackage | Resource package information bound to the cluster |
| RenewFlag | Integer | Auto-renewal flag. Valid values: 1 (auto-renewal) and 0 (non-renewal upon expiration). |
| NetworkType | String | Node network type |
| SlaveZoneAttr | Array of SlaveZoneAttrItem | Secondary AZ property |
| CynosVersionTag | String | Version tag. |
| GdnId | String | Global database network unique ID |
| GdnRole | String | Role of the cluster in the global data network. |
| UsedArchiveStorage | Integer | Level-2 storage usage, in GB. |
| ArchiveStatus | String | Archiving status. Enumeration values: |
| ArchiveProgress | Integer | Archive progress, percentage. |
| ClusterLevel | String | Cluster level. For example, P0, P1 |
| IsOpenTDE | Boolean | Whether to enable transparent encryption |
| RealZone | String | Current instance availability zone |
| StorageOverUse | String | Exceed limit enabled status Enumeration value:
Default value: no |
| StorageAutoExpand | String | Auto-scaling enabled status Enumeration value:
Default value: no |
Return type of the instance error log
Used by actions: DescribeInstanceErrorLogs.
| Name | Type | Description |
|---|---|---|
| Timestamp | Integer | Log timestamp |
| Level | String | Log level. |
| Content | String | Log content |
Instance information
Used by actions: DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, 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 | Primary availability zone of the cluster |
| Status | String | Instance status Enumeration values:
|
| StatusDesc | String | Status description in Chinese of the instance. |
| 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 in GB |
| Storage | Integer | Stored amount, unit: GB |
| InstanceType | String | Instance type Enumeration values:
|
| InstanceRole | String | Current role of the instance |
| 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 |
| WanIP | String | Public network IP |
| WanPort | Integer | External 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 lower limit |
| MaxCpu | Float | cpu upper limit of a 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 |
| MasterZone | String | Current instance availability zone for read-write |
| SlaveZones | Array of String | Standby availability zone |
| InstanceNetInfo | Array of InstanceNetInfo | Instance network information |
| ResourcePackages | Array of ResourcePackage | Instance binding resource package information (only return compute resource package here, for example, packageType=CCU) |
| 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 | Global database unique ID |
| RealZone | String | Current instance availability zone |
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 | serverless instance status. Possible values: |
| DbType | String | Database type |
| DbVersion | String | Database version. |
| Cpu | Integer | Cpu, unit: cores |
| Memory | Integer | Memory in GB |
| Storage | Integer | Stored amount, unit: GB |
| InstanceType | String | Instance type |
| InstanceRole | String | Current role of the instance |
| 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 |
| Charset | String | Character set. |
| CynosVersion | String | Cynos kernel version |
| RenewFlag | Integer | Renewal flag. |
| MinCpu | Float | serverless instance cpu lower limit |
| MaxCpu | Float | cpu upper limit of a serverless instance |
| DbMode | String | Db type: |
| MasterZone | String | Availability Zone of the Cluster's Read/Write Instance |
| RealZone | String | Actual availability zone of the instance |
| SlaveZones | Array of String | List of standby availability zones |
| StorageVersion | String | Storage edition Enumeration values:
|
Instance group information
Used by actions: DescribeClusterInstanceGroups, DescribeClusterInstanceGrps.
| Name | Type | Description |
|---|---|---|
| AppId | Integer | User AppID |
| ClusterId | String | Cluster ID |
| CreatedTime | String | Creation time. |
| DeletedTime | String | Deletion time. |
| InstanceGroupId | String | Instance group ID |
| Status | String | Status. |
| Type | String | Instance group (network) type. ha-ha: HA group; ro: read-only group; proxy: proxy; singleRo: exclusive read-only instance. |
| UpdatedTime | String | Update time. |
| Vip | String | Private IP address |
| Vport | Integer | Private network port. |
| WanDomain | String | Public network domain name. |
| WanIP | String | Public IP address |
| WanPort | Integer | External port |
| WanStatus | String | Public network status. |
| InstanceSet | Array of CynosdbInstance | Instance group information including instances |
| UniqVpcId | String | VPC ID |
| UniqSubnetId | String | Subnet ID. |
| OldAddrInfo | OldAddrInfo | Recycling IP information |
| ProcessingTasks | Array of String | Ongoing task |
| Tasks | Array of ObjectTask | Task list |
| NetServiceId | Integer | id of the biz_net_service table |
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 AZ |
| SrcUin | String | No | Source root 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 type |
| Status | String | Database status. |
| CollateRule | String | Sorting rule |
| Description | String | Database remarks. |
| 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 | Delivery type. Valid values: store (storage class), mq (message channel). |
| DeliverSubType | String | Delivery subtype: cls, ckafka. |
| DeliverConsumer | String | Submitter |
| DeliverConsumerName | String | Submitter name |
| DeliverError | String | Submission exception error |
DescribeBackupListByVaultItem
Used by actions: DescribeBackupListByVault.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID. |
| ClusterName | String | Cluster name |
| BackupFileInfo | BackupFileInfo | Backup information |
binlog backup information
Used by actions: DescribeBinlogListByVault.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | Cluster ID. |
| ClusterName | String | Cluster name. |
| BinlogFileInfo | BinlogItem | Binlog file information |
Redo 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 | Region of the cluster |
| ClusterZone | String | AZ of the cluster |
Safe information.
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 | Region of the key |
| 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 Binlog files (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 in seconds. |
| LockedTime | String | No | Locking time |
| Tasks | Array of ObjectTask | No | Associated task list. |
| VaultRegion | String | No | Region of the safe |
| AutoCopyConfigs | Array of AutoCopyConfig | No | Automatically deliver relationships |
Error log export format
Used by actions: ExportInstanceErrorLogs.
| Name | Type | Required | Description |
|---|---|---|---|
| Timestamp | String | No | Time |
| Level | String | No | Log level. Available values: note, warning, error |
| Content | String | No | Log content |
Exchange instance information
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| SrcInstanceInfo | RollbackInstanceInfo | Source instance information. |
| DstInstanceInfo | RollbackInstanceInfo | Destination instance information. |
Exchange RO group 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 | 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 for querying |
| SelectType | String | Query type. Common values: SIMPLE (simple query, excluding subqueries or UNION), PRIMARY (outermost query), SUBQUERY (first SELECT in a subquery), DERIVED (derived table/subquery in the FROM clause), UNION (second or later SELECT in a UNION), UNION RESULT (result set of a UNION). |
| Table | String | Data table name |
| Partitions | String | Query matching partition |
| Type | String | Access type (very important, a key metric for query efficiency), arranged 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 the primary key or unique index, commonly used in WHERE pk = 1 • eq_ref: Uses the primary key or unique index when connecting, and each index value matches only one row • ref: Uses a non-unique index search, which may match multiple rows • range: Index range scan, such as BETWEEN, >, <, IN • index: Full index scan (traverses the entire index tree) • ALL: Full-table scan (worst, needs optimization) |
| PossibleKeys | String | Indexes that may be used in querying. NULL means no index is available. |
| Key | String | Indexes actually used. NULL means no index is used. |
| KeyLen | String | Actual used index length (number of bytes). It can be used to determine which columns in a composite index are actually used. A shorter value indicates fewer index columns used. |
| Ref | String | Display which columns or constants to compare with the indexes in the key column. Common values: const, a column name, func (function result). |
| Rows | Integer | Estimated Number of Rows to Scan |
| Filtered | Float | Refers to the estimated percentage of rows remaining after table condition filtering. 100% means no additional filtering, and higher values are 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 |
| Region | String | No | Forward the instance region |
Global database task information
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| GdnId | String | Global database unique ID |
| GdnName | String | Unique alias of the global database |
| PrimaryClusterId | String | Primary cluster ID |
| PrimaryClusterRegion | String | Region of the primary cluster |
| StandbyClusterRegion | String | From the cluster region |
| StandbyClusterId | String | Slave cluster ID |
| StandbyClusterName | String | From the cluster name |
| ForceSwitchGdn | String | Whether a forced switchover has been performed |
| Code | Integer | code |
| Message | String | Prompt message |
| IsSupportForce | String | Whether forced switchover is supported |
Item price
Used by actions: InquirePriceMultiSpec.
| Name | Type | Description |
|---|---|---|
| InstancePrice | TradePrice | Instance price |
| StoragePrice | TradePrice | Storage price |
| GoodsSpec | GoodsSpec | Product specification |
Product specification
Used by actions: InquirePriceMultiSpec.
| Name | Type | Required | Description |
|---|---|---|---|
| GoodsNum | Integer | No | Number of products |
| Cpu | Integer | No | Number of CPU cores. Required for PREPAID and POSTPAID instance types. |
| Memory | Integer | No | Memory size, unit G, required for PREPAID and POSTPAID instance types |
| Ccu | Float | No | Ccu size, required for serverless type |
| StorageLimit | Integer | No | Storage size, required for PREPAID storage type |
| TimeSpan | Integer | No | Purchase period |
| TimeUnit | String | No | Duration unit. |
| DeviceType | String | No | Instance machine type 1. common: universal type. 2. exclusive: dedicated. |
Account, including accountName and 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: %. |
Operation list allowed for the instance
Used by actions: DescribeClusterDetail, DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, DescribeInstances, DescribeIsolatedInstances.
| Name | Type | Description |
|---|---|---|
| IsSupportForceRestart | String | Whether the instance supports forced reboot. Available values: yes: support, no: no support |
| NonsupportForceRestartReason | String | The causes for not supporting forced reboot |
Audit log search criteria
Used by actions: DescribeAuditLogs.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Filter item. Currently supports the following search criteria: Includes, excludes, includes (segment dimension), excludes (segment dimension): sql - SQL detail; alarmLevel - alarm level; ruleTemplateId - rule template id Equal to, not equal to, contains, does not contain: host - client IP address; user - userName; dbName - database name; Equal, not equal to: sqlType - SQL type; errCode - error code; threadId - thread ID. Range search (time type is unified to µs): execTime - execution time; lockWaitTime - execution time; ioWaitTime - IO wait time; trxLivingTime - transaction duration; cpuTime - CPU time; checkRows - scanned rows; affectRows - number of affected rows; sentRows - rows returned. |
| Compare | String | Yes | Filter criteria. The following conditions are supported: WINC-Contains (segment dimension) WEXC - Excluding (segment dimension) INC - included EXC - Excluding EQS - equal to NEQ - not equal to RA - Range. |
| Value | Array of String | Yes | Filtered value. In reverse query, multiple values have an AND relationship. In forward query, multiple values have an OR relationship. |
Audit rule details of the instance.
Used by actions: DescribeAuditRuleWithInstanceIds.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| AuditRule | Boolean | Whether it is rule audit. true - Rule audit, false - Full audit. |
| AuditRuleFilters | Array of AuditRuleFilters | Audit rule details. Valid only when AuditRule=true. |
| OldRule | Boolean | Whether it is an audit policy. |
| RuleTemplates | Array of RuleTemplateInfo | Description of the rule template applied to the instance. |
Instance audit details.
Used by actions: DescribeAuditInstanceList.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| AuditStatus | String | Audit status. ON - Audit is enabled, OFF - Audit is disabled. |
| LogExpireDay | Integer | Log retention period. |
| HighLogExpireDay | Integer | High-frequency storage duration. |
| LowLogExpireDay | Integer | Low-frequency storage duration. |
| BillingAmount | Float | Log storage volume. |
| HighRealStorage | Float | High-frequency storage volume. |
| LowRealStorage | Float | Infrequent access storage size. |
| AuditAll | Boolean | Whether full audit is enabled. true - Full audit. |
| CreateAt | String | Time when the audit service was activated. |
| InstanceInfo | AuditInstanceInfo | Instance-related information. |
| RealStorage | Float | Total storage. |
| RuleTemplateIds | Array of String | Rule template applied to the instance. |
| Deliver | String | Whether to enable log delivery: ON, OFF |
| DeliverSummary | Array of DeliverSummary | Log shipping type. |
Instance Log Delivery Information
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 | Logset id |
| GroupName | String | Log set name. |
| Region | String | Log delivery region |
| Status | String | Delivery status. Valid values: 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. Value range: [1,15] |
| MinRoCount | Integer | No | Minimum number of Serverless instances. Value range: [1,15] |
| MaxRoCount | Integer | No | Maximum count of Serverless instances, ranging from 1 to 15 |
| MinRoCpu | Float | No | Minimum specification of a Serverless instance |
| MaxRoCpu | Float | No | Maximum specification of a Serverless instance |
| DeviceType | String | No | Instance Machine Type
|
Instance weight
Used by actions: CreateIntegrateCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceName | String | No | Instance name, which is the name specified by InstanceInitInfo.InstanceName during cluster creation |
| Weight | Integer | No | Weight |
Instance network information.
Used by actions: DescribeClusterDetail, DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, DescribeInstances, DescribeIsolatedInstances, DescribeLibraDBInstanceDetail.
| Name | Type | Description |
|---|---|---|
| InstanceGroupType | String | Network type. |
| InstanceGroupId | String | Instance group ID |
| VpcId | String | VPC ID |
| SubnetId | String | Subnet ID. |
| NetType | Integer | Network type. 0: basic network; 1: vpc network; 2: Blackstone Network |
| Vip | String | VPC IP |
| Vport | Integer | VPC port. |
| WanDomain | String | Public network domain name. |
| WanIP | String | Public IP address |
| WanPort | Integer | External port |
| WanStatus | String | Public network status |
Instance parameter information
Used by actions: DescribeInstanceParams.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| ParamsItems | Array of ParamItemDetail | Instance parameter list |
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:00) |
| MaintainWeekDays | Array of String | No | The time when it can be executed. Enumeration values: ["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"] |
| NodeList | Array of String | No | Node list |
| InstanceTasks | Array of ObjectTask | No | Instance task |
Detailed information about available instance specifications. When creating an instance, Cpu/Memory determine the instance specification. The selectable storage size ranges from [MinStorageSize, MaxStorageSize].
Used by actions: DescribeInstanceSpecs, DescribeInstanceSpecsByOperationType.
| Name | Type | Description |
|---|---|---|
| Cpu | Integer | Instance CPU. Measurement unit: core |
| Memory | Integer | Instance memory. Unit: GB. |
| MaxStorageSize | Integer | Maximum available storage of an instance, unit: GB |
| MinStorageSize | Integer | Minimum available storage of an instance, unit: GB |
| HasStock | Boolean | Whether there is inventory |
| MachineType | String | Machine type |
| MaxIops | Integer | Maximum IOPS |
| MaxIoBandWidth | Integer | Maximum IO 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 | binlog retention days [7,1830] |
| BackupSaveDays | Integer | No | Backup retention days [7,1830] |
| SemiSyncTimeout | Integer | No | Semi-sync timeout period [1000,4294967295] |
| ProxyEndPointConfigs | Array of ProxyEndPointConfigInfo | No | proxy connection address configuration message |
Instance initialization configuration information
Used by actions: CreateIntegrateCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| Cpu | Integer | Yes | Instance cpu |
| Memory | Integer | Yes | Instance memory |
| InstanceType | String | Yes | Instance type. Valid values: rw (primary), ro (read-only). |
| InstanceCount | Integer | Yes | Number of instances. Value range: 1-15. |
| DeviceType | String | No | Instance machine type. common: universal type; exclusive: dedicated 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: renew automatically. 0: do not renew 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 |
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 | Whether to freeze |
| Tasks | Array of ObjectTask | Task List |
| MasterZone | String | Primary AZ |
| InstanceSet | Array of InstanceSet | Instance collection |
| PayMode | Integer | Payment mode |
| PeriodEndTime | String | Expiration time |
| ProjectID | Integer | Project ID. |
| RenewFlag | Integer | Auto-renewal flag |
| CynosVersionTag | String | Version tag. |
| NoSupportAddRo | String | Additions are not supported for ro yes - additions are not supported for ro, no/null/"" support adding ro |
| Zone | String | AZ. |
| PhysicalZone | String | Physical AZ |
| AnalysisUpgradeVersionInfo | UpgradeAnalysisInstanceVersionInfo | Grayscale information for version upgrade |
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. |
| 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 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 | sql_mode of the source |
| SrcAppId | Integer | No | Source application id |
| SrcUin | String | No | Source account |
| SrcSubAccountUin | String | No | Source sub-account |
| AccountMode | String | No | Account |
| Region | String | No | Source instance region |
| Operation | String | No | Operations on 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 | Whether this version can be used |
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. The following conditions are supported: WINC - contains (segment dimension), WEXC - excludes (segment dimension), INC - contains, EXC - excludes, EQS - equals, NEQ - not equals, RA - range. |
| Value | Array of String | No | Filtered value. In reverse query, multiple values have an AND relationship. In forward query, multiple values have an OR relationship. |
Basic information of the audit log hit rule template
Used by actions: DescribeAuditLogs.
| Name | Type | Description |
|---|---|---|
| RuleTemplateId | String | Template ID. |
| RuleTemplateName | String | Rule template name. |
| AlarmLevel | String | Alarm level. Valid values: 1 - Low risk, 2 - Medium risk, 3 - High risk. |
| RuleTemplateStatus | Integer | Rule template change status. Valid values: 0 - unchanged, 1 - changed, 2 - deleted. |
Logical backup configuration information
Used by actions: DescribeBackupConfig, ModifyBackupConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| LogicBackupEnable | String | No | Whether automatic logical backup is enabled |
| LogicBackupTimeBeg | Integer | No | Start time of automatic logical backup |
| LogicBackupTimeEnd | Integer | No | Auto logic backup end time |
| LogicReserveDuration | Integer | No | Automated logic backup retention time |
| LogicCrossRegionsEnable | String | No | Whether cross-regional logical backup is enabled |
| LogicCrossRegions | Array of String | No | Cross-regional logical backup |
| AutoCopyVaults | Array of CreateBackupVaultItem | No | Backup delivery relationship |
| LogicCrossRegionSaveDays | Integer | No | Day Unit: cross-regional logical backup retention time |
Manual backup task information
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| BackupType | String | Backup type. snapshot: snapshot backup. |
| BackupMethod | String | Backup method. auto: automatic backup, manual: manual |
| SnapshotTime | String | Backup time |
| CrossRegionBackupInfos | Array of CrossRegionBackupItem | Detailed information of cross-region backup items |
Synchronized database and table objects.
Used by actions: AddLibraDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| DbName | String | No | Database name. |
| MigrateTableMode | String | No | Data table migration mode |
| Tables | Array of MigrateTableItem | No | Data table information |
Synchronize data objects
Used by actions: AddLibraDBInstances, ModifyLibraDBClusterReplicationObject.
| Name | Type | Required | Description |
|---|---|---|---|
| MigrateDBMode | String | No | Database migration mode |
| Databases | Array of MigrateDBItem | No | Database information |
Details of sync objects
Used by actions: ModifyLibraDBClusterReplicationObject.
| Name | Type | Required | Description |
|---|---|---|---|
| DatabaseTables | MigrateObject | No | Contains database table information |
Synchronize data table name
Used by actions: AddLibraDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| TableName | String | No | Data table name |
Detailed information on whether the parameter is modifiable
Used by actions: DescribeClusterParams, DescribeClusterPasswordComplexity, DescribeInstanceParams, DescribeParamTemplateDetail.
| Name | Type | Description |
|---|---|---|
| IsModifiable | Integer | Whether the parameter can be modified. 1: allowed, 0: not allowed |
Modify database kernel version task information
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| OldVersion | String | Version before modification |
| NewVersion | String | Modified version |
| UpgradeType | String | Upgrade method |
Instance configuration change task information
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| Cpu | Integer | CPU after configuration change |
| Memory | Integer | Memory after configuration change |
| StorageLimit | Integer | Storage limit after configuration change |
| OldCpu | Integer | CPU before specification adjustment |
| OldMemory | Integer | Memory before specification modification |
| OldStorageLimit | Integer | Storage limit before configuration change |
| 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 | Upgrade method. Switch after the upgrade is completed or switch during the maintenance window. |
| LibraNodeCount | Integer | Number of libra nodes |
| OldLibraNodeCount | Integer | Original libra node count |
Modified instance parameter information
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 (only useful for output parameters) |
| Component | String | No | libra component type |
Supported modules
Used by actions: DescribeZones.
| Name | Type | Description |
|---|---|---|
| IsDisable | String | Whether it is supported. Available values: yes, no |
| ModuleName | String | Module Name |
Month, date, and info
Used by actions: DescribeBackupConfig, ModifyBackupConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| Month | Integer | Yes | Month info |
| Day | Integer | Yes | Date information |
Network info
Used by actions: DescribeClusters, DescribeLibraDBClusters, DescribeProxies.
| Name | Type | Required | Description |
|---|---|---|---|
| Vip | String | No | Private IP address |
| Vport | Integer | No | Private network port number |
| WanDomain | String | No | Public network domain name. |
| WanPort | Integer | No | Public network port number. |
| NetType | String | No | Network type (ro: read-only, rw/ha: read-write) |
| UniqSubnetId | String | No | Subnet ID. |
| UniqVpcId | String | No | VPC ID |
| Description | String | No | Description information |
| WanIP | String | No | Public IP address |
| WanStatus | String | No | 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, contains letters, digits, and underscores, starts with a letter, ending with a letter or digit, length 1-30 |
| Host | String | Yes | Host (% or ipv4 address) |
| AccountPassword | String | Yes | Password. The password length range is 8 to 64 characters. |
| PasswordRotation | Integer | No | Whether password rotation is enabled (0: turn off; 1: turn on) |
| Description | String | No | Description. |
| MaxUserConnections | Integer | No | Maximum user connections, cannot be greater than 10240 |
Task information
Used by actions: DescribeClusterDetail, DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, 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 | Task status. |
| ObjectId | String | No | Task ID (Cluster ID | instance group ID | instance ID) |
| ObjectType | String | No | Task type |
sync object list
Used by actions: AddLibraDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| DatabaseTables | MigrateObject | No | Database table information |
Database address
Used by actions: DescribeClusterInstanceGroups, DescribeClusterInstanceGrps.
| Name | Type | Description |
|---|---|---|
| Vip | String | IP |
| Vport | Integer | Port. |
| ReturnTime | String | Expected recycle time |
Resource package
Used by actions: DescribeResourcePackageList.
| Name | Type | Description |
|---|---|---|
| AppId | Integer | AppID |
| PackageId | String | Unique ID of the resource package |
| PackageName | String | Resource package name. |
| PackageType | String | Resource package type CCU: compute resource package. DISK: storage resource package. |
| PackageVersion | String | Resource package edition base - basic, common - general, enterprise - business |
| PackageRegion | String | Region of resource package use china: common in the Chinese mainland; overseas: common in Hong Kong (China), Macao (China), Taiwan (China), and overseas regions |
| Status | String | Resource package status creating using - in use; expired normal_finish: used up; apply_refund: Refund requested refund: refunded. |
| PackageTotalSpec | Float | Total resource package quantity |
| PackageUsedSpec | Float | Used amount of the resource package |
| HasQuota | Boolean | Whether there is still inventory surplus |
| BindInstanceInfos | Array of BindInstanceInfo | Bound instance information |
| StartTime | String | Effective time: 2022-07-01 00:00:00 |
| ExpireTime | String | Expiration time: 2022-08-01 00:00:00 |
| HistoryBindResourceInfos | Array of BindInstanceInfo | Resource package historic bound (unbound) instance information |
Resource pack details
Used by actions: DescribeResourcePackageDetail.
| Name | Type | Description |
|---|---|---|
| AppId | Integer | AppId account ID |
| PackageId | String | Unique ID of the resource package |
| InstanceId | String | Instance ID. |
| SuccessDeductSpec | Float | Capacity deducted successfully |
| PackageTotalUsedSpec | Float | Used capacity of the resource package as of now. |
| StartTime | String | Deduction start time |
| EndTime | String | Offset end time |
| ExtendInfo | String | Extension Information |
Resource package deduction priority
Used by actions: ModifyResourcePackagesDeductionPriority.
| Name | Type | Required | Description |
|---|---|---|---|
| PackageId | String | No | Resource pack with a custom deduction priority |
| DeductionPriority | Integer | No | Custom deduction priority |
Detailed description of instance parameters
Used by actions: DescribeParamTemplateDetail.
| Name | Type | Description |
|---|---|---|
| ParamName | String | Parameter name. |
| ParamType | String | Parameter type: integer, enum, float, string, func |
| SupportFunc | Boolean | true: supports "func"; false: no formula support |
| Default | String | Default value |
| Description | String | Parameter description |
| CurrentValue | String | Current parameter value |
| NeedReboot | Integer | Whether database restart is required after modifying parameters to take effect. 0: no restart required; 1: restart required. |
| Max | String | Maximum value allowed for the parameter |
| Min | String | Minimum allowed parameter value |
| EnumValue | Array of String | Optional enumerated values of the parameter. If it is a non-enumerated value, this parameter is empty |
| IsGlobal | Integer | 1: global parameter, 0: non-global parameter |
| MatchType | String | Match type. multiVal |
| MatchValue | String | Match target value. If multiVal is set, separate each key with a comma. |
| IsFunc | Boolean | true: formula; false: non-formula |
| Func | String | When the parameter is set to a formula, Func returns the set formula content. |
| ModifiableInfo | ModifiableInfo | Whether the parameter is modifiable |
| FuncPattern | String | Default formula style for 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 | Available option list when the parameter is enum, string, or bool. |
| Max | String | 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 a restart is required. |
| ParamType | String | Parameter type: integer, float, string, enum, or bool. |
| MatchType | String | Match type. multiVal and regex are used when the parameter type is string. |
| MatchValue | String | Match the target value. For multiVal, separate each key with a semicolon (;). |
| 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 | Default formula style for parameters that support formulas |
Description of the incoming parameter when modifying parameters
Used by actions: CreateClusters, CreateIntegrateCluster, CreateParamTemplate, ModifyClusterParam, RollbackToNewCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| ParamName | String | Yes | Parameter name. |
| CurrentValue | String | Yes | Current 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 values of the parameter. If it is a non-enumerated value, this parameter is empty |
| IsGlobal | Integer | 1: global parameter, 0: non-global parameter |
| Max | String | Maximum value |
| Min | String | Minimum value |
| NeedReboot | Integer | Whether database restart is required after modifying parameters 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 a formula |
| Func | String | Parameter configuration formula |
| FuncPattern | String | Default formula style for parameters that support formulas |
Parameter change information
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. Available values: NORMAL, SERVERLESS |
| ParamInfoSet | Array of TemplateParamInfo | Parameter template details |
Security group rule
Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.
| Name | Type | Description |
|---|---|---|
| Action | String | Policy. Valid values: ACCEPT and DROP. |
| CidrIp | String | Source Ip or Ip range, for example, 192.168.0.0/16 |
| PortRange | String | Port. |
| IpProtocol | String | Network protocol. Supports 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: enabled; no: not enabled |
| 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; either one is required as 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. Use ProxyZones instead. |
| Cpu | Integer | No | Number of CPU cores |
| Mem | Integer | No | memory |
| Description | String | No | Description. |
| ProxyZones | Array of ProxyZone | No | Database node information (either this parameter or ProxyCount is required) |
Database proxy connection pool information
Used by actions: DescribeProxies.
| Name | Type | Required | Description |
|---|---|---|---|
| ConnectionPoolTimeOut | Integer | Yes | Connection pool persistence threshold: measurement unit (seconds) |
| OpenConnectionPool | String | No | Whether the connection pool is enabled |
| ConnectionPoolType | String | No | Connection pool type: SessionConnectionPool (session-level connection pool) |
proxy address configuration for the integrated cluster
Used by actions: CreateIntegrateCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| UniqueVpcId | String | No | VPC network ID |
| UniqueSubnetId | String | No | Subnet ID. |
| SecurityGroupIds | Array of String | No | Security group id array |
| WeightMode | String | No | Weight mode: system: system-assigned, custom: customization |
| AutoAddRo | String | No | Whether to automatically add a read-only instance. yes: add automatically; no: do not add automatically |
| RwType | String | No | Read-write attribute. Available 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 database proxy group nodes |
| 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 | Activate database proxy on the read-write node |
| CreateTime | String | Creation time. |
| UpdateTime | String | Update time. |
Detailed information of the database proxy group
Used by actions: DescribeProxies.
| Name | Type | Description |
|---|---|---|
| ProxyGroup | ProxyGroup | Database Proxy Group |
| ProxyGroupRwInfo | ProxyGroupRwInfo | Read-write separation info of the Database Proxy Group |
| ProxyNodes | Array of ProxyNodeInfo | Database proxy node info |
| ConnectionPool | ProxyConnectionPoolInfo | Database proxy connection pool information |
| NetAddrInfos | Array of NetAddr | Database proxy network info |
| Tasks | Array of ObjectTask | Task set of the database proxy |
Read-write separation info of the Database Proxy Group
Used by actions: DescribeProxies.
| Name | Type | Required | Description |
|---|---|---|---|
| ConsistencyType | String | No | Consistency type: eventual - final consistency, global - global consistency, session - session consistency |
| ConsistencyTimeOut | Integer | No | Consistency timeout |
| WeightMode | String | No | Weight mode: system - system-assigned, custom - custom |
| FailOver | String | No | Whether fault migration is enabled |
| AutoAddRo | String | No | Whether to automatically add a read-only instance. yes: add automatically; no: do not add automatically |
| InstanceWeights | Array of ProxyInstanceWeight | No | Instance weight array |
| OpenRw | String | No | Whether to enable read-write node. yes: enable, no: disable |
| RwType | String | No | Read-write attribute. Available values: READWRITE, READONLY |
| TransSplit | Boolean | No | Transaction split |
| AccessMode | String | No | Connection mode. Available values: balance, nearby |
| ApNodeAsRoNode | Boolean | No | Whether to treat the libra node as an ordinary RO node |
| ApQueryToOtherNode | Boolean | No | Whether to forward to other nodes when a libra node fault occurs |
| LoadBalanceMode | String | No | Auto load Enumeration values:
|
| TransAllSplit | Boolean | No | Whether to enable full transaction split. In a transaction, split the reads before and after the transaction write to different instances for execution. |
Database proxy, read-write separation instance weight
Used by actions: CreateProxyEndPoint, DescribeProxies, ModifyProxyRwSplit.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceId | String | Yes | Instance ID. |
| Weight | Integer | Yes | Instance weight |
Database Proxy Group node
Used by actions: DescribeProxies, DescribeProxyNodes.
| Name | Type | Description |
|---|---|---|
| ProxyNodeId | String | Database proxy node ID |
| ProxyNodeConnections | Integer | Current connection number of nodes. This field is not returned by the DescribeProxyNodes API. |
| Cpu | Integer | Database proxy node cpu |
| Mem | Integer | Database proxy node memory |
| Status | String | Database proxy node status |
| ProxyGroupId | String | Database Proxy Group ID |
| ClusterId | String | Cluster ID. |
| AppId | Integer | User AppID. |
| Region | String | Region. |
| Zone | String | AZ. |
| OssProxyNodeName | String | Database proxy node name |
| CreateTime | String | Creation time. |
| UpdateTime | String | Update time. |
Database proxy specification
Used by actions: DescribeProxySpecs.
| Name | Type | Description |
|---|---|---|
| Cpu | Integer | Number of cpu cores for the database proxy |
| Mem | Integer | Database proxy memory |
proxy version information supported by TDSQL-C MySQL
Used by actions: DescribeSupportProxyVersion.
| Name | Type | Description |
|---|---|---|
| ProxyVersion | String | proxy version number |
| ProxyVersionType | String | Version description: GA: stable version. BETA: preview version. DEPRECATED: deprecated. |
Count of nodes in the proxy node availability zone
Used by actions: AddInstances, CheckTransferClusterZone, CreateClusters, CreateIntegrateCluster, CreateProxy, TransferClusterZone, UpgradeInstance, UpgradeProxy.
| Name | Type | Required | Description |
|---|---|---|---|
| ProxyNodeZone | String | No | proxy node availability zone |
| ProxyNodeCount | Integer | No | Number of proxy nodes. |
Database proxy specification
Used by actions: DescribeProxyZoneStocks.
| Name | Type | Description |
|---|---|---|
| Region | String | Region. |
| Zone | String | AZ. |
| CpuStock | Integer | CPU inventory This field is not a judgment standard for whether there are resources for delivery. For resources, refer to CheckProxyStockInfos |
| MemStock | Integer | Memory inventory This field is not used as a judgment standard for whether there are resources for delivery. For resources, see CheckProxyStockInfos |
Query filter. Filter criteria for the DescribeClusterAndInstances API.
Used by actions: DescribeClusters, DescribeInstances, DescribeIsolatedInstances, DescribeLibraDBClusters, DescribeProxyNodes, DescribeTasks, DownloadLibraDBClusterList.
| Name | Type | Required | Description |
|---|---|---|---|
| Values | Array of String | Yes | Field value list, one-to-one with Names. InstanceId/ClusterId use exact match, and InstanceName uses fuzzy match by default. |
| Names | Array of String | No | List of search field names. Only the following 3 fields are supported (case-insensitive, multiple values use OR relationship): ClusterId (filter by cluster ID, exact match), InstanceId (reverse-check the cluster by instance ID), InstanceName (reverse-check the cluster by instance name, default LIKE fuzzy matching, exact match when ExactMatch=true). When InstanceId and InstanceName are both imported, take the intersection (AND semantics). |
| ExactMatch | Boolean | No | Exact match. Only applicable to InstanceName: true for exact match, false (default) for LIKE fuzzy matching. |
| Name | String | No | Search field name (single field mode; either this parameter or Names). Supported: ClusterId, InstanceId, InstanceName. |
Query parameter filter
Used by actions: DescribeProxies.
| Name | Type | Required | Description |
|---|---|---|---|
| Names | Array of String | Yes | Search field. Currently supports: ProxyGroupId |
| Values | Array of String | Yes | String for search. |
| ExactMatch | Boolean | No | Whether to match exactly. |
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. true: yes; false: no |
redo log details
Used by actions: DescribeRedoLogListByVault, DescribeRedoLogs.
| Name | Type | Description |
|---|---|---|
| FileName | String | File name. |
| FileSize | Integer | File size |
| BackupTime | String | Backup time |
| RedoLogId | Integer | redoLogId |
| RedoCrossRegions | Array of BackupRegionAndIds | Cross-regional information |
| Status | String | Status. |
| StartTime | String | Start time. |
| FinishTime | String | Completion time |
| VaultInfos | Array of VaultInfo | Safe information. |
| CopyStatus | String | Backup delivery status |
| EncryptKeyId | String | Encryption key. |
| EncryptRegion | String | Encryption key region |
Instance specifications in this region
Used by actions: DescribeLibraDBInstanceSpecs.
| Name | Type | Description |
|---|---|---|
| Cpu | Integer | Number of CPU cores |
| Memory | Integer | Memory size. |
| MinStorageSize | Integer | Minimum storage size |
| MaxStorageSize | Integer | Maximum storage size |
| HasStock | Boolean | Whether there is inventory |
| InstanceType | String | Instance type |
| StorageType | String | Storage type |
| MinReplicaNum | Integer | Minimum replica count |
| MaxReplicaNum | Integer | Maximum number of replicas |
| ZoneStockInfos | Array of ZoneStockInfo4Libra | Availability zone inventory information list |
Analysis engine sync object
Used by actions: ModifyLibraDBClusterReplicationObject.
| Name | Type | Required | Description |
|---|---|---|---|
| SrcInstanceType | String | Yes | Source instance type |
| SrcClusterId | String | No | Source cluster Id |
| SrcInstanceId | String | No | Source instance ID |
| ReplicationJobId | String | No | Copy task ID |
| MigrateObjects | MigrateOpt | No | Synchronization object details |
Resource package information
Used by actions: DescribeClusterDetail, DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, DescribeClusters, DescribeInstances, DescribeIsolatedInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| PackageId | String | No | 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 pack 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. |
Rollback task information
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| Cpu | Integer | Instance CPU |
| Memory | Integer | Instance memory |
| StorageLimit | Integer | Cluster storage limit |
| OriginalClusterId | String | Source cluster id |
| OriginalClusterName | String | Source cluster name |
| RollbackStrategy | String | Rollback mode |
| SnapshotTime | String | Snapshot time |
| MinCpu | Integer | Minimum CPU for rollback to a Serverless cluster |
| MaxCpu | Integer | Maximum CPU when rolling back to a Serverless cluster |
| SnapShotId | Integer | Snapshot ID |
| RollbackDatabases | Array of RollbackDatabase | Rollback database |
| RollbackTables | Array of RollbackTable | Rollback data table |
| BackupFileName | String | Backup file name |
| RollbackProcess | RollbackProcessInfo | Rollback process |
Roll back database information
Used by actions: DescribeTasks, RollBackCluster, RollbackToNewCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| OldDatabase | String | Yes | Old database name |
| NewDatabase | String | Yes | New database name |
Rollback instance information
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 | Virtual port information. |
| InstanceId | String | Instance ID. |
| InstanceName | String | Instance name. |
| Status | String | Status. |
| Cpu | Integer | CPU Size |
| Mem | Integer | Memory size. |
| StorageLimit | Integer | Storage size |
Rollback progress details
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| IsVipSwitchable | Boolean | Is it possible to switch vip |
| VipSwitchableTime | String | vip exchangeable time |
| ExchangeInstanceInfoList | Array of ExchangeInstanceInfo | Exchange instance list |
| ExchangeRoGroupInfoList | Array of ExchangeRoGroupInfo | Exchange RO group list |
| CurrentStep | String | Details of the current step |
| CurrentStepProgress | Integer | Current step progress. |
| CurrentStepRemainingTime | String | Remaining time of the current step |
Rollback RO group information
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 | Virtual port information. |
Rollback databases and tables
Used by actions: DescribeTasks, RollBackCluster, RollbackToNewCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| Database | String | Yes | Database name. |
| Tables | Array of RollbackTableInfo | Yes | Database table |
Table information for rollback
Used by actions: RollBackCluster, RollbackToNewCluster.
| Name | Type | Required | Description |
|---|---|---|---|
| OldTable | String | Yes | Old table name |
| NewTable | String | Yes | New table name |
Time range available for rollback
Used by actions: DescribeRollbackTimeRange.
| Name | Type | Description |
|---|---|---|
| TimeRangeStart | String | Start time. |
| TimeRangeEnd | String | End time. |
Rule filter criteria for the audit rule.
Used by actions: CreateAuditRuleTemplate, DescribeAuditRuleTemplates, DescribeAuditRuleWithInstanceIds, ModifyAuditRuleTemplates, ModifyAuditService.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Parameter name for the audit rule filter criteria. Available values: host – client IP; user – database account; dbName – database name; sqlType – SQL type; sql – SQL statement; affectRows – number of affected rows; sentRows – number of returned rows; checkRows – number of scanned rows; execTime – execution time. |
| Compare | String | Yes | Match type of the audit rule filter criteria. Available values: INC – include; EXC – exclude; EQS – equal; NEQ – not equal; REG – regular; GT – greater than; LT – less than. |
| Value | Array of String | Yes | Matching value of the filter criteria for the audit rule. |
Rule template content.
Used by actions: DescribeAuditRuleWithInstanceIds.
| Name | Type | Description |
|---|---|---|
| RuleTemplateId | String | Rule template ID. |
| RuleTemplateName | String | Rule template name. |
| RuleFilters | Array of RuleFilters | Rule content. |
| AlarmLevel | Integer | Alarm level. Valid values: 1 - Low risk, 2 - Medium risk, 3 - High risk. |
| AlarmPolicy | Integer | Alarm policy. Valid values: 0 - Alarm disabled, 1 - Alarm enabled. |
| Description | String | Rule description. |
Resource pack details
Used by actions: DescribeResourcePackageSaleSpec.
| Name | Type | Description |
|---|---|---|
| PackageRegion | String | Region of use for the resource package |
| PackageType | String | Resource package type CCU: compute resource package DISK: storage resource package. |
| PackageVersion | String | Resource pack version base: basic edition, common: general edition, enterprise: Enterprise Edition |
| MinPackageSpec | Float | Minimum number of resources in the current resource package version. Compute resource unit: count; storage resource: GB. |
| MaxPackageSpec | Float | Maximum number of resources in the current resource package version. Compute resource unit: count; storage resource: GB. |
| ExpireDay | Integer | Resource pack validity period. Unit: day. |
Sales region information
Used by actions: DescribeZones.
| Name | Type | Description |
|---|---|---|
| Region | String | English name of the region |
| RegionId | Integer | Region numeric ID. |
| RegionZh | String | Region Name in Chinese |
| ZoneSet | Array of SaleZone | List of available saleable zones |
| DbType | String | Engine type. |
| Modules | Array of Module | Region module support status |
Information on AZs for sale.
Used by actions: DescribeZones.
| Name | Type | Description |
|---|---|---|
| Zone | String | Availability zone name |
| ZoneId | Integer | Availability zone numeric ID |
| ZoneZh | String | AZ Chinese name |
| IsSupportServerless | Integer | Whether serverless cluster is supported 0: not supported 1: Support |
| IsSupportNormal | Integer | Whether a general cluster is supported 0: not supported 1: Support |
| PhysicalZone | String | Physical zone |
| HasPermission | Boolean | Whether the user has AZ permissions |
| IsWholeRdmaZone | String | Whether it is an all-link RDMA availability zone |
| IsSupportCreateCluster | Integer | Whether new cluster purchase is allowed in the current AZ. 1: allowed, 0: not allowed |
Legacy backup list
Used by actions: DescribeSaveBackupClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| BackupId | Integer | No | Backup id |
| 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. Available values: 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. Time format: 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 | Minimum cpu value |
| MaxCpu | Float | Maximum value of cpu |
| MaxStorageSize | Integer | maximum storage space |
| IsDefault | Integer | Whether it is the default specification. |
| HasStock | Boolean | Whether there is inventory |
| StockCount | Integer | Inventory quantity |
| ZoneStockInfos | Array of ServerlessZoneStockInfo | AZ inventory information |
Inventory information of availability zones for serverless type
Used by actions: DescribeServerlessInstanceSpecs.
| Name | Type | Description |
|---|---|---|
| Zone | String | Availability zone |
| StockCount | Integer | Stored amount |
| HasStock | Boolean | Whether inventory is included |
| SlaveZoneStockInfos | Array of SlaveZoneStockInfo | Secondary AZ inventory information |
Availability zone attribute item
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. |
Available zone inventory information
Used by actions: DescribeInstanceSpecs, DescribeInstanceSpecsByOperationType, DescribeServerlessInstanceSpecs.
| Name | Type | Description |
|---|---|---|
| SlaveZone | String | Secondary AZ |
| StockCount | Integer | Inventory quantity in spare availability zone |
| HasStock | Boolean | Whether there is inventory in the spare AZ |
Instance query statistics
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 | Rows returned |
| SqlTemplate | String | sql template |
| SqlMd5 | String | md5 of the sql statement |
| SyncReadCountRemote | Integer | Remote reading count Database kernel version above 3.1.12 |
| SyncReadBytesRemote | Integer | Number of remote read bytes Database kernel version above 3.1.12 |
| SyncReadTimeRemote | Integer | Time spent on remote reads (µs) Database kernel version above 3.1.12 |
| SyncWriteCountRemote | Integer | Remote write count Database kernel version above 3.1.12 |
| SyncWriteBytesRemote | Integer | Number of remote written bytes. Database kernel version above 3.1.12 |
| SyncWriteTimeRemote | Integer | Time spent on remote writing (µs). Database kernel version above 3.1.12 |
| TrxCommitDelay | Integer | Transaction submission delay (µs) Database kernel version above 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 correspond to 0, 3600, and 7200 respectively. |
| BackupTimeEnd | Integer | No | Indicates the full backup end time, [0-24*3600]. For example, 0:00, 1:00, and 2:00 correspond to 0, 3600, and 7200 respectively. |
| BackupWeekDays | Array of String | No | Currently this parameter cannot be modified and is not required. Backup frequency, an array of length 7, corresponds to the backup method from Sunday to Saturday. full: full backup, increment: incremental backup. |
| BackupIntervalTime | Integer | No | Interval |
| ReserveDuration | Integer | No | Indicates the backup retention period in seconds. Data is cleaned up after this time. Seven days means 3600 × 24 × 7 = 604800. The maximum value is 158112000. |
| BackupTriggerStrategy | String | No | Automatic data backup trigger policy. periodically: automatic periodic backup. frequent: high-frequency backup. |
| AutoCopyVaults | Array of CreateBackupVaultItem | No | Safe information. |
Sparse backup configuration
Used by actions: ModifyBackupConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| SparseBackupSwitch | String | No | Sparse backup switch: ON/OFF |
| SparseBackupConfigInfos | Array of SparseBackupConfigInfo | No | List of sparse backup policies (1-3) |
Sparse backup policy configuration information
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 | Period policy type: weekly/monthly/yearly |
| SparsePeriodTime | SparsePeriodTime | No | Periodic time configuration |
| SparseBackupSaveDays | Integer | No | Retention days (7-7320 days, up to 20 years) |
Sparse backup configuration
Used by actions: DescribeBackupConfig.
| Name | Type | Description |
|---|---|---|
| SparseBackupSwitch | String | Backup switch: ON/OFF |
| SparseBackupConfigInfos | Array of SparseBackupConfigInfo | Sparse backup policy list (1-3) |
Sparse backup cycle information
Used by actions: DescribeBackupConfig, ModifyBackupConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| WeekDays | Array of Integer | No | By week: list of days of the week, 1-7, 1=Monday, 7=Sunday (only for weekly period, up to 7) |
| Days | Array of Integer | No | Monthly: date list, 1-31 (only for monthly cycle, up to 7) |
| MonthDays | Array of MonthDay | No | Yearly: list of month-day combinations (only for yearly cycle, up to 7) |
Switch the log bin of the cluster
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| Status | String | Status. |
Table 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 names |
| 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 | Fill value of the virtual column |
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 |
Tag information bound to the cluster, including TagKey and TagValue
Used by actions: CreateClusters, CreateIntegrateCluster, CreateLibraDBClusters, DescribeAuditInstanceList, DescribeClusterDetail, DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, 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 00:00:00) |
| MaintainDuration | Integer | Continuous time (unit: second) |
| MaintainWeekDays | Array of String | The time when it can be executed. Enumeration values: ["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"] |
Task progress query
Used by actions: DescribeTasks.
| Name | Type | Description |
|---|---|---|
| CurrentStep | String | Details of the 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 | Value type collection that is optional when the parameter type is enum |
| Max | String | 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 restart is required |
| Description | String | Parameter description |
| ParamType | String | Parameter type. Valid values: integer, float, string, enum. |
Billing inquiry result
Used by actions: InquirePriceCreate, InquirePriceModify, InquirePriceMultiSpec, InquirePriceRenew.
| Name | Type | Description |
|---|---|---|
| TotalPrice | Integer | Resource total price under prepaid mode, excluding discounts. Unit: cent. |
| Discount | Float | Total discount. 100 means 100% no discount. |
| TotalPriceDiscount | Integer | Discounted total price under prepaid mode, unit: cent. For example, if a user enjoys a discount, it is TotalPrice × Discount. |
| UnitPrice | Integer | Unit resource price in postpaid mode, excluding discounts. Unit: cent |
| UnitPriceDiscount | Integer | Unit resource price under postpaid mode after Discount, unit: cent. For example, if a user enjoys a Discount, it is UnitPrice × Discount. |
| ChargeUnit | String | Billing price unit |
| UnitPriceHighPrecision | String | High-precision price excluding discounts |
| UnitPriceDiscountHighPrecision | String | Discounted price at high precision |
| AmountUnit | String | Currency unit. |
Analyze the instance version upgrade and the 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 | Expiration time. |
Upgrade proxy synchronously when adding instances or modifying instance configurations.
Used by actions: AddInstances, UpgradeInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Cpu | Integer | Yes | cpu |
| Mem | Integer | Yes | memory |
| ProxyZones | Array of ProxyZone | Yes | Proxy node information |
| ReloadBalance | String | No | Load rebalance |
User host permission
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 information
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 |
List of backup files to be deleted
Used by actions: CalculateBackupSaveSecExpires.
| Name | Type | Description |
|---|---|---|
| BackupId | Integer | Backup file ID |
| BackupName | String | Backup file name. |
Availability zone inventory information
Used by actions: DescribeInstanceSpecs, DescribeInstanceSpecsByOperationType.
| Name | Type | Description |
|---|---|---|
| Zone | String | Availability zone |
| HasStock | Boolean | Whether there is inventory |
| StockCount | Integer | Inventory quantity |
| SlaveZoneStockInfos | Array of SlaveZoneStockInfo | AZ inventory information |
Regional inventory information sold by Libra
Used by actions: DescribeLibraDBInstanceSpecs.
| Name | Type | Description |
|---|---|---|
| Zone | String | Availability zone |
| HasStock | Boolean | Whether there is inventory |
フィードバック