Querying the Table List

Function

This API is used to query the table list.

Calling Method

For details, see Calling APIs.

URI

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

**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 2** Query Parameters
Parameter	Mandatory	Type	Description
category	No	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
table_id	No	String	Table ID.
table_alias	No	String	Table alias.
table_name	No	String	Table name.
offset	No	Long	Definition Offset. Range 0-1000000 Default Value 0
limit	No	Long	Definition Data query limit. Range 0-1000 Default Value N/A
sort_key	No	String	Sorting by attribute.
sort_dir	No	String	Sorting order. The value can be ASC or DESC.
exists	No	Boolean	Exist or not.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
count	Long	Tables.
records	Array of IsapTable objects	Table details.

**Table 5** IsapTable
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 6** 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 7** 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 8** 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 9** 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 10** 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

**Table 11** TableColumnDisplaySetting
Parameter	Type	Description
column_name	String	Table column name.
column_alias	String	Table column alias.
display_by_default	Boolean	Whether to use default display settings.

Status code: 400

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

None

Example Responses

Status code: 200

Successful.

{
  "count" : 1,
  "records" : [ {
    "category" : "INDEX",
    "create_time" : 1709610477056,
    "data_classification" : "FACTUAL_DATA",
    "delete_time" : 0,
    "description" : "test",
    "directory" : "test",
    "format" : "JSON",
    "lock_status" : "UNLOCKED",
    "owner_type" : "SYSTEM",
    "pipe_id" : "8660f159-932b-4b76-831c-4882850e4c18",
    "process_error" : "NONE",
    "process_status" : "COMPLETED",
    "project_id" : "c796dfc5f1644915ae072b7642a2cd93",
    "rw_type" : "READ_WRITE",
    "schema" : {
      "columns" : [ {
        "array" : false,
        "column_data_type" : "TIMESTAMP_LTZ",
        "column_data_type_setting" : "3",
        "column_name" : "__time",
        "column_sequence_number" : 0,
        "column_type" : "PHYSICAL",
        "depth" : 0,
        "nullable" : true,
        "own_name" : "__time",
        "parent_name" : ""
      }, {
        "array" : false,
        "column_data_type" : "ROW",
        "column_name" : "dest_asset",
        "column_sequence_number" : 0,
        "column_type" : "PHYSICAL",
        "depth" : 0,
        "nullable" : true,
        "own_name" : "dest_asset",
        "parent_name" : ""
      } ],
      "partition" : [ ],
      "primary_key" : [ ],
      "time_filter" : "__time",
      "watermark_column" : "__time",
      "watermark_interval" : 0
    },
    "storage_setting" : {
      "index_replicas" : 1,
      "index_shards" : 1,
      "index_storage_period" : 7,
      "index_storage_size" : 500
    },
    "table_alias" : "test_alias",
    "table_id" : "96c0b2f1-57db-4ba6-8039-24ab39717aaf",
    "table_name" : "i_sec_waf_access",
    "update_time" : 1709610480592,
    "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;


public class ListTablesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTablesRequest request = new ListTablesRequest();
        request.withWorkspaceId("{workspace_id}");
        try {
            ListTablesResponse response = client.listTables(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTablesRequest()
        request.workspace_id = "{workspace_id}"
        response = client.list_tables(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTablesRequest{}
	request.WorkspaceId = "{workspace_id}"
	response, err := client.ListTables(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     