tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2024-07-23 21:18:50

    ApplyResult

    Application update results

    Used by actions: UpdateApply.

    Name Type Description
    ApplicationId String Application ID
    ApplicationType Integer Application type
    ApplicationStatus Integer Status. Valid values: 0 (pending approval), 1 (application approved and task submitted), 2 (rejected)
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    TaskId String ID of the submitted task
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    Error ErrorInfo Error information
    Note: null may be returned for this field, indicating that no valid values can be obtained.

    ApplyStatus

    Application ID and status

    Used by actions: UpdateApply.

    Name Type Required Description
    ApplicationId String Yes Value format: cluster ID-application ID
    ApplicationStatus Integer Yes Status. Valid values: -1 (canceled), 0 (pending approval), 1 (application approved and task submitted), 2 (rejected). Only applications in the pending approval status can be updated.
    ApplicationType Integer Yes Application type
    ClusterId String Yes Cluster ID

    BackupExpireRuleInfo

    The details of backup retention policy
    Policy for cluster: ClusterId = cluster ID, TableGroupId·= -1, TableName= -1.
    Policy for cluster + table group: ClusterId = cluster ID, TableGroupId = table group ID, TableName = -1.
    Policy for cluster + table group + table: ClusterId= cluster ID,TableGroupId= table group ID,TableName` = table name.

    For FileTag, valid values: 0 (txh engine file), 1 (ulog file). When FileTag is set to 1, TableGroupId = -1 and TableName = -1 remain unchanged.
    ExpireDay is an integer number falling in the range of 1 (inclusive) to 999 (exclusive).
    For OperType, valid values: 0(Add),1(Delete),2(Modify). The values0and2` can be mixed, and the backend implementation is compatible.

    Used by actions: SetBackupExpireRule.

    Name Type Required Description
    TableGroupId String Yes The ID of the table group where the table resides
    TableName String Yes Table name
    FileTag Integer Yes file tag, which is described above.
    ExpireDay Integer Yes Retention days, which is described above.
    OperType Integer Yes Operation type, which is described above.

    BackupRecords

    Backup records
    When it is used as an output parameter, each field will be filled.
    When it is used as an input parameter, each field will be filled back into the structure as it is. This API can only be called if FIleTag = OSDATA.

    Used by actions: DeleteBackupRecords, DescribeBackupRecords.

    Name Type Required Description
    ZoneId Integer Yes Table group ID
    TableName String Yes Table name
    BackupType String Yes Backup source
    FileTag String Yes File tag: TCAPLUS_FULL or OSDATA
    ShardCount Integer Yes Number of shards
    BackupBatchTime String Yes Backup batch date
    BackupFileSize Integer Yes Total size of backup files
    BackupSuccRate String Yes Backup success rate
    BackupExpireTime String Yes Backup file expiration time
    AppId Integer Yes Business ID

    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.
    ClusterType Integer Cluster type. Valid values: 0 and 1 (shared cluster), 2 (dedicated cluster).
    Note: This field may return null, indicating that no valid values can be obtained.
    ClusterStatus Integer Cluster status. Valid values: 0 (Running), 1 (Isolated. This status is caused by overdue payments), 2 (To be repossessed. This status is caused when the cluster is actively deleted.),·3 (To be released. The resources occupied by the table can be released in this status.), 4 (Modifying).
    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.
    Censorship Integer Whether the cluster operation approval feature is enabled. Valid values: 0 (disabled), 1 (enabled)
    DbaUins Array of String Approver UIN list
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    DataFlowStatus Integer Whether data subscription is enabled
    Note: this field may return null, indicating that no valid values can be obtained.
    KafkaInfo KafkaInfo CKafka information when data subscription is enabled
    Note: this field may return null, indicating that no valid values can be obtained.
    TxhBackupExpireDay Integer The number of days after which the cluster Txh backup file will expire and be deleted.
    Note: This field may return null, indicating that no valid values can be obtained.
    UlogBackupExpireDay Integer The number of days after which the cluster Ulog backup file will expire and be deleted.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsReadOnlyUlogBackupExpireDay Integer Whether the expiration policy of cluster Ulog backup file is read-only. 0: Yes; 1: No.
    Note: This field may return null, indicating that no valid values can be obtained.
    RestProxyStatus Integer restproxy Status
    Note: This field may return null, indicating that no valid values can be obtained.

    CompareTablesInfo

    Compare the meta information of two tables

    Used by actions: MergeTablesData.

    Name Type Required Description
    SrcTableClusterId String Yes Cluster ID of the source table
    SrcTableGroupId String Yes Table group ID of the source table
    SrcTableName String Yes Source table name
    DstTableClusterId String Yes Cluster ID of the target table
    DstTableGroupId String Yes Table group ID of the target table
    DstTableName String Yes Target table name
    SrcTableInstanceId String Yes Source table ID
    DstTableInstanceId String Yes Target table ID

    ErrorInfo

    Describes the details of errors that may occur during the processing of each instance (application, region, or table).

    Used by actions: ClearTables, CompareIdlFiles, CreateSnapshots, CreateTables, DeleteIdlFiles, DeleteSnapshots, DeleteTableDataFlow, DeleteTableIndex, DeleteTables, DescribeClusterTags, DescribeSnapshots, DescribeTableGroupTags, DescribeTableTags, DescribeTables, DescribeTablesInRecycle, MergeTablesData, ModifySnapshots, ModifyTableMemos, ModifyTableQuotas, ModifyTableTags, ModifyTables, RecoverRecycleTables, RollbackTables, SetTableDataFlow, SetTableIndex, UpdateApply, VerifyIdlFiles.

    Name Type Description
    Code String Error code
    Message String Error message

    FieldInfo

    The list of table field information

    Used by actions: SetTableDataFlow, 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

    Filter

    Used by actions: DescribeClusters, DescribeTableGroups, DescribeTables, DescribeTablesInRecycle, DescribeTasks.

    Name Type Required Description
    Name String Yes Filter field name
    Value String No Filter field value
    Values Array of String No 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.

    KafkaInfo

    CKafka address

    Used by actions: DescribeClusters, SetTableDataFlow, SetTableIndex.

    Name Type Required Description
    Address String Yes CKafka address
    Topic String Yes CKafka topic
    User String Yes CKafka username
    Password String Yes CKafka password
    Instance String Yes CKafka instance
    IsVpc Integer Yes Whether VPC access is enabled

    KeyFile

    The file of keys used to import partial snapshot data

    Used by actions: ImportSnapshots.

    Name Type Required Description
    FileName String Yes Key file name
    FileExtType String Yes Key file extension
    FileContent String Yes Key file content
    FileSize Integer No Key file size

    MachineInfo

    Machine type and quantity

    Used by actions: CreateCluster, ModifyClusterMachine.

    Name Type Required Description
    MachineType String Yes Machine type
    MachineNum Integer Yes Machine quantity

    MergeTableResult

    Table merging results

    Used by actions: MergeTablesData.

    Name Type Description
    TaskId String Task ID
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    Error ErrorInfo If table merging is successful, null will be returned
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    Table CompareTablesInfo Comparison results of tables
    ApplicationId String Application ID
    Note: null may be returned for this field, indicating that no valid values can be obtained.

    MergeTablesInfo

    Request parameters used to merge tables

    Used by actions: MergeTablesData.

    Name Type Required Description
    MergeTables CompareTablesInfo Yes Information of tables to be merged
    CheckIndex Boolean Yes Whether to check indexes

    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.

    PoolInfo

    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)

    ProxyDetailInfo

    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
    Version String Version
    Note: This field may return null, indicating that no valid values can be obtained.

    ProxyMachineInfo

    Information of the machine at the access layer (tcaproxy)

    Used by actions: DescribeMachine.

    Name Type Description
    ProxyUid String Unique ID
    MachineType String Machine type
    AvailableCount Integer The number of proxy resources to be assigned

    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, DeleteTableDataFlow, DeleteTableIndex, DeleteTables, DescribeSnapshots, 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

    SelectedTableWithField

    The list of tables to which the specified fields belong

    Used by actions: SetTableDataFlow, 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 will be created, table caching enabled, or data subscription enabled
    ShardNum Integer No The number of index shards
    KafkaInfo KafkaInfo No CKafka instance information

    ServerDetailInfo

    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
    Version String Version
    Note: This field may return null, indicating that no valid values can be obtained.

    ServerMachineInfo

    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

    SnapshotInfo

    Snapshot list

    Used by actions: CreateSnapshots, ImportSnapshots.

    Name Type Required Description
    TableGroupId String Yes The ID of the table group where the table resides
    TableName String Yes Table name
    SnapshotName String Yes Snapshot name
    SnapshotTime Timestamp Yes The time of the data from which the snapshot was created
    SnapshotDeadTime Timestamp Yes Snapshot expiration time

    SnapshotInfoNew

    New expiration time of a snapshot

    Used by actions: DeleteSnapshots, ModifySnapshots.

    Name Type Required Description
    TableGroupId String Yes The ID of the table group where the table resides
    TableName String Yes Table name
    SnapshotName String Yes Snapshot name
    SnapshotDeadTime Timestamp No Snapshot expiration time

    SnapshotResult

    The result of snapshot creation

    Used by actions: CreateSnapshots, DeleteSnapshots, DescribeSnapshots, ModifySnapshots.

    Name Type Description
    TableGroupId String The ID of the table group where the table resides
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    TableName String Table name
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    TaskId String Task ID, which is valid for the API that creates one task at a time
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    Error ErrorInfo Error information
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    SnapshotName String Snapshot name
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    SnapshotTime Timestamp The time of the data from which the snapshot was created
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    SnapshotDeadTime Timestamp When the snapshot expires
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    SnapshotCreateTime Timestamp When the snapshot was created
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    SnapshotSize Integer Snapshot size
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    SnapshotStatus Integer Snapshot status. Valid values: 0 (creating), 1 (normal), 2 (deleting), 3 (expired), 4 (rolling back).
    Note: null may be returned for this field, indicating that no valid values can be obtained.

    SyncTableField

    Mapping of cache table field name

    Used by actions: DescribeTables, DescribeTablesInRecycle.

    Name Type Required Description
    SourceName String Yes Field name of TcaplusDB table
    TargetName String Yes Field name of the target cache table

    SyncTableInfo

    TcaplusDB cache table information

    Used by actions: DescribeTables, DescribeTablesInRecycle.

    Name Type Description
    TargetTableSplitNum Integer Sharded table quantity of the target cache table
    TargetTableNamePrefix Array of String Prefix of the target cache table name
    TargetSyncDBInstanceId String Instance ID of the cache database
    TargetDatabaseName String Name of the database where the cache table resides
    Status Integer Caching status. Valid values: 0 (creating), 1 (caching), 2 (disabled), -1 (deleted).
    ClusterId String ID of cluster where the table resides
    TableGroupId Integer The ID of the table group where the table resides
    TableName String Table name
    TableId String Table ID
    KeyFieldMapping Array of SyncTableField Mapping from the primary key field of the TcaplusDB table to the field of the target cache table
    ValueFieldMapping Array of SyncTableField Mapping of TcaplusDB table field to target cache table field

    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
    TxhBackupExpireDay Integer The number of days before the backup files of the Txh tables expire and are deleted.
    Note: This field may return null, indicating that no valid values can be obtained.
    EnableMysql Integer Whether MySQL load rebalancing is enabled. Valid values: 0 (Disabled), 1 (Enabling), 2 (Enabled).
    MysqlConnIp String MySQL load rebalancing vip
    Note: This field may return null, indicating that no valid values can be obtained.
    MysqlConnPort Integer MySQL load rebalancing vport
    Note: This field may return null, indicating that no valid values can be obtained.

    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 Information about global indexes, table caching, or data subscription
    Note: this field may return null, indicating that no valid values can be obtained.
    TxhBackupExpireDay Integer The number of days after which the table Txh backup files will be expire and deleted.
    Note: This field may return null, indicating that no valid values can be obtained.
    SyncTableInfo SyncTableInfo Cached information of the table
    Note: This field may return null, indicating that no valid values can be obtained.

    TableResultNew

    Table processing result information

    Used by actions: ClearTables, CreateTables, DeleteTableDataFlow, DeleteTableIndex, DeleteTables, ModifyTableMemos, ModifyTableQuotas, ModifyTableTags, ModifyTables, RecoverRecycleTables, SetTableDataFlow, 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.
    ApplicationId String Cluster operation application ID
    Note: null may be returned for this field, 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
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy