Account details
Used by actions: DescribeUserPolicy.
Name | Type | Required | Description |
---|---|---|---|
UserName | String | No | Username Note: This field may return null, indicating that no valid values can be obtained. |
Host | String | No | Host name or IP address, which indicates the host to which the user belongs. Note: This field may return null, indicating that no valid values can be obtained. |
UserDescription | String | No | User description information Note: This field may return null, indicating that no valid values can be obtained. |
Specifications of nodes in the cluster and disk specifications description
Used by actions: DescribeInstance, DescribeInstances.
Name | Type | Required | Description |
---|---|---|---|
DiskType | String | No | Node disk type, such as CLOUD_SSD""CLOUD_PREMIUM |
DiskSize | Integer | No | Disk capacity, in GB |
DiskCount | Integer | No | Total number of disks |
DiskDesc | String | No | Description |
Backup instance details
Used by actions: DescribeBackUpJob.
Name | Type | Required | Description |
---|---|---|---|
JobId | Integer | No | Backup instance ID |
Snapshot | String | No | Backup instance name |
BackUpSize | Integer | No | Backup data volume |
BackUpSingleSize | Integer | No | Backup single replica data volume Note: This field may return null, indicating that no valid values can be obtained. |
BackUpTime | String | No | Instance creation time |
ExpireTime | String | No | Instance expiration time |
JobStatus | String | No | Instance status |
BackupType | Integer | No | 0: default; 1: one-time backup for the remote Doris Note: This field may return null, indicating that no valid values can be obtained. |
BackupTimeType | Integer | No | 0: default; 1: immediate backup; 2: migration Note: This field may return null, indicating that no valid values can be obtained. |
DorisSourceInfo | DorisSourceInfo | No | Connection information of the remote Doris Note: This field may return null, indicating that no valid values can be obtained. |
JobStatusNum | Integer | No | The value corresponding to the instance status Note: This field may return null, indicating that no valid values can be obtained. |
BackupCosInfo | BackupCosInfo | No | Information about cos in the backup instance Note: This field may return null, indicating that no valid values can be obtained. |
Information about cos in the backup instance
Used by actions: DescribeBackUpJob.
Name | Type | Required | Description |
---|---|---|---|
CosBucket | String | No | The cos bucket where the backup file is located. Note: This field may return null, indicating that no valid values can be obtained. |
CosPath | String | No | The full cos path where the backup file is located. Note: This field may return null, indicating that no valid values can be obtained. |
SnapShotPath | String | No | Backup file name Note: This field may return null, indicating that no valid values can be obtained. |
Progress details of the backup task
Used by actions: DescribeBackUpTaskDetail.
Name | Type | Description |
---|---|---|
JobId | Integer | Backup task ID |
SnapshotName | String | Snapshot name |
DbName | String | Database name |
State | String | Status |
BackupObjects | String | Backup object |
CreateTime | String | Creation time |
SnapshotFinishedTime | String | Snapshot end time |
UploadFinishedTime | String | Upload end time |
FinishedTime | String | End time |
UnfinishedTasks | String | Unfinished tasks |
Progress | String | Progress |
TaskErrMsg | String | Error message |
Status | String | Status |
Timeout | Integer | Timeout information |
BackupJobId | Integer | Backup instance ID Note: This field may return null, indicating that no valid values can be obtained. |
TaskId | Integer | The ID of the snapshoit corresponding to the instance Note: This field may return null, indicating that no valid values can be obtained. |
Backup table information
Used by actions: CreateBackUpSchedule, DescribeBackUpJobDetail, DescribeBackUpTables.
Name | Type | Required | Description |
---|---|---|---|
Database | String | Yes | Database Note: This field may return null, indicating that no valid values can be obtained. |
Table | String | Yes | Table Note: This field may return null, indicating that no valid values can be obtained. |
TotalBytes | Integer | Yes | Total number of bytes in the table Note: This field may return null, indicating that no valid values can be obtained. |
SingleReplicaBytes | String | No | Size of a single replica Note: This field may return null, indicating that no valid values can be obtained. |
BackupStatus | Integer | No | Backup status Note: This field may return null, indicating that no valid values can be obtained. |
BackupErrorMsg | String | No | Error message of the backup Note: This field may return null, indicating that no valid values can be obtained. |
IsOpenCoolDown | Boolean | No | Whether to bind the cold storage policy to the database and table Note: This field may return null, indicating that no valid values can be obtained. |
User information bound to the resource group requires username and host information for authorization.
Used by actions: ModifyUserBindWorkloadGroup.
Name | Type | Required | Description |
---|---|---|---|
UserName | String | No | Username Note: This field may return null, indicating that no valid values can be obtained. |
Host | String | No | Host information Note: This field may return null, indicating that no valid values can be obtained. |
Used by actions: DescribeUserPolicy.
Name | Type | Required | Description |
---|---|---|---|
CatalogName | String | No | |
Permissions | Array of String | No |
Cluster billing-related information
Used by actions: CreateInstanceNew.
Name | Type | Required | Description |
---|---|---|---|
ChargeType | String | No | Billing type: PREPAID for prepayment, and POSTPAID_BY_HOUR for postpayment. Note: This field may return null, indicating that no valid values can be obtained. |
RenewFlag | Integer | No | Whether to automatically renew. 1 means automatic renewal is enabled. Note: This field may return null, indicating that no valid values can be obtained. |
TimeSpan | Integer | No | Billing duration Note: This field may return null, indicating that no valid values can be obtained. |
TimeUnit | String | No | Billing time unit, and "m" means month, etc. Note: This field may return null, indicating that no valid values can be obtained. |
Modification history of the cluster configuration files
Used by actions: DescribeClusterConfigsHistory.
Name | Type | Description |
---|---|---|
FileName | String | Configuration file's name |
NewConfValue | String | Modified configuration file content; base64 code |
OldConfValue | String | Configuration file content before modification; base64 code |
Remark | String | Reason for modification Note: This field may return null, indicating that no valid values can be obtained. |
ModifyTime | String | Modification time |
UserUin | String | Modify sub-account ID |
It is used to return configuration files and content in XML format, as well as other information related to the configuration files.
Used by actions: DescribeClusterConfigs.
Name | Type | Description |
---|---|---|
FileName | String | Configuration file's name |
FileConf | String | Related attribute information corresponding to the configuration files |
KeyConf | String | Other attribute information corresponding to the configuration files |
OriParam | String | Contents of the configuration files, base64 encoded |
NeedRestart | Integer | This is used to indicate whether the current configuration file has been modified without a restart, and reminds the user that a restart is needed. |
FilePath | String | Configuration file path Note: This field may return null, indicating that no valid values can be obtained. |
FileKeyValuesNew | Array of ConfigKeyValue | kv value of a configuration file Note: This field may return null, indicating that no valid values can be obtained. |
Column information of the table
Used by actions: CreateTable, DescribeTable, UpdateTableSchema.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Column name Note: This field may return null, indicating that no valid values can be obtained. |
Type | String | Yes | Column type Note: This field may return null, indicating that no valid values can be obtained. |
AggType | String | No | Aggregation type: When the table is an aggregation model (AGG_KEY), the column with the aggregation type is set as the metric column, and other columns are dimension columns. Aggregation type: ●SUM: sum; the values of multiple rows are accumulated. ●REPLACE: replacement; the values in the next batch of data will replace the values in the previously imported rows. ●MAX: retain the maximum value. ●MIN: retain the minimum value. ●REPLACE_IF_NOT_NULL: non-null values replacement. The difference from REPLACE is that null values are not replaced. ●HLL_UNION: aggregation method for HLL type columns, which is aggregated by HyperLogLog algorithm. ●BITMAP_UNION: aggregation method for BIMTAP type columns; bitmap union aggregation. Note: This field may return null, indicating that no valid values can be obtained. |
IsNull | Boolean | No | Whether the column value is allowed to be Null Note: This field may return null, indicating that no valid values can be obtained. |
IsKey | Boolean | No | Whether it is a Key column. The meaning of different data models: ●DUP_KEY: The column specified afterwards is the sorting column. ●AGG_KEY: The column specified afterwards is the dimension column. ●UNI_KEY: The column specified afterward is the primary key column. Note: This field may return null, indicating that no valid values can be obtained. |
DefaultValue | String | No | Column's default value Note: This field may return null, indicating that no valid values can be obtained. |
IsPartition | Boolean | No | Whether it is a partition column. The partition column must be a Key column. Note: This field may return null, indicating that no valid values can be obtained. |
IsDistribution | Boolean | No | Whether it is a bucket column. The bucket column of the aggregation model and primary key model must be Key columns, while the bucket column of the detail model can be any column. Note: This field may return null, indicating that no valid values can be obtained. |
AutoInc | Boolean | No | Whether it is an auto-increment column. Supported by TCHouse-D 2.1 version and later. Limit: 1. Only DUP_KEY and UNI_KEY model tables can contain auto-increment columns. 2. A table can contain at most one auto-increment column. 3. The type of the auto-increment column must be BIGINT type and cannot be null. Note: This field may return null, indicating that no valid values can be obtained. |
Comment | String | No | Column description Note: This field may return null, indicating that no valid values can be obtained. |
Return the configuration file content (key-value)
Used by actions: DescribeClusterConfigs.
Name | Type | Description |
---|---|---|
KeyName | String | key Note: This field may return null, indicating that no valid values can be obtained. |
Value | String | Value Note: This field may return null, indicating that no valid values can be obtained. |
Message | String | Notes Note: This field may return null, indicating that no valid values can be obtained. |
Display | Integer | 1 indicates read-only, 2 indicates editable but undeletable, and 3 indicates deletable. Note: This field may return null, indicating that no valid values can be obtained. |
SupportHotUpdate | Integer | 0 means not supported, and 1 means hot update is supported. Note: This field may return null, indicating that no valid values can be obtained. |
Configuration file modification information
Used by actions: ModifyClusterConfigs.
Name | Type | Required | Description |
---|---|---|---|
FileName | String | Yes | Configuration file's name |
NewConfValue | String | Yes | New Base64-encoded content of the configuration file |
OldConfValue | String | No | Original Base64-encoded content of the configuration file |
FilePath | String | No | File path |
Information on the backend node supporting hot/cold data layering
Used by actions: DescribeCoolDownBackends.
Name | Type | Required | Description |
---|---|---|---|
Host | String | No | Field: Host Note: This field may return null, indicating that no valid values can be obtained. |
DataUsedCapacity | String | No | Field: DataUsedCapacity Note: This field may return null, indicating that no valid values can be obtained. |
TotalCapacity | String | No | Field: TotalCapacity Note: This field may return null, indicating that no valid values can be obtained. |
RemoteUsedCapacity | String | No | Field: RemoteUsedCapacity Note: This field may return null, indicating that no valid values can be obtained. |
Hot/cold data layering policy
Used by actions: DescribeCoolDownPolicies.
Name | Type | Required | Description |
---|---|---|---|
PolicyName | String | No | Policy name Note: This field may return null, indicating that no valid values can be obtained. |
CooldownDatetime | String | No | cooldown_ttl Note: This field may return null, indicating that no valid values can be obtained. |
CooldownTtl | String | No | cooldown_datetime Note: This field may return null, indicating that no valid values can be obtained. |
Information on the table containing layered cold and hot data
Used by actions: DescribeCoolDownTableData.
Name | Type | Required | Description |
---|---|---|---|
DatabaseName | String | No | Column: DatabaseName Note: This field may return null, indicating that no valid values can be obtained. |
TableName | String | No | Column: TableName Note: This field may return null, indicating that no valid values can be obtained. |
Size | String | No | Column: Size Note: This field may return null, indicating that no valid values can be obtained. |
RemoteSize | String | No | Column: RemoteSize Note: This field may return null, indicating that no valid values can be obtained. |
The customer provides cos authentication information.
Used by actions: CreateBackUpSchedule, DescribeBackUpTables, RecoverBackUpJob.
Name | Type | Required | Description |
---|---|---|---|
SecretId | String | No | ID in cos authentication Note: This field may return null, indicating that no valid values can be obtained. |
SecretKey | String | No | Key in cos authentication Note: This field may return null, indicating that no valid values can be obtained. |
CosPath | String | No | Path in cos authentication Note: This field may return null, indicating that no valid values can be obtained. |
Cluster specifications
Used by actions: CreateInstanceNew.
Name | Type | Required | Description |
---|---|---|---|
SpecName | String | Yes | Specification name |
Count | Integer | Yes | Quantities |
DiskSize | Integer | Yes | Cloud disk size |
DDL information for creating a table
Used by actions: DescribeCreateTablesDDL.
Name | Type | Required | Description |
---|---|---|---|
DbName | String | No | Database name Note: This field may return null, indicating that no valid values can be obtained. |
TablesDDLs | Array of TablesDDL | No | DDL information of the table Note: This field may return null, indicating that no valid values can be obtained. |
Database audit
Used by actions: DescribeDatabaseAuditRecords.
Name | Type | Description |
---|---|---|
OsUser | String | Query user Note: This field may return null, indicating that no valid values can be obtained. |
InitialQueryId | String | Query ID Note: This field may return null, indicating that no valid values can be obtained. |
Sql | String | SQL statement Note: This field may return null, indicating that no valid values can be obtained. |
QueryStartTime | String | Start time Note: This field may return null, indicating that no valid values can be obtained. |
DurationMs | Integer | Execution duration Note: This field may return null, indicating that no valid values can be obtained. |
ReadRows | Integer | The number of read rows Note: This field may return null, indicating that no valid values can be obtained. |
ResultRows | Integer | Total number of read bytes Note: This field may return null, indicating that no valid values can be obtained. |
ResultBytes | Integer | Result bytes Note: This field may return null, indicating that no valid values can be obtained. |
MemoryUsage | Integer | Memory Note: This field may return null, indicating that no valid values can be obtained. |
InitialAddress | String | Initial query IP Note: This field may return null, indicating that no valid values can be obtained. |
DbName | String | Database Note: This field may return null, indicating that no valid values can be obtained. |
SqlType | String | SQL type Note: This field may return null, indicating that no valid values can be obtained. |
Catalog | String | Catalog name Note: This field may return null, indicating that no valid values can be obtained. |
Database permission
Used by actions: DescribeUserPolicy.
Name | Type | Required | Description |
---|---|---|---|
DatabaseName | String | No | Database name Note: This field may return null, indicating that no valid values can be obtained. |
Permissions | Array of String | No | Permission name Note: This field may return null, indicating that no valid values can be obtained. |
Database information
Used by actions: DescribeDatabase.
Name | Type | Required | Description |
---|---|---|---|
DbName | String | No | Database name Note: This field may return null, indicating that no valid values can be obtained. |
Properties | Array of Property | No | Database attribute Note: This field may return null, indicating that no valid values can be obtained. |
Location | String | No | Metadata address (Available when the data source is Hive or DLC.) Note: This field may return null, indicating that no valid values can be obtained. |
Database and table information
Used by actions: DescribeCreateTablesDDL.
Name | Type | Required | Description |
---|---|---|---|
DbName | String | Yes | Database name Note: This field may return null, indicating that no valid values can be obtained. |
TablesName | Array of String | Yes | The corresponding table list under this database. Note: This field may return null, indicating that no valid values can be obtained. |
Disk specification description
Used by actions: DescribeSpec.
Name | Type | Required | Description |
---|---|---|---|
DiskType | String | Yes | Disk type, such as CLOUD_SSD and LOCAL_SSD |
DiskDesc | String | Yes | Disk type description, such as cloud SSD and local SSD |
MinDiskSize | Integer | Yes | Minimum disk size, in GB |
MaxDiskSize | Integer | Yes | Maximum disk size, in GB |
DiskCount | Integer | Yes | Number of disks |
Bucket information of the table
Used by actions: CreateTable, DescribeTable, UpdateTableSchema.
Name | Type | Required | Description |
---|---|---|---|
DistributionType | String | Yes | Bucket type: ●Hash: hash bucket ●Random: random number bucket Note: This field may return null, indicating that no valid values can be obtained. |
Count | Integer | No | Number of buckets Note: This field may return null, indicating that no valid values can be obtained. |
Connection information of external Doris clusters
Used by actions: CreateBackUpSchedule, DescribeBackUpJob, DescribeBackUpTables.
Name | Type | Required | Description |
---|---|---|---|
Host | String | No | The IP address of fe in the Doris cluster Note: This field may return null, indicating that no valid values can be obtained. |
Port | Integer | No | The fe port number of the Doris cluster Note: This field may return null, indicating that no valid values can be obtained. |
User | String | No | Account of the Doris cluster Note: This field may return null, indicating that no valid values can be obtained. |
Password | String | No | Password of the Doris cluster Note: This field may return null, indicating that no valid values can be obtained. |
Front-end rule description
Used by actions: DescribeAreaRegion.
Name | Type | Description |
---|---|---|
ID | Integer | ID sequence Note: This field may return null, indicating that no valid values can be obtained. |
Name | String | Rule name Note: This field may return null, indicating that no valid values can be obtained. |
Rule | String | Detailed rules Note: This field may return null, indicating that no valid values can be obtained. |
Index information of the table
Used by actions: CreateTable, DescribeTable, UpdateTableSchema.
Name | Type | Required | Description |
---|---|---|---|
IdxName | String | Yes | Index name Note: This field may return null, indicating that no valid values can be obtained. |
ColumnName | String | Yes | Column name for creating the index Note: This field may return null, indicating that no valid values can be obtained. |
IdxType | String | Yes | Index type: INVERTED: inverted index NGRAM_BF: N-Gram index Note: This field may return null, indicating that no valid values can be obtained. |
IdxProperties | Array of Property | No | Index attributes Note: This field may return null, indicating that no valid values can be obtained. |
IdxComment | String | No | Index description Note: This field may return null, indicating that no valid values can be obtained. |
KV configuration
Used by actions: ModifyInstanceKeyValConfigs.
Name | Type | Required | Description |
---|---|---|---|
ConfKey | String | Yes | key |
ConfValue | String | Yes | value |
Detail field of the Instance table
Used by actions: DescribeInstance, DescribeInstances.
Name | Type | Required | Description |
---|---|---|---|
EnableAlarmStrategy | Boolean | No | Whether the alarm policy is available Note: This field may return null, indicating that no valid values can be obtained. |
Instance description information
Used by actions: DescribeInstance, DescribeInstances.
Name | Type | Description |
---|---|---|
InstanceId | String | Cluster instance ID, "cdw-xxxx" string type Note: This field may return null, indicating that no valid values can be obtained. |
InstanceName | String | Cluster instance name Note: This field may return null, indicating that no valid values can be obtained. |
Status | String | Status, Init is being created. Serving is running. Deleted indicates the cluster has been terminated. Deleting indicates the cluster is being terminated. Modify indicates the cluster is being changed. Note: This field may return null, indicating that no valid values can be obtained. |
Version | String | Version Note: This field may return null, indicating that no valid values can be obtained. |
Region | String | Region, ap-guangzhou Note: This field may return null, indicating that no valid values can be obtained. |
Zone | String | Availability zone, ap-guangzhou-3 Note: This field may return null, indicating that no valid values can be obtained. |
VpcId | String | VPC name Note: This field may return null, indicating that no valid values can be obtained. |
SubnetId | String | Subnet name Note: This field may return null, indicating that no valid values can be obtained. |
PayMode | String | Payment type: hour and prepay 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. |
ExpireTime | String | Expiration time Note: This field may return null, indicating that no valid values can be obtained. |
MasterSummary | NodesSummary | Data node description information Note: This field may return null, indicating that no valid values can be obtained. |
CoreSummary | NodesSummary | Zookeeper node description information Note: This field may return null, indicating that no valid values can be obtained. |
HA | String | High availability, being true or false Note: This field may return null, indicating that no valid values can be obtained. |
HaType | Integer | High availability type: 0: non-high availability 1: read high availability 2: read-write high availability Note: This field may return null, indicating that no valid values can be obtained. |
AccessInfo | String | Access address. Example: 10.0.0.1:9000 Note: This field may return null, indicating that no valid values can be obtained. |
Id | Integer | Record ID, in numerical type Note: This field may return null, indicating that no valid values can be obtained. |
RegionId | Integer | Region ID, indicating the region Note: This field may return null, indicating that no valid values can be obtained. |
ZoneDesc | String | Note about availability zone, such as Guangzhou Zone 2 Note: This field may return null, indicating that no valid values can be obtained. |
FlowMsg | String | Error process description information Note: This field may return null, indicating that no valid values can be obtained. |
StatusDesc | String | Status description, such as "running" Note: This field may return null, indicating that no valid values can be obtained. |
RenewFlag | Boolean | Automatic renewal marker Note: This field may return null, indicating that no valid values can be obtained. |
Tags | Array of Tag | Tag list Note: This field may return null, indicating that no valid values can be obtained. |
Monitor | String | Monitoring Information Note: This field may return null, indicating that no valid values can be obtained. |
HasClsTopic | Boolean | Whether to enable logs. Note: This field may return null, indicating that no valid values can be obtained. |
ClsTopicId | String | Log Topic ID Note: This field may return null, indicating that no valid values can be obtained. |
ClsLogSetId | String | Logset ID Note: This field may return null, indicating that no valid values can be obtained. |
EnableXMLConfig | Integer | Whether to support XML configuration management. Note: This field may return null, indicating that no valid values can be obtained. |
RegionDesc | String | Region Note: This field may return null, indicating that no valid values can be obtained. |
Eip | String | Elastic network interface address Note: This field may return null, indicating that no valid values can be obtained. |
CosMoveFactor | Integer | Cold and hot stratification coefficient Note: This field may return null, indicating that no valid values can be obtained. |
Kind | String | external/local/yunti Note: This field may return null, indicating that no valid values can be obtained. |
CosBucketName | String | COS bucket Note: This field may return null, indicating that no valid values can be obtained. |
CanAttachCbs | Boolean | cbs Note: This field may return null, indicating that no valid values can be obtained. |
BuildVersion | String | Minor versions Note: This field may return null, indicating that no valid values can be obtained. |
Components | String | Component Information Note: The return type here is map[string]struct, not the string type displayed. You can refer to "Sample Value" to parse the data. Note: This field may return null, indicating that no valid values can be obtained. |
Characteristic | Array of String | Page features, used to block some page entrances on the front end. Note: This field may return null, indicating that no valid values can be obtained. |
RestartTimeout | String | Timeout period, in seconds Note: This field may return null, indicating that no valid values can be obtained. |
GraceShutdownWaitSeconds | String | The timeout time for the graceful restart of the kernel. If it is -1, it means it is not set. Note: This field may return null, indicating that no valid values can be obtained. |
CaseSensitive | Integer | Whether the table name is case sensitive, 0 refers to sensitive, 1 refers to insensitive, compared in lowercase; 2 refers to insensitive, and the table name is changed to lowercase for storage. Note: This field may return null, indicating that no valid values can be obtained. |
IsWhiteSGs | Boolean | Whether users can bind security groups. Note: This field may return null, indicating that no valid values can be obtained. |
BindSGs | Array of String | Bound security group information Note: This field may return null, indicating that no valid values can be obtained. |
EnableMultiZones | Boolean | Whether it is a multi-AZ. Note: This field may return null, indicating that no valid values can be obtained. |
UserNetworkInfos | String | User availability zone and subnet information Note: This field may return null, indicating that no valid values can be obtained. |
EnableCoolDown | Integer | Whether to enable hot and cold stratification. 0 refers to disabled, and 1 refers to enabled. Note: This field may return null, indicating that no valid values can be obtained. |
CoolDownBucket | String | COS buckets are used for hot and cold stratification Note: This field may return null, indicating that no valid values can be obtained. |
Details | InstanceDetail | Instance extension information Note: This field may return null, indicating that no valid values can be obtained. |
EnableDlc | Integer | Whether to enable DLC. 0: disable; 1: enable. Note: This field may return null, indicating that no valid values can be obtained. |
AccountType | Integer | Account type. 0: ordinary user; 1: CAM user. Note: This field may return null, indicating that no valid values can be obtained. |
Instance node description information
Used by actions: DescribeInstanceNodes.
Name | Type | Description |
---|---|---|
Ip | String | IP address |
Spec | String | Model, such as S1 |
Core | Integer | Number of CPU cores |
Memory | Integer | Memory size |
DiskType | String | Disk type |
DiskSize | Integer | Disk size |
Role | String | The name of the clickhouse cluster to which it belongs. |
Status | String | Status Note: This field may return null, indicating that no valid values can be obtained. |
Rip | String | rip Note: This field may return null, indicating that no valid values can be obtained. |
FeRole | String | FE node role Note: This field may return null, indicating that no valid values can be obtained. |
UUID | String | UUID Note: This field may return null, indicating that no valid values can be obtained. |
Cluster operation description
Used by actions: DescribeInstanceOperationHistory, DescribeInstanceOperations.
Name | Type | Description |
---|---|---|
Name | String | Operation name, such as create_instance, and scaleout_instance |
Result | String | Operation result. Success indicates success; Fail indicates failure. |
Desc | String | Operation name description, such as create, and modify the cluster name |
Level | String | Operation level, such as Critical, Normal |
LevelDesc | String | Operation level description, such as high risk, and normal |
StartTime | String | Operation start time |
EndTime | String | Operation end time |
ResultDesc | String | Operation result description, such as Success and Fail. |
OperateUin | String | Operation user ID |
JobId | Integer | The jobid corresponding to the operation |
OperationDetail | String | Operation details |
List type partition information
Used by actions: CreateTable, DescribeTable.
Name | Type | Required | Description |
---|---|---|---|
PartitionName | String | No | Partition name Note: This field may return null, indicating that no valid values can be obtained. |
EnumValues | Array of String | No | Enumeration values of each partition column Note: This field may return null, indicating that no valid values can be obtained. |
Network information
Used by actions: CreateInstanceNew.
Name | Type | Required | Description |
---|---|---|---|
Zone | String | No | Availability zone Note: This field may return null, indicating that no valid values can be obtained. |
SubnetId | String | No | Subnet ID Note: This field may return null, indicating that no valid values can be obtained. |
SubnetIpNum | Integer | No | The number of available IP addresses in the current subnet Note: This field may return null, indicating that no valid values can be obtained. |
NodeInfo
Used by actions: DescribeInstanceNodesInfo.
Name | Type | Description |
---|---|---|
Ip | String | User IP Note: This field may return null, indicating that no valid values can be obtained. |
Status | Integer | Node status Note: This field may return null, indicating that no valid values can be obtained. |
NodeName | String | Node role name Note: This field may return null, indicating that no valid values can be obtained. |
ComponentName | String | Component name Note: This field may return null, indicating that no valid values can be obtained. |
NodeRole | String | Node role Note: This field may return null, indicating that no valid values can be obtained. |
LastRestartTime | String | The time when the node was last restarted Note: This field may return null, indicating that no valid values can be obtained. |
Zone | String | The availability zone where the node is located Note: This field may return null, indicating that no valid values can be obtained. |
Node information list
Used by actions: DescribeInstanceNodesRole, ModifyNodeStatus.
Name | Type | Required | Description |
---|---|---|---|
NodeName | String | No | Node name |
Status | Integer | No | Node status |
Ip | String | No | Node IP |
NodeRole | String | No | Node role |
ComponentName | String | No | Component name |
LastRestartTime | String | No | Last restart time |
Node role description information
Used by actions: DescribeInstance, DescribeInstances.
Name | Type | Description |
---|---|---|
Spec | String | Model, such as S1 |
NodeSize | Integer | Number of nodes |
Core | Integer | Number of CPU cores, in counts |
Memory | Integer | Memory size, in GB |
Disk | Integer | Disk size, in GB |
DiskType | String | Disk type |
DiskDesc | String | Disk description |
AttachCBSSpec | AttachCBSSpec | Information of mounted cloud disks Note: This field may return null, indicating that no valid values can be obtained. |
SubProductType | String | Sub-product name Note: This field may return null, indicating that no valid values can be obtained. |
SpecCore | Integer | Specified cores Note: This field may return null, indicating that no valid values can be obtained. |
SpecMemory | Integer | Specified memory Note: This field may return null, indicating that no valid values can be obtained. |
DiskCount | Integer | Disk size Note: This field may return null, indicating that no valid values can be obtained. |
Encrypt | Integer | Whether it is encrypted. Note: This field may return null, indicating that no valid values can be obtained. |
MaxDiskSize | Integer | Maximum disk Note: This field may return null, indicating that no valid values can be obtained. |
Partition information of the table
Used by actions: CreateTable, DescribeTable.
Name | Type | Required | Description |
---|---|---|---|
PartitionType | String | Yes | Partition type: ●Range: The partition column is usually of time or integer type. Four writing methods are supported. ●List: The partition value is an enumeration value. Note: This field may return null, indicating that no valid values can be obtained. |
AutoPartition | Boolean | No | Whether to automatically partition Note: This field may return null, indicating that no valid values can be obtained. |
RangeInfos | Array of RangeInfo | No | Partition information when the partition type is Range Note: This field may return null, indicating that no valid values can be obtained. |
ListInfos | Array of ListInfo | No | Partition information when the partition type is List Note: This field may return null, indicating that no valid values can be obtained. |
Permission overview
Used by actions: DescribeUserPolicy.
Name | Type | Required | Description |
---|---|---|---|
GlobalPermissions | Array of String | No | A list of user permissions in the global scope, which can be applied to all databases and tables. Note: This field may return null, indicating that no valid values can be obtained. |
DatabasePermissions | Array of DatabasePermissions | No | The key is the database name, and the value is the permission list of the user on the database. Note: This field may return null, indicating that no valid values can be obtained. |
TablePermissions | Array of TablePermissions | No | The key is the full name of the table, and the value is the permission list of the user on the table. Note: This field may return null, indicating that no valid values can be obtained. |
CatalogPermissions | Array of CatalogPermission | No | The key is the full name of the catalog, and the value is the permission list of the user on the catalog. Note: This field may return null, indicating that no valid values can be obtained. |
Property attribute
Used by actions: ExecuteParametrizedQuery, UpdateDatabase.
Name | Type | Required | Description |
---|---|---|---|
PropertyKey | String | No | key Note: This field may return null, indicating that no valid values can be obtained. |
PropertyValue | String | No | value Note: This field may return null, indicating that no valid values can be obtained. |
Attribute information of databases, tables, indexes, etc.
Used by actions: CreateDatabase, CreateTable, DescribeDatabase, DescribeTable, UpdateTableSchema.
Name | Type | Required | Description |
---|---|---|---|
PropertyKey | String | Yes | Attribute key Note: This field may return null, indicating that no valid values can be obtained. |
PropertyValue | String | Yes | Attribute value Note: This field may return null, indicating that no valid values can be obtained. |
Query and analyze details
Used by actions: DescribeQueryAnalyse.
Name | Type | Required | Description |
---|---|---|---|
Initiator | String | No | Initiating User Note: This field may return null, indicating that no valid values can be obtained. |
SourceAddress | String | No | Access source address Note: This field may return null, indicating that no valid values can be obtained. |
InitialRequestId | String | No | Initial request ID Note: This field may return null, indicating that no valid values can be obtained. |
Catalog | String | No | catalog name Note: This field may return null, indicating that no valid values can be obtained. |
Database | String | No | Database name Note: This field may return null, indicating that no valid values can be obtained. |
SQLType | String | No | SQL Type: 0 is non-query, 1 is query, -1 is unrestricted. Note: This field may return null, indicating that no valid values can be obtained. |
SQLStatement | String | No | SQL statement Note: This field may return null, indicating that no valid values can be obtained. |
StartTime | String | No | Execution start time Note: This field may return null, indicating that no valid values can be obtained. |
Duration | Integer | No | Runtime (s) Note: This field may return null, indicating that no valid values can be obtained. |
RowsRead | Integer | No | The number of read rows Note: This field may return null, indicating that no valid values can be obtained. |
DataRead | Float | No | Read data volume (MB) Note: This field may return null, indicating that no valid values can be obtained. |
MemoryUsage | Float | No | Memory usage (MB) Note: This field may return null, indicating that no valid values can be obtained. |
Information of Range type partition
Used by actions: CreateTable, DescribeTable.
Name | Type | Required | Description |
---|---|---|---|
RangeType | String | No | Range partition type: ●FIXED: Define the left closed and right open interval of the partition. ●LESS THAN: Only define the upper bound of the partition. ●BATCH RANGE: Batch create RANGE partitions of numeric and time types, define the left closed and right open intervals of the partitions, and set the step size. Note: This field may return null, indicating that no valid values can be obtained. |
PartitionName | String | No | Partition name Note: This field may return null, indicating that no valid values can be obtained. |
Left | String | No | The left-closed interval of each partition column when RangeType is FIXED or BATCH RANGE Note: This field may return null, indicating that no valid values can be obtained. |
Right | String | No | The right open interval of each partition column when RangeType is FIXED or BATCH RANGE Note: This field may return null, indicating that no valid values can be obtained. |
Max | String | No | The upper bound of each partition column when RangeType is LESS THAN Note: This field may return null, indicating that no valid values can be obtained. |
StepLength | Integer | No | RangeType is the step size of BATCH RANGE Note: This field may return null, indicating that no valid values can be obtained. |
Unit | String | No | Fill it in when RangeType is BATCH RANGE or automatic partitioning. It indicates the step size unit when the partition column is of time type. ●YEAR: year ●MONTH: month ●WEEK: week ●DAY: day Note: This field may return null, indicating that no valid values can be obtained. |
Description of the region categories for availability zones
Used by actions: DescribeAreaRegion.
Name | Type | Description |
---|---|---|
Name | String | Region category information, such as south_china, east_china, etc. |
Desc | String | Description of the corresponding Name, such as South China, East China, etc. |
Regions | Array of RegionInfo | Specific region list 1 |
Region description information
Used by actions: DescribeAreaRegion.
Name | Type | Description |
---|---|---|
Name | String | Region name, such as ap-guangzhou |
Desc | String | Region description, such as Guangzhou |
RegionId | Integer | Unique marker of region |
Zones | Array of ZoneInfo | List of all availability zones in the region Note: This field may return null, indicating that no valid values can be obtained. |
Count | Integer | Number of clusters in the region |
IsInternationalSite | Integer | 0 indicates the international site; 1 indicates not. Note: This field may return null, indicating that no valid values can be obtained. |
Bucket | String | Bucket Note: This field may return null, indicating that no valid values can be obtained. |
Resource specification description information
Used by actions: DescribeSpec.
Name | Type | Description |
---|---|---|
Name | String | Specification name, such as SCH1 |
Cpu | Integer | Number of CPU cores |
Mem | Integer | Memory size, in GB |
Type | String | Classification markers, STANDARD/BIGDATA/HIGHIO respectively represent standard type/big data type/high IO. |
SystemDisk | DiskSpec | System disk description information Note: This field may return null, indicating that no valid values can be obtained. |
DataDisk | DiskSpec | Data disk description information Note: This field may return null, indicating that no valid values can be obtained. |
MaxNodeSize | Integer | Limit of the maximum number of nodes Note: This field may return null, indicating that no valid values can be obtained. |
Available | Boolean | Whether it is available. False indicates sell-out. Note: This field may return null, indicating that no valid values can be obtained. |
ComputeSpecDesc | String | Specification description information Note: This field may return null, indicating that no valid values can be obtained. |
InstanceQuota | Integer | CVM inventory Note: This field may return null, indicating that no valid values can be obtained. |
Recover the task information
Used by actions: DescribeRestoreTaskDetail.
Name | Type | Description |
---|---|---|
JobId | Integer | Recover the task ID |
Label | String | Recover the task tag |
Timestamp | String | Recover the task timestamp |
DbName | String | Recover the database where the task is located |
State | String | Recover the task status |
AllowLoad | Boolean | Whether to allow import during recovery |
ReplicationNum | String | Number of replicas |
ReplicaAllocation | String | Number of replicas |
RestoreObjects | String | Recover object |
CreateTime | String | Creation time |
MetaPreparedTime | String | Metadata preparation time |
SnapshotFinishedTime | String | Snapshot end time |
DownloadFinishedTime | String | Download end time |
FinishedTime | String | End time |
UnfinishedTasks | String | Unfinished tasks |
Progress | String | Progress |
TaskErrMsg | String | Error message |
Status | String | Status |
Timeout | Integer | Operation timeout period |
ReserveReplica | Boolean | Whether to maintain the number of replicas in the source table |
ReserveDynamicPartitionEnable | Boolean | Whether to maintain dynamic partitions in the source table |
BackupJobId | Integer | Backup instance ID Note: This field may return null, indicating that no valid values can be obtained. |
TaskId | Integer | ID of the snapshot corresponding to the instance Note: This field may return null, indicating that no valid values can be obtained. |
Multiple rows of data
Used by actions: ExecuteParametrizedQuery, ExecuteSelectQuery, InsertDatasToTable, QueryTableData.
Name | Type | Required | Description |
---|---|---|---|
DataRow | Array of String | No | A row of data Note: This field may return null, indicating that no valid values can be obtained. |
The searched marker list 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. |
Slow log records
Used by actions: DescribeSlowQueryRecords.
Name | Type | Description |
---|---|---|
OsUser | String | User query |
InitialQueryId | String | ID query |
Sql | String | SQL statement |
QueryStartTime | String | Start time |
DurationMs | Integer | Execution duration |
ReadRows | Integer | The number of read rows |
ResultRows | Integer | Total number of read bytes |
ResultBytes | Integer | Result bytes |
MemoryUsage | Integer | Memory |
InitialAddress | String | Initial query IP |
DbName | String | Database name Note: This field may return null, indicating that no valid values can be obtained. |
IsQuery | Integer | Whether it is a query. 0 indicates no, and 1 indicates query statement. Note: This field may return null, indicating that no valid values can be obtained. |
ResultBytesMB | Float | MB format of ResultBytes Note: This field may return null, indicating that no valid values can be obtained. |
MemoryUsageMB | Float | MemoryUsage, in MB Note: This field may return null, indicating that no valid values can be obtained. |
DurationSec | Float | DurationMs, in seconds Note: This field may return null, indicating that no valid values can be obtained. |
Table-level permissions
Used by actions: DescribeUserPolicy.
Name | Type | Required | Description |
---|---|---|---|
TableName | String | No | Full name of the table Note: This field may return null, indicating that no valid values can be obtained. |
Permissions | Array of String | No | Table permission Note: This field may return null, indicating that no valid values can be obtained. |
DDL information of the table
Used by actions: DescribeCreateTablesDDL.
Name | Type | Required | Description |
---|---|---|---|
TableName | String | No | Table name Note: This field may return null, indicating that no valid values can be obtained. |
DDLInfo | String | No | DDL statement for creating a table Note: This field may return null, indicating that no valid values can be obtained. |
Tag description
Used by actions: CreateInstanceNew, DescribeInstance, DescribeInstances.
Name | Type | Required | Description |
---|---|---|---|
TagKey | String | Yes | Tag key |
TagValue | String | Yes | Tag value |
Update user permission structure
Used by actions: ModifyUserPrivilegesV3.
Name | Type | Required | Description |
---|---|---|---|
IsSetGlobalCatalog | Boolean | No | Whether to set catalog permission |
Add or modify the user
Used by actions: ActionAlterUser.
Name | Type | Required | Description |
---|---|---|---|
InstanceId | String | Yes | Cluster instance ID. |
UserName | String | Yes | Username |
PassWord | String | Yes | Password |
WhiteHost | String | No | The IP address of the user link |
OldWhiteHost | String | No | IP address of the user link before modification |
Describe | String | No | Description |
OldPwd | String | No | Original password |
CamUin | String | No | UIN of the bound sub-user |
CamRangerGroupIds | Array of Integer | No | Ranger group id list |
Resource group information bound to the user
Used by actions: DescribeUserBindWorkloadGroup.
Name | Type | Required | Description |
---|---|---|---|
UserName | String | No | test Note: This field may return null, indicating that no valid values can be obtained. |
WorkloadGroupName | String | No | normal Note: This field may return null, indicating that no valid values can be obtained. |
Resource group configuration
Used by actions: CreateWorkloadGroup, DescribeWorkloadGroup, ModifyWorkloadGroup.
Name | Type | Required | Description |
---|---|---|---|
WorkloadGroupName | String | No | Resource group name Note: This field may return null, indicating that no valid values can be obtained. |
CpuShare | Integer | No | CPU weight Note: This field may return null, indicating that no valid values can be obtained. |
MemoryLimit | Integer | No | Memory limit. The sum of memory limit values of all resource groups should be less than or equal to 100. Note: This field may return null, indicating that no valid values can be obtained. |
EnableMemoryOverCommit | Boolean | No | Whether to allow over-allocation Note: This field may return null, indicating that no valid values can be obtained. |
CpuHardLimit | String | No | CPU hard limit Note: This field may return null, indicating that no valid values can be obtained. |
Availability zone description
Used by actions: DescribeAreaRegion.
Name | Type | Description |
---|---|---|
Name | String | Availability zone name, such as ap-guangzhou-1 |
Desc | String | Availability zone description, such as Guangzhou region 1 |
ZoneId | Integer | Unique tag of the availability zone |
Encrypt | Integer | Encryptid Note: This field may return null, indicating that no valid values can be obtained. |
本页内容是否解决了您的问题?