History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Access information.
Used by actions: DescribeInstance, DescribeInstances.
| Name | Type | Description |
|---|---|---|
| Address | String | Address. Note: This field may return null, indicating that no valid values can be obtained. |
| Protocol | String | Protocol. Note: This field may return null, indicating that no valid values can be obtained. |
Description of the account name and instance IDs under the account
Used by actions: DescribeAccounts.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| UserName | String | Account name. |
| Perms | Array of String | Account attribute. Note: This field may return null, indicating that no valid values can be obtained. |
Disk specifications.
Used by actions: CreateInstanceByApi, ScaleUpInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| DiskType | String | Yes | Disk type. Note: This field may return null, indicating that no valid values can be obtained. |
| DiskSize | Integer | Yes | Size. Note: This field may return null, indicating that no valid values can be obtained. |
| DiskCount | Integer | Yes | Number. Note: This field may return null, indicating that no valid values can be obtained. |
Disk information.
Used by actions: DescribeInstanceInfo.
| Name | Type | Required | Description |
|---|---|---|---|
| DiskType | String | Yes | Disk type.Note: This field may return null, indicating that no valid values can be obtained. |
| DiskSize | Integer | Yes | Size. Note: This field may return null, indicating that no valid values can be obtained. |
| DiskCount | Integer | Yes | Number.Note: This field may return null, indicating that no valid values can be obtained. |
Description of resource specifications
Used by actions: ScaleUpInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Node type. |
| SpecName | String | Yes | Model. |
| Count | Integer | Yes | Number of nodes. |
| DiskSpec | CBSSpec | Yes | Disk information. |
Billing time parameter.
Used by actions: CreateInstanceByApi, DescribeInstanceInfo.
| Name | Type | Required | Description |
|---|---|---|---|
| RenewFlag | Integer | Yes | 1: requires auto-renewal. Note: This field may return null, indicating that no valid values can be obtained. |
| TimeSpan | Integer | Yes | Order time range. Note: This field may return null, indicating that no valid values can be obtained. |
| TimeUnit | String | Yes | Time unit. Valid values: h and m. Note: This field may return null, indicating that no valid values can be obtained. |
| PayMode | Integer | No | Billing type: 0 indicates pay-as-you-go and 1 indicates monthly subscription. Note: This field may return null, indicating that no valid values can be obtained. |
| ChargeType | String | No | PREPAID and POSTPAID_BY_HOUR Note: This field may return null, indicating that no valid values can be obtained. |
ConfigHistory1
Used by actions: DescribeDBConfigHistory.
| Name | Type | Description |
|---|---|---|
| Id | Integer | id |
| InstanceId | String | Instance name. |
| CreatedAt | Timestamp ISO8601 | Creation time. |
| UpdatedAt | Timestamp ISO8601 | Update time. |
| NodeType | String | dn/cn |
| ParamName | String | Parameter name. |
| ParamNewValue | String | New parameter value. |
| ParamOldValue | String | Old parameter value. |
| Status | String | Status. Valid values: doing and success. |
Parameters
Used by actions: ModifyDBParameters.
| Name | Type | Required | Description |
|---|---|---|---|
| ParameterName | String | No | Name. Note: This field may return null, indicating that no valid values can be obtained. |
| ParameterValue | String | No | Value. Note: This field may return null, indicating that no valid values can be obtained. |
| ParameterOldValue | String | No | Value before modification. Note: This field may return null, indicating that no valid values can be obtained. |
Disk specifications.
Used by actions: DescribeInstance, DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| DiskCount | Integer | No | Number of disks. Note: This field may return null, indicating that no valid values can be obtained. |
| MaxDiskSize | Integer | No | Maximum disk capacity. Note: This field may return null, indicating that no valid values can be obtained. |
| MinDiskSize | Integer | No | Minimum disk capacity. Note: This field may return null, indicating that no valid values can be obtained. |
| DiskType | String | No | Disk type. Note: This field may return null, indicating that no valid values can be obtained. |
| DiskDesc | String | No | Disk type details. Note: This field may return null, indicating that no valid values can be obtained. |
| CvmClass | String | No | Model type. Note: This field may return null, indicating that no valid values can be obtained. |
Error log details
Used by actions: DescribeErrorLog.
| Name | Type | Description |
|---|---|---|
| UserName | String | Username. Note: This field may return null, indicating that no valid values can be obtained. |
| Database | String | Database. Note: This field may return null, indicating that no valid values can be obtained. |
| ErrorTime | String | The time an error was reported. Note: This field may return null, indicating that no valid values can be obtained. |
| ErrorMessage | String | Error message. Note: This field may return null, indicating that no valid values can be obtained. |
user_config
Used by actions: DescribeUserHbaConfig, ModifyUserHba.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Type. |
| Database | String | Yes | Database. |
| User | String | Yes | User. |
| Address | String | Yes | IP address. |
| Method | String | Yes | Method. |
| Mask | String | No | Indicates whether to perform overwriting. Note: This field may return null, indicating that no valid values can be obtained. |
instance information.
Used by actions: DescribeInstance, DescribeInstances.
| Name | Type | Description |
|---|---|---|
| ID | Integer | Instance ID Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceType | String | Kernel version type. Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceName | String | Cluster name. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | String | Cluster status. Note: This field may return null, indicating that no valid values can be obtained. |
| StatusDesc | String | Cluster status details.Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceStateInfo | InstanceStateInfo | Cluster status information. Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceID | String | Cluster ID. Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | Creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | Region. Note: This field may return null, indicating that no valid values can be obtained. |
| Zone | String | Region. Note: This field may return null, indicating that no valid values can be obtained. |
| RegionDesc | String | Region details. Note: This field may return null, indicating that no valid values can be obtained. |
| ZoneDesc | String | Region details. Note: This field may return null, indicating that no valid values can be obtained. |
| Tags | Array of Tag | Tag.Note: This field may return null, indicating that no valid values can be obtained. |
| Version | String | Kernel version. Note: This field may return null, indicating that no valid values can be obtained. |
| Charset | String | Character set. Note: This field may return null, indicating that no valid values can be obtained. |
| CNNodes | Array of InstanceNodeGroup | CN node list. Note: This field may return null, indicating that no valid values can be obtained. |
| DNNodes | Array of InstanceNodeGroup | DN node list. Note: This field may return null, indicating that no valid values can be obtained. |
| RegionId | Integer | Region ID. Note: This field may return null, indicating that no valid values can be obtained. |
| ZoneId | Integer | Region ID. Note: This field may return null, indicating that no valid values can be obtained. |
| VpcId | String | Virtual Private Cloud (VPC). Note: This field may return null, indicating that no valid values can be obtained. |
| SubnetId | String | Subnet. Note: This field may return null, indicating that no valid values can be obtained. |
| ExpireTime | String | Expiration time. Note: This field may return null, indicating that no valid values can be obtained. |
| PayMode | String | Billing mode. Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Boolean | Automatic renewal. Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceId | String | Cluster ID. Note: This field may return null, indicating that no valid values can be obtained. |
| AccessDetails | Array of AccessInfo | Access information. Note: This field may return null, indicating that no valid values can be obtained. |
Instance node
Used by actions: DescribeInstanceNodes.
| Name | Type | Description |
|---|---|---|
| NodeId | Integer | id |
| NodeType | String | cn |
| NodeIp | String | ip |
Instance node information.
Used by actions: DescribeInstance, DescribeInstances.
| Name | Type | Description |
|---|---|---|
| SpecName | String | Model. Note: This field may return null, indicating that no valid values can be obtained. |
| DataDisk | DiskSpecPlus | Disk information. Note: This field may return null, indicating that no valid values can be obtained. |
| CvmCount | Integer | Number of machines. Note: This field may return null, indicating that no valid values can be obtained. |
Cluster operation description
Used by actions: DescribeInstanceOperations.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Operation name, such as create_instance, and scaleout_instance |
| InstanceId | String | Cluster ID. Note: This field may return null, indicating that no valid values can be obtained. |
| Action | String | Operation name description, such as creating, and modifying the cluster name. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Status. Note: This field may return null, indicating that no valid values can be obtained. |
| StartTime | String | Operation start time. Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | Operation end time. Note: This field may return null, indicating that no valid values can be obtained. |
| Context | String | Operation context. Note: This field may return null, indicating that no valid values can be obtained. |
| UpdateTime | String | Operation update time. Note: This field may return null, indicating that no valid values can be obtained. |
| Uin | String | Operation UIN. Note: This field may return null, indicating that no valid values can be obtained. |
Simplified instance information.
Used by actions: DescribeSimpleInstances.
| Name | Type | Description |
|---|---|---|
| ID | Integer | ID Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceId | String | Cluster ID. Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceName | String | Cluster name. Note: This field may return null, indicating that no valid values can be obtained. |
| Version | String | Kernel version. Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | Region. Note: This field may return null, indicating that no valid values can be obtained. |
| RegionId | Integer | Region ID. Note: This field may return null, indicating that no valid values can be obtained. |
| RegionDesc | String | Region details. Note: This field may return null, indicating that no valid values can be obtained. |
| Zone | String | Region. Note: This field may return null, indicating that no valid values can be obtained. |
| ZoneId | Integer | Region ID. Note: This field may return null, indicating that no valid values can be obtained. |
| ZoneDesc | String | Region details. Note: This field may return null, indicating that no valid values can be obtained. |
| VpcId | String | Virtual Private Cloud (VPC). Note: This field may return null, indicating that no valid values can be obtained. |
| SubnetId | String | Subnet. Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | Start time. Note: This field may return null, indicating that no valid values can be obtained. |
| ExpireTime | String | Expiration time. Note: This field may return null, indicating that no valid values can be obtained. |
| AccessInfo | String | Access address. Note: This field may return null, indicating that no valid values can be obtained. |
| PayMode | String | Billing mode. Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Boolean | Automatic renewal. Note: This field may return null, indicating that no valid values can be obtained. |
Instance State Information
Used by actions: DescribeInstance, DescribeInstances.
| Name | Type | Description |
|---|---|---|
| InstanceState | String | Instance status. Example: serving. Note: This field may return null, indicating that no valid values can be obtained. |
| FlowCreateTime | String | Creation time of instance operation. Note: This field may return null, indicating that no valid values can be obtained. |
| FlowName | String | Instance operation name. Note: This field may return null, indicating that no valid values can be obtained. |
| FlowProgress | Integer | Instance operation progress. Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceStateDesc | String | Instance status description. Example: running. Note: This field may return null, indicating that no valid values can be obtained. |
| FlowMsg | String | Instance process error messages. Example: "Creation failed, insufficient resources." Note: This field may return null, indicating that no valid values can be obtained. |
| ProcessName | String | The name of the current step. Example: "Purchasing resources." Note: This field may return null, indicating that no valid values can be obtained. |
| BackupStatus | Integer | Indicates whether there is a backup task in the instance. 1 indicates yes and 0 indicates no. Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | Request ID. Note: This field may return null, indicating that no valid values can be obtained. |
| BackupOpenStatus | Integer | Indicates whether there is a backup task in the cluster. 1 indicates yes and 0 indicates no. Note: This field may return null, indicating that no valid values can be obtained. |
Node parameter
Used by actions: ModifyDBParameters.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeType | String | Yes | Node type. |
| ConfigParams | Array of ConfigParams | Yes | Parameter. |
Slow query item information
Used by actions: DescribeSlowLog.
| Name | Type | Required | Description |
|---|---|---|---|
| CallTimes | Integer | Yes | Number of calls. Note: This field may return null, indicating that no valid values can be obtained. |
| SharedReadBlocks | Integer | Yes | Number of read-only shared memory blocks. Note: This field may return null, indicating that no valid values can be obtained. |
| SharedWriteBlocks | Integer | Yes | Number of write-only shared memory blocks. Note: This field may return null, indicating that no valid values can be obtained. |
| DatabaseName | String | Yes | Database. Note: This field may return null, indicating that no valid values can be obtained. |
| NormalQuery | String | Yes | Statement after masking. Note: This field may return null, indicating that no valid values can be obtained. |
| MaxElapsedQuery | String | Yes | The statement with the longest execution time. Note: This field may return null, indicating that no valid values can be obtained. |
| CostTime | Float | Yes | Total consumption time. Note: This field may return null, indicating that no valid values can be obtained. |
| ClientIp | String | Yes | Client IP address. Note: This field may return null, indicating that no valid values can be obtained. |
| UserName | String | Yes | Username. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCallTimesPercent | Float | Yes | Proportion of total count. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCostTimePercent | Float | Yes | Proportion of total consumption time. Note: This field may return null, indicating that no valid values can be obtained. |
| MinCostTime | Float | Yes | Minimum consumption time. Note: This field may return null, indicating that no valid values can be obtained. |
| MaxCostTime | Float | Yes | Maximum consumption time. Note: This field may return null, indicating that no valid values can be obtained. |
| FirstTime | String | Yes | Time of the earliest item.Note: This field may return null, indicating that no valid values can be obtained. |
| LastTime | String | Yes | Time of the latest item.Note: This field may return null, indicating that no valid values can be obtained. |
| ReadCostTime | Float | Yes | Total consumption time of I/O reading. Note: This field may return null, indicating that no valid values can be obtained. |
| WriteCostTime | Float | Yes | Total consumption time I/O writing. Note: This field may return null, indicating that no valid values can be obtained. |
ParamDetail
Used by actions: DescribeDBParams.
| Name | Type | Description |
|---|---|---|
| ParamName | String | Parameter name. Note: This field may return null, indicating that no valid values can be obtained. |
| DefaultValue | String | Default value. Note: This field may return null, indicating that no valid values can be obtained. |
| NeedRestart | Boolean | Indicates whether the restart is required. Note: This field may return null, indicating that no valid values can be obtained. |
| RunningValue | String | Current value. Note: This field may return null, indicating that no valid values can be obtained. |
| ValueRange | ValueRange | Value range. |
| Unit | String | Unit. Note: This field may return null, indicating that no valid values can be obtained. |
| ShortDesc | String | Introduction in English. Note: This field may return null, indicating that no valid values can be obtained. |
| ParameterName | String | Parameter name. Note: This field may return null, indicating that no valid values can be obtained. |
ParamItem information
Used by actions: DescribeDBParams.
| Name | Type | Description |
|---|---|---|
| NodeType | String | Node type. Valid values: cn and dn. Note: This field may return null, indicating that no valid values can be obtained. |
| NodeName | String | Node name. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Number of parameters. Note: This field may return null, indicating that no valid values can be obtained. |
| Details | Array of ParamDetail | Parameter information. Note: This field may return null, indicating that no valid values can be obtained. |
Range
Used by actions: DescribeDBParams.
| Name | Type | Description |
|---|---|---|
| Min | String | Minimum value. Note: This field may return null, indicating that no valid values can be obtained. |
| Max | String | Maximum value. Note: This field may return null, indicating that no valid values can be obtained. |
Resource information.
Used by actions: DescribeInstanceInfo.
| Name | Type | Required | Description |
|---|---|---|---|
| SpecName | String | Yes | Resource name. Note: This field may return null, indicating that no valid values can be obtained. |
| Count | Integer | Yes | Resource count. Note: This field may return null, indicating that no valid values can be obtained. |
| DiskSpec | CBSSpecInfo | Yes | Disk information. Note: This field may return null, indicating that no valid values can be obtained. |
| Type | String | Yes | Node type. Valid values: cn and dn. Note: This field may return null, indicating that no valid values can be obtained. |
Resource specifications.
Used by actions: CreateInstanceByApi.
| Name | Type | Required | Description |
|---|---|---|---|
| SpecName | String | Yes | Resource name. |
| Count | Integer | Yes | Resource count. |
| DiskSpec | CBSSpec | Yes | Disk information. |
| Type | String | Yes | Resource type, DATA. |
List of tags searched on the list page.
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | No | Tag key. |
| TagValue | String | No | Tag value. |
| AllValue | Integer | No | 1 means only the Tag key is entered without a value, and 0 means both the key and the value are entered. |
Cluster information.
Used by actions: DescribeInstanceInfo.
| Name | Type | Required | Description |
|---|---|---|---|
| ID | Integer | No | ID Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceId | String | No | Cluster ID. Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceName | String | No | Cluster name. Note: This field may return null, indicating that no valid values can be obtained. |
| Version | String | No | Kernel version. Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | No | Region. Note: This field may return null, indicating that no valid values can be obtained. |
| Zone | String | No | Region. Note: This field may return null, indicating that no valid values can be obtained. |
| UserVPCID | String | No | Virtual Private Cloud (VPC). Note: This field may return null, indicating that no valid values can be obtained. |
| UserSubnetID | String | No | Subnet. Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | No | Start time. Note: This field may return null, indicating that no valid values can be obtained. |
| ExpireTime | String | No | Expiration time. Note: This field may return null, indicating that no valid values can be obtained. |
| AccessInfo | String | No | Access address. Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Integer | No | Automatic renewal switch. 0 indicates automatic renewal is not enabled, and 1 indicates automatic renewal is enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| ChargeProperties | ChargeProperties | No | Billing mode. Note: This field may return null, indicating that no valid values can be obtained. |
| Resources | Array of ResourceInfo | No | Resource collection. Note: This field may return null, indicating that no valid values can be obtained. |
| Tags | Array of Tag | No | Tag list. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Cluster status. Note: This field may return null, indicating that no valid values can be obtained. |
Slow SQL logs
Used by actions: DescribeSlowLog.
| Name | Type | Description |
|---|---|---|
| TotalTime | Float | Total consumption time. |
| TotalCallTimes | Integer | Total number of calls. |
| NormalQuerys | Array of NormQueryItem | Slow SQL. |
Tag description.
Used by actions: CreateInstanceByApi, DescribeInstance, DescribeInstanceInfo, DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key. |
| TagValue | String | Yes | Tag value. |
Upgrade information
Used by actions: DescribeUpgradeList.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskName | String | No | Task name. Note: This field may return null, indicating that no valid values can be obtained. |
| SourceVersion | String | No | Original kernel version. Note: This field may return null, indicating that no valid values can be obtained. |
| TargetVersion | String | No | Target kernel version. Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | No | Task creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | No | Task end time. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | String | No | Task completion status. Note: This field may return null, indicating that no valid values can be obtained. |
| OperateUin | String | No | Operator. Note: This field may return null, indicating that no valid values can be obtained. |
ValueRange
Used by actions: DescribeDBParams.
| Name | Type | Description |
|---|---|---|
| Type | String | Parameter types. Valid values: enum, string, and section. Enum indicates enumeration, namely utf8, latin1, gbk. String indicates that the returned parameter value is a string. Section indicates that the returned parameter value is a value range, for example, 4-8. Note: This field may return null, indicating that no valid values can be obtained. |
| Range | Range | Response parameter when the type is a section.Note: This field may return null, indicating that no valid values can be obtained. |
| Enum | Array of String | Response parameter when the type is an enum.Note: This field may return null, indicating that no valid values can be obtained. |
| String | String | Response parameter when the type is a string.Note: This field may return null, indicating that no valid values can be obtained. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan