Cluster details
Used by actions: DescribeClusters.
Name | Type | Description |
---|---|---|
ClusterName | String | Cluster name |
ClusterId | String | Cluster ID |
Region | String | Cluster region |
IdlType | String | Cluster data description language type, such as PROTO , TDR , or MIX |
NetworkType | String | Network type |
VpcId | String | ID of the VPC instance with which a cluster is associated |
SubnetId | String | ID of the subnet instance with which a cluster is associated |
CreatedTime | Timestamp | Creation time |
Password | String | Cluster password |
PasswordStatus | String | Password status |
ApiAccessId | String | TcaplusDB SDK connection parameter: access ID |
ApiAccessIp | String | TcaplusDB SDK connection parameter: access address |
ApiAccessPort | Integer | TcaplusDB SDK connection parameter: access port |
OldPasswordExpireTime | String | If PasswordStatus is unmodifiable , the old password has not expired, and this field will display its expiration time; otherwise, this field will be emptyNote: this field may return null, indicating that no valid values can be obtained. |
ApiAccessIpv6 | String | TcaplusDB SDK connection parameter for accessing IPv6 addresses Note: this field may return null, indicating that no valid values can be obtained. |
ClusterType | Integer | Cluster type Note: this field may return null , indicating that no valid values can be obtained. |
ClusterStatus | Integer | Cluster status Note: this field may return null , indicating that no valid values can be obtained. |
ReadCapacityUnit | Integer | Read CU Note: this field may return null , indicating that no valid values can be obtained. |
WriteCapacityUnit | Integer | Write CU Note: this field may return null , indicating that no valid values can be obtained. |
DiskVolume | Integer | Disk capacity Note: this field may return null , indicating that no valid values can be obtained. |
ServerList | Array of ServerDetailInfo | Information of the machine at the storage layer (tcapsvr) in a dedicated cluster Note: this field may return null , indicating that no valid values can be obtained. |
ProxyList | Array of ProxyDetailInfo | Information of the machine at the access layer (tcaproxy) in a dedicated cluster Note: this field may return null , indicating that no valid values can be obtained. |
Describes the details of errors that may occur during the processing of each instance (application, region, or table).
Used by actions: ClearTables, CompareIdlFiles, CreateTables, DeleteIdlFiles, DeleteTableIndex, DeleteTables, DescribeClusterTags, DescribeTableGroupTags, DescribeTableTags, DescribeTables, DescribeTablesInRecycle, ModifyTableMemos, ModifyTableQuotas, ModifyTableTags, ModifyTables, RecoverRecycleTables, RollbackTables, SetTableIndex, VerifyIdlFiles.
Name | Type | Description |
---|---|---|
Code | String | Error code |
Message | String | Error message |
The list of table field information
Used by actions: SetTableIndex.
Name | Type | Required | Description |
---|---|---|---|
FieldName | String | Yes | Table field name |
IsPrimaryKey | String | Yes | Whether it is a primary key field |
FieldType | String | No | Field type |
FieldSize | Integer | No | Field length |
Filter
Used by actions: DescribeClusters, DescribeTableGroups, DescribeTables, DescribeTablesInRecycle, DescribeTasks.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Filter field name |
Value | String | Yes | Filter field value |
Table definition file details, including file content
Used by actions: CompareIdlFiles, CreateTables, DeleteIdlFiles, DescribeIdlFileInfos, DescribeTables, DescribeTablesInRecycle, ModifyTables, VerifyIdlFiles.
Name | Type | Required | Description |
---|---|---|---|
FileName | String | Yes | Filename excluding extension |
FileType | String | Yes | Data interface description language (IDL) type |
FileExtType | String | Yes | File extension |
FileSize | Integer | Yes | File size in bytes |
FileId | Integer | No | File ID, which is meaningful for files already uploaded Note: this field may return null, indicating that no valid values can be obtained. |
FileContent | String | No | File content, which is meaningful for files to be uploaded in this request Note: this field may return null, indicating that no valid values can be obtained. |
Table definition file details, excluding file content
Used by actions: DeleteIdlFiles.
Name | Type | Description |
---|---|---|
FileName | String | Filename excluding extension Note: this field may return null, indicating that no valid values can be obtained. |
FileType | String | Data interface description language (IDL) type Note: this field may return null, indicating that no valid values can be obtained. |
FileExtType | String | File extension Note: this field may return null, indicating that no valid values can be obtained. |
FileSize | Integer | File size in bytes Note: this field may return null, indicating that no valid values can be obtained. |
FileId | Integer | File ID Note: this field may return null, indicating that no valid values can be obtained. |
Error | ErrorInfo | Error message Note: this field may return null, indicating that no valid values can be obtained. |
Machine type and quantity
Used by actions: CreateCluster, ModifyClusterMachine.
Name | Type | Required | Description |
---|---|---|---|
MachineType | String | Yes | Machine type |
MachineNum | Integer | Yes | Machine quantity |
Table information parsed from IDL table description file
Used by actions: CompareIdlFiles, VerifyIdlFiles.
Name | Type | Description |
---|---|---|
TableIdlType | String | Table description language type. Valid values: PROTO, TDR Note: this field may return null, indicating that no valid values can be obtained. |
TableInstanceId | String | Table instance ID Note: this field may return null, indicating that no valid values can be obtained. |
TableName | String | Table name Note: this field may return null, indicating that no valid values can be obtained. |
TableType | String | Table data structure type. Valid values: GENERIC, LIST Note: this field may return null, indicating that no valid values can be obtained. |
KeyFields | String | Primary key field information Note: this field may return null, indicating that no valid values can be obtained. |
OldKeyFields | String | Old primary key field information, which is valid during verification of table modification Note: this field may return null, indicating that no valid values can be obtained. |
ValueFields | String | Non-primary key field information Note: this field may return null, indicating that no valid values can be obtained. |
OldValueFields | String | Old non-primary key field information, which is valid during verification of table modification Note: this field may return null, indicating that no valid values can be obtained. |
TableGroupId | String | Table group ID Note: this field may return null, indicating that no valid values can be obtained. |
SumKeyFieldSize | Integer | Total size of primary key field Note: this field may return null, indicating that no valid values can be obtained. |
SumValueFieldSize | Integer | Total size of non-primary key fields Note: this field may return null, indicating that no valid values can be obtained. |
IndexKeySet | String | Index key set Note: this field may return null, indicating that no valid values can be obtained. |
ShardingKeySet | String | Shardkey set Note: this field may return null, indicating that no valid values can be obtained. |
TdrVersion | Integer | TDR version number Note: this field may return null, indicating that no valid values can be obtained. |
Error | ErrorInfo | Error message Note: this field may return null, indicating that no valid values can be obtained. |
ListElementNum | Integer | Number of LIST-type table elements Note: this field may return null, indicating that no valid values can be obtained. |
SortFieldNum | Integer | Number of SORTLIST-type table sort fields Note: this field may return null, indicating that no valid values can be obtained. |
SortRule | Integer | Sort order of SORTLIST-type tables Note: this field may return null, indicating that no valid values can be obtained. |
Information of the machines in the resource pool
Used by actions: DescribeMachine.
Name | Type | Description |
---|---|---|
PoolUid | Integer | Unique ID |
Ipv6Enable | Integer | Whether IPv6 is supported |
AvailableAppCount | Integer | Remaining available cluster resources |
ServerList | Array of ServerMachineInfo | The list of machines at the storage layer (tcapsvr) |
ProxyList | Array of ProxyMachineInfo | The list of machines at the access layer (tcaproxy) |
Information of the machine at the access layer (tcaproxy) in a dedicated cluster
Used by actions: DescribeClusters.
Name | Type | Description |
---|---|---|
ProxyUid | String | The unique ID of the access layer (tcaproxy) |
MachineType | String | Machine type |
ProcessSpeed | Integer | The speed of processing request packets |
AverageProcessDelay | Integer | Request packet delay |
SlowProcessSpeed | Integer | The speed of processing delayed request packets |
Information of the machine at the access layer (tcaproxy)
Used by actions: DescribeMachine.
Name | Type | Description |
---|---|---|
ProxyUid | String | Unique ID |
MachineType | String | Machine type |
TcaplusDB service region details
Used by actions: DescribeRegions.
Name | Type | Description |
---|---|---|
RegionName | String | Region Ap-code |
RegionAbbr | String | Region abbreviation |
RegionId | Integer | Region ID |
Ipv6Enable | Integer | Whether to support IPv6 address access. Valid values: 0 (support), 1 (not support) |
Information of selected table
Used by actions: ClearTables, CompareIdlFiles, CreateBackup, CreateTables, DeleteTableIndex, DeleteTables, DescribeTableTags, DescribeTables, ModifyTableMemos, ModifyTableQuotas, ModifyTableTags, ModifyTables, RecoverRecycleTables, RollbackTables.
Name | Type | Required | Description |
---|---|---|---|
TableGroupId | String | Yes | ID of the table group where a table resides |
TableName | String | Yes | Table name |
TableInstanceId | String | No | Table instance ID |
TableIdlType | String | No | Table description language type. Valid values: PROTO, TDR |
TableType | String | No | Table data structure type. Valid values: GENERIC, LIST |
ListElementNum | Integer | No | Number of LIST-type table elements |
ReservedVolume | Integer | No | Reserved table capacity in GB |
ReservedReadQps | Integer | No | Reserved table read QPS |
ReservedWriteQps | Integer | No | Reserved table write QPS |
Memo | String | No | Table remarks |
FileName | String | No | Key rollback filename, which is only used for rollback |
FileExtType | String | No | Key rollback file extension, which is only used for rollback |
FileSize | Integer | No | Key rollback file size, which is only used for rollback |
FileContent | String | No | Key rollback file content, which is only used for rollback |
The list of tables to which the specified fields belong
Used by actions: SetTableIndex.
Name | Type | Required | Description |
---|---|---|---|
TableGroupId | String | Yes | ID of the table group where the table resides |
TableName | String | Yes | Table name |
TableInstanceId | String | No | Table ID |
TableIdlType | String | No | Table description language. Valid values: PROTO , TDR |
TableType | String | No | Table data structure. Valid values: GENERIC , LIST |
SelectedFields | Array of FieldInfo | No | The list of fields on which indexes need to be created |
ShardNum | Integer | No | The number of index shards |
Information of the machine at the storage layer (tcapsvr) in a dedicated cluster
Used by actions: DescribeClusters.
Name | Type | Description |
---|---|---|
ServerUid | String | The unique ID of the storage layer (tcapsvr) |
MachineType | String | Machine type |
MemoryRate | Integer | Memory utilization |
DiskRate | Integer | Disk utilization |
ReadNum | Integer | The number of reads |
WriteNum | Integer | The number of writes |
ServerList
, the list of machines at the storage layer (tcapsvr)
Used by actions: DescribeMachine.
Name | Type | Description |
---|---|---|
ServerUid | String | The unique ID of the machine |
MachineType | String | Machine type |
Table group details
Used by actions: DescribeTableGroups.
Name | Type | Description |
---|---|---|
TableGroupId | String | Table group ID |
TableGroupName | String | Table group name |
CreatedTime | Timestamp | Table group creation time |
TableCount | Integer | Number of tables in table group |
TotalSize | Integer | Total table storage capacity in MB in table group |
Table details
Used by actions: DescribeTables, DescribeTablesInRecycle.
Name | Type | Description |
---|---|---|
TableName | String | Table name Note: this field may return null, indicating that no valid values can be obtained. |
TableInstanceId | String | Table instance ID Note: this field may return null, indicating that no valid values can be obtained. |
TableType | String | Table data structure type, such as GENERIC or LIST Note: this field may return null, indicating that no valid values can be obtained. |
TableIdlType | String | Table data interface description language (IDL) type, such as PROTO or TDR Note: this field may return null, indicating that no valid values can be obtained. |
ClusterId | String | ID of the cluster where a table resides Note: this field may return null, indicating that no valid values can be obtained. |
ClusterName | String | Name of the cluster where a table resides Note: this field may return null, indicating that no valid values can be obtained. |
TableGroupId | String | ID of the table group where a table resides Note: this field may return null, indicating that no valid values can be obtained. |
TableGroupName | String | Name of the table group where a table resides Note: this field may return null, indicating that no valid values can be obtained. |
KeyStruct | String | JSON string of table's primary key field structure Note: this field may return null, indicating that no valid values can be obtained. |
ValueStruct | String | JSON string of table non-primary key field structure Note: this field may return null, indicating that no valid values can be obtained. |
ShardingKeySet | String | Table shardkey set, which is valid for PROTO-type tables Note: this field may return null, indicating that no valid values can be obtained. |
IndexStruct | String | Table index key field set, which is valid for PROTO-type tables Note: this field may return null, indicating that no valid values can be obtained. |
ListElementNum | Integer | Number of LIST-type table elements Note: this field may return null, indicating that no valid values can be obtained. |
IdlFiles | Array of IdlFileInfo | Information list of IDL files associated with table Note: this field may return null, indicating that no valid values can be obtained. |
ReservedVolume | Integer | Reserved table capacity in GB Note: this field may return null, indicating that no valid values can be obtained. |
ReservedReadQps | Integer | Reserved table read QPS Note: this field may return null, indicating that no valid values can be obtained. |
ReservedWriteQps | Integer | Reserved table write QPS Note: this field may return null, indicating that no valid values can be obtained. |
TableSize | Integer | Actual table data size in MB Note: this field may return null, indicating that no valid values can be obtained. |
Status | String | Table status Note: this field may return null, indicating that no valid values can be obtained. |
CreatedTime | String | Table creation time Note: this field may return null, indicating that no valid values can be obtained. |
UpdatedTime | String | Table's last modified time Note: this field may return null, indicating that no valid values can be obtained. |
Memo | String | Table remarks Note: this field may return null, indicating that no valid values can be obtained. |
Error | ErrorInfo | Error message Note: this field may return null, indicating that no valid values can be obtained. |
ApiAccessId | String | TcaplusDB SDK data access ID Note: this field may return null, indicating that no valid values can be obtained. |
SortFieldNum | Integer | Number of SORTLIST-type table sort fields Note: this field may return null, indicating that no valid values can be obtained. |
SortRule | Integer | Sort order of SORTLIST-type tables Note: this field may return null, indicating that no valid values can be obtained. |
DbClusterInfoStruct | String | Distributed index information of table |
Table processing result information
Used by actions: ClearTables, CreateTables, DeleteTableIndex, DeleteTables, ModifyTableMemos, ModifyTableQuotas, ModifyTableTags, ModifyTables, RecoverRecycleTables, SetTableIndex.
Name | Type | Description |
---|---|---|
TableInstanceId | String | Table instance ID in the format of tcaplus-3be64cbb Note: this field may return null, indicating that no valid values can be obtained. |
TaskId | String | Task ID, which is valid for the API that creates one task Note: this field may return null, indicating that no valid values can be obtained. |
TableName | String | Table name Note: this field may return null, indicating that no valid values can be obtained. |
TableType | String | Table data structure type, such as GENERIC or LIST Note: this field may return null, indicating that no valid values can be obtained. |
TableIdlType | String | Table data interface description language (IDL) type, such as PROTO or TDR Note: this field may return null, indicating that no valid values can be obtained. |
TableGroupId | String | ID of the table group where a table resides Note: this field may return null, indicating that no valid values can be obtained. |
Error | ErrorInfo | Error message Note: this field may return null, indicating that no valid values can be obtained. |
TaskIds | Array of String | Task ID list, which is valid for the API that creates multiple tasks Note: this field may return null, indicating that no valid values can be obtained. |
Table rollback result information
Used by actions: RollbackTables.
Name | Type | Description |
---|---|---|
TableInstanceId | String | Table instance ID in the format of tcaplus-3be64cbb Note: this field may return null, indicating that no valid values can be obtained. |
TaskId | String | Task ID, which is valid for the API that creates one task Note: this field may return null, indicating that no valid values can be obtained. |
TableName | String | Table name Note: this field may return null, indicating that no valid values can be obtained. |
TableType | String | Table data structure type, such as GENERIC or LIST Note: this field may return null, indicating that no valid values can be obtained. |
TableIdlType | String | Table data interface description language (IDL) type, such as PROTO or TDR Note: this field may return null, indicating that no valid values can be obtained. |
TableGroupId | String | ID of the table group where a table resides Note: this field may return null, indicating that no valid values can be obtained. |
Error | ErrorInfo | Error message Note: this field may return null, indicating that no valid values can be obtained. |
TaskIds | Array of String | Task ID list, which is valid for the API that creates multiple tasks Note: this field may return null, indicating that no valid values can be obtained. |
FileId | String | ID of uploaded key file Note: this field may return null, indicating that no valid values can be obtained. |
SuccKeyNum | Integer | Number of keys successfully verified Note: this field may return null, indicating that no valid values can be obtained. |
TotalKeyNum | Integer | Total number of keys contained in key file Note: this field may return null, indicating that no valid values can be obtained. |
Tag information unit
Used by actions: CreateCluster, CreateTableGroup, CreateTables, DescribeClusterTags, DescribeTableGroupTags, DescribeTableTags, ModifyClusterTags, ModifyTableGroupTags, ModifyTableTags.
Name | Type | Required | Description |
---|---|---|---|
TagKey | String | Yes | Tag key |
TagValue | String | No | Tag value |
Cluster tag information
Used by actions: DescribeClusterTags.
Name | Type | Description |
---|---|---|
ClusterId | String | Cluster ID |
Tags | Array of TagInfoUnit | Tag information |
Error | ErrorInfo | Error message |
Table tag information
Used by actions: DescribeTableTags.
Name | Type | Description |
---|---|---|
TableInstanceId | String | Table instance ID |
TableName | String | Table name |
TableGroupId | String | Table group ID |
Tags | Array of TagInfoUnit | Tag information |
Error | ErrorInfo | Error message |
Table group tag information
Used by actions: DescribeTableGroupTags.
Name | Type | Description |
---|---|---|
ClusterId | String | Cluster ID |
TableGroupId | String | Table group ID |
Tags | Array of TagInfoUnit | Tag information |
Error | ErrorInfo | Error message |
Task details
Used by actions: DescribeTasks.
Name | Type | Description |
---|---|---|
TaskId | String | Task ID |
TaskType | String | Task type |
TransId | String | ID of TcaplusDB internal transaction associated with task |
ClusterId | String | ID of the cluster where a task resides |
ClusterName | String | Name of the cluster where a task resides |
Progress | Integer | Task progress |
StartTime | Timestamp | Task creation time |
UpdateTime | Timestamp | Task last modified time |
Operator | String | Operator |
Content | String | Task details |
Was this page helpful?