Data Types

Last updated: 2020-07-24 14:33:52

ClusterInfo

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 empty
Note: 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.

ErrorInfo

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, DeleteTables, DescribeClusterTags, DescribeTableGroupTags, DescribeTableTags, DescribeTables, DescribeTablesInRecycle, ModifyTableMemos, ModifyTableQuotas, ModifyTableTags, ModifyTables, RecoverRecycleTables, RollbackTables, VerifyIdlFiles.

Name Type Description
Code String Error code
Message String Error message

Filter

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

IdlFileInfo

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.

IdlFileInfoWithoutContent

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.

ParsedTableInfoNew

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.

RegionInfo

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)

SelectedTableInfoNew

Information of selected table

Used by actions: ClearTables, CompareIdlFiles, CreateBackup, CreateTables, 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

TableGroupInfo

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

TableInfoNew

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

TableResultNew

Table processing result information

Used by actions: ClearTables, CreateTables, DeleteTables, ModifyTableMemos, ModifyTableQuotas, ModifyTableTags, ModifyTables, RecoverRecycleTables.

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.

TableRollbackResultNew

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.

TagInfoUnit

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

TagsInfoOfCluster

Cluster tag information

Used by actions: DescribeClusterTags.

Name Type Description
ClusterId String Cluster ID
Tags Array of TagInfoUnit Tag information
Error ErrorInfo Error message

TagsInfoOfTable

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

TagsInfoOfTableGroup

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

TaskInfoNew

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?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help