Querying Table Details

Function

This API is used to query table details.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/tables/{table_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A
workspace_id	Yes	String	Workspace ID.
table_id	Yes	String	Table ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
project_id	String	Project ID.
workspace_id	String	Workspace ID.
table_id	String	UUID
pipe_id	String	UUID
table_name	String	Table name.
table_alias	String	Table alias.
description	String	Description.
directory	String	Directory group.
category	String	Definition Directory type. STREAMING real-time stream INDEX: index APPLICATION: application TENANT_BUCKET: tenant bucket LAKE: data lake Constraints N/A Range STREAMING INDEX APPLICATION TENANT_BUCKET LAKE Default Value N/A
lock_status	String	Definition Table lock status. LOCKED: locked UNLOCKED: unlocked Constraints N/A Range LOCKED UNLOCKED Default Value N/A
process_status	String	Definition Handling status. COMPLETED: completed. CREATING: being created UPDATING: being updated DELETING: being deleted TRUNCATING being cleared UPGRADING: being upgraded CREATE_FAILED: creation failed UPDATE_FAILED: update failed DELETE_FAILED: deletion failed TRUNCATE_FAILED: clearing failed UPGRADE_FAILED: upgrade failed Constraints N/A Range COMPLETED CREATING UPDATING DELETING TRUNCATING UPGRADING CREATE_FAILED UPDATE_FAILED DELETE_FAILED TRUNCATE_FAILED UPGRADE_FAILED Default Value N/A
process_error	String	Definition Table processing error. NONE MISSING_ASSOCIATIONS: Association missing FAILED_INIT_STORAGE_RESOURCES_WHEN_CREATING: failed to initialize storage resources during creation FAILED_INIT_FLINK_RESOURCES_WHEN_CREATING: failed to initialize Flink resources during creation FAILED_DELETE_FLINK_RESOURCES_WHEN_DELETING: failed to delete Flink resources during deletion FAILED_DELETE_STORAGE_RESOURCES_WHEN_DELETING: failed to delete storage resources during deletion FAILED_DELETE_ALL_RESOURCES_WHEN_DELETING: failed to delete all resources during deletion FAILED_UPDATE_STORAGE_SETTING: failed to update the storage configuration FAILED_UPDATE_FLINK_SCHEMA: failed to update the Flink schema FAILED_UPDATE_STORAGE_SCHEMA: failed to update the storage schema FAILED_TO_APPLY_RESOURCE: failed to apply the resource FAILED_TO_UPGRADE_RESOURCE_MODEL: failed to upgrade the resource model Constraints N/A Range NONE MISSING_ASSOCIATIONS FAILED_INIT_STORAGE_RESOURCES_WHEN_CREATING FAILED_INIT_FLINK_RESOURCES_WHEN_CREATING FAILED_DELETE_FLINK_RESOURCES_WHEN_DELETING FAILED_DELETE_STORAGE_RESOURCES_WHEN_DELETING FAILED_DELETE_ALL_RESOURCES_WHEN_DELETING FAILED_UPDATE_STORAGE_SETTING FAILED_UPDATE_FLINK_SCHEMA FAILED_UPDATE_STORAGE_SCHEMA FAILED_TO_APPLY_RESOURCE FAILED_TO_UPGRADE_RESOURCE_MODEL Default Value N/A
format	String	Definition Table format. JSON: JSON CSV: CSV PARQUET: PARQUET ORC ORC -DEBEZIUM_JSON: Debezium JSON Constraints N/A Range JSON DEBEZIUM_JSON CSV PARQUET ORC Default Value N/A
rw_type	String	Definition Table read/write type. READ_ONLY: read-only READ_WRITE: read and write WRITE_ONLY: write-only Constraints N/A Range READ_ONLY READ_WRITE WRITE_ONLY Default Value N/A
owner_type	String	Definition Owner type. SYSTEM: system USER: user SYSTEM_ALLOWED_DELETE: can be deleted by the system USER_ALLOWED_DELETE: can be deleted by the user Constraints N/A Range SYSTEM USER SYSTEM_ALLOWED_DELETE USER_ALLOWED_DELETE Default Value N/A
data_layering	String	Definition Data layers. ODS: operation data storage layer DWS: data warehouse service layer ADS: application data service layer Constraints N/A Range ODS DWS ADS Default Value N/A
data_classification	String	Definition Data classification. FACTUAL_DATA: factual data DIMENSION_DATA: dimension data Constraints N/A Range FACTUAL_DATA DIMENSION_DATA Default Value N/A
schema	IsapTableSchema object	Table structure.
storage_setting	TableStorageSetting object	Table storage settings.
display_setting	TableDisplaySetting object	Table display settings.
create_time	Integer	Timestamp, in ms.
update_time	Integer	Timestamp, in ms.
delete_time	Integer	Timestamp, in ms.

**Table 4** IsapTableSchema
Parameter	Type	Description
columns	Array of IsapTableColumn objects	Table column list.
primary_key	Array of strings	Table primary key list.
partition	Array of strings	Table partition list.
watermark_column	String	Table watermark column element.
watermark_interval	Float	Table watermark delay interval.
time_filter	String	Table time filter column.

**Table 5** IsapTableColumn
Parameter	Type	Description
column_name	String	Table column name.
column_type	String	Definition Column field type. PHYSICAL: physical field METADATA: metadata field VIRTUAL_METADATA: virtual metadata field COMPUTED: computation field Constraints N/A Range PHYSICAL METADATA VIRTUAL_METADATA COMPUTED Default Value N/A
column_type_setting	String	Table column type settings.
column_data_type	String	Definition Column data type. ROW: row type MAP_STRING: string mapping type MAP_DECIMAL: decimal mapping type TINYINT: tiny integer SMALLINT: small integer INT: integer BIGINT: long integer DECIMAL: decimal data type FLOAT: single-precision floating point DOUBLE: double-precision floating point CHAR: fixed-length string VARCHAR: variable-length string STRING: string type KEYWORD: keyword type BOOLEAN: boolean type DATE: date type TIME: time type TIMESTAMP: timestamp type TIMESTAMP_LTZ: local timestamp type Constraints N/A Range ROW MAP_STRING MAP_DECIMAL TINYINT SMALLINT INT BIGINT DECIMAL FLOAT DOUBLE CHAR VARCHAR STRING KEYWORD BOOLEAN DATE TIME TIMESTAMP TIMESTAMP_LTZ Default Value N/A
column_data_type_setting	String	Table column data type setting
nullable	Boolean	Empty or not.
array	Boolean	Array or not.
depth	Integer	Depth.
parent_name	String	Parent-level name.
own_name	String	Name.
column_display_setting	ColumnDisplaySetting object	Table column display settings.
column_sequence_number	Integer	Column No.

**Table 6** ColumnDisplaySetting
Parameter	Type	Description
mapping_required	Boolean	Whether the mapping is mandatory.
group_sequence_number	Integer	Group sequence number.
intra_group_sequence_number	Integer	Group sequence number.
value_type	String	Value type.
value_qualified	String	Valid value.
display_name	String	Display name.
display_description	String	Display description.
group_name	String	Group name.

**Table 7** TableStorageSetting
Parameter	Type	Description
application_index	String	Application index.
application_topic	String	Application theme.
application_data_class_id	String	Application data class ID.
streaming_bandwidth	Number	Streaming bandwidth (MB/s).
streaming_partition	Integer	Streaming partition.
streaming_retention_size	Integer	Streaming capacity.
streaming_dataspace_id	String	Streaming data space ID.
index_storage_period	Integer	Index storage period.
index_storage_size	Integer	Index storage size.
index_shards	Integer	Number of index shards.
index_replicas	Integer	Number of index replicas.
lake_storage_period	Long	Data lake storage period.
lake_partition_setting	String	Definition Time unit. MINUTE10: 10 minutes HOUR DAY Constraints N/A Range MINUTE HOUR DAY Default Value N/A
lake_expiration_status	String	Definition Data lake expiration status. NOT_EXPIRED: not expired EXPIRED_PROCESSING: expired and being processed EXPIRED_SUCCESS: expired and processed successfully EXPIRED_FAILURE: expired but failed to be processed Constraints N/A Range NOT_EXPIRED EXPIRED_PROCESSING EXPIRED_SUCCESS EXPIRED_FAILURE Default Value N/A

**Table 8** TableDisplaySetting
Parameter	Type	Description
columns	Array of TableColumnDisplaySetting objects	Table column display list.
format	String	Definition Table display settings. Table: A table will be displayed. RAW: Raw data will be displayed. Constraints N/A Range TABLE RAW Default Value N/A