Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Information Architecture/ Querying Information About Multiple Types of Tables
Updated on 2024-11-06 GMT+08:00

Querying Information About Multiple Types of Tables

Function

Query information about multiple types of tables from the information architecture, including logical entities, physical tables, dimension tables, fact tables, and summary tables.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/design/all-tables

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Fuzzy query by name or code.

create_by

No

String

Query by creator.

status

No

String

Specifies the service status.

Options:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be approved

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be approved

  • OFFLINE: offline

  • REJECT: rejected

sync_status

No

String

Defines the enumeration of the synchronization status.

Options:

  • RUNNING: synchronizing

  • NO_NEED: not synchronized

  • SUMMARY_SUCCESS: overall success

  • SUMMARY_FAILED: overall failure

sync_key

No

Array

Defines the enumeration of synchronization task types.

Options:

  • BUSINESS_ASSET: synchronizes service assets.

  • DATA_QUALITY: Create a quality job.

  • TECHNICAL_ASSET: synchronizes technology assets.

  • META_DATA_LINK: asset association

  • PHYSICAL_TABLE: Create a table (production environment).

  • DEV_PHYSICAL_TABLE: Create a table in the development environment.

  • DLF_TASK: creates a data development job.

  • MATERIALIZATION: Data is stored in the database (code table).

  • PUBLISH_TO_DLM: publishes data service APIs.

  • SUMMARY_STATUS: overall status

biz_catalog_id

No

String

ID of the service catalog to which the belongs.

begin_time

No

String

Left boundary of time filtering. This parameter is used together with end_time. Only time range filtering is supported. Unilateral filtering is invalid. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

end_time

No

String

Right boundary for time filtering. This parameter is used together with begin_time to support only time range filtering. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

limit

No

Integer

Number of records to be queried on each page, that is, Y records to be queried. The default value is 50, and the value range is [1,100].

offset

No

Integer

Start coordinate of the query, that is, the number of skipped data records. The value can only be 0 or an integer multiple of limit. If the value does not meet the requirement, the value is rounded down. The default value is 0.

biz_catalog_id_list

No

Array

ID list of the topic to which the topic belongs. The value of this parameter is of the String type instead of the Long type.

biz_type_list

Yes

Array

Type of the table to be queried, which is mandatory.

Options:

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_MODEL: physical table

  • DIMENSION_LOGIC_TABLE: dimension table

  • FACT_LOGIC_TABLE: fact table

  • AGGREGATION_LOGIC_TABLE: summary table

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header).

This field is mandatory for authentication using tokens.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Project-Id

No

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios.

Content-Type

No

String

Default value: application/json;charset=UTF-8

This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

data: unified outermost data structure of the returned result.

Table 5 data

Parameter

Type

Description

value

value object

value: unified outer data structure of the returned result.

Table 6 value

Parameter

Type

Description

total

Integer

Total number.

records

Array of AllTableVO objects

Number of application object (AllTableVO) groups that are found.

Table 7 AllTableVO

Parameter

Type

Description

id

String

L1 ID. The value is of the string type instead of the long type.

name

String

L1 name.

tb_logic_guid

String

GUID of the logical entity after the table is released.

quality_id

String

Quality ID.

reversed

Boolean

Indicates whether it is reverse.

partition_conf

String

Partition expression.

dirty_out_switch

Boolean

Indicates whether to output abnormal data.

dirty_out_database

String

Abnormal data output library.

dirty_out_prefix

String

Prefix of an exception table.

dirty_out_suffix

String

Suffix of an exception table.

tb_guid

String

GUID of the physical table after the table is released.

code

String

Code.

create_by

String

Creator.

tenant_id

String

Tenant ID.

description

String

Description.

status

String

Release status of an entity. This parameter is read-only and does not need to be set during creation and update.

Options:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be reviewed

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be reviewed

  • OFFLINE: offline

  • REJECT: rejected

biz_type

String

Business entity type.

Options:

  • AGGREGATION_LOGIC_TABLE: summary table

  • ATOMIC_INDEX: atomic metric

  • ATOMIC_METRIC: atomic metric (new)

  • BIZ_CATALOG: process architecture directory

  • BIZ_METRIC: service indicator

  • CODE_TABLE: code table

  • COMMON_CONDITION: general filter

  • COMPOSITE_METRIC: Compound Metric (new)

  • COMPOUND_METRIC: compound metric

  • CONDITION_GROUP: restriction group

  • DEGENERATE_DIMENSION: degenerate dimension

  • DERIVATIVE_INDEX: derivative indicator

  • DERIVED_METRIC: derivative indicator (new)

  • DIMENSION: dimension

  • DIMENSION_ATTRIBUTE: dimension attribute

  • DIMENSION_HIERARCHIES: dimension level

  • DIMENSION_LOGIC_TABLE: dimension table

  • DIMENSION_TABLE_ATTRIBUTE: dimension attribute

  • DIRECTORY: directory

  • FACT_ATTRIBUTE: fact table attribute

  • FACT_DIMENSION: fact table dimension

  • FACT_LOGIC_TABLE: fact table

  • FACT_MEASURE: fact table measurement

  • FUNCTION: function

  • INFO_ARCH: information architecture (used for modifying themes in batches)

  • MODEL: model

  • QUALITY_RULE: quality rule

  • SECRECY_LEVEL: security level

  • STANDARD_ELEMENT: data standard

  • STANDARD_ELEMENT_TEMPLATE: data standard template

  • SUBJECT: theme

  • Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables

  • SUMMARY_INDEX: summary table indicator attribute

  • SUMMARY_TIME: time period attribute of the SDR table

  • TABLE_MODEL: relationship model (logical model/physical model)

  • TABLE_MODEL_ATTRIBUTE: relationship model attribute (logical model/physical model)

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_TYPE: table type

  • TAG: tag

  • TIME_CONDITION: time restriction

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

db_name

String

Indicates the database name.

dw_type

String

Data connection type. This parameter is read-only.

queue_name

String

Queue required for executing SQL statements through the DLI data connection. This parameter is mandatory when the data connection type is DLI.

schema

String

Required by the DWS type.

l1

String

Subject area group.

l2

String

Subject area.

l3

String

Business object.

l1_id

String

Subject area group ID, which is read-only. The value of this parameter is of the String type instead of the Long type.

l2_id

String

Subject area ID.

l3_id

String

Service object ID, which is read-only. The value of this parameter is of the String type instead of the Long type.

new_biz

BizVersionManageVO object

Service version management. This parameter is read-only.

physical_table

String

Table Creation Status in the Production Environment

dev_physical_table

String

Table Creation Status in the Development Environment

technical_asset

String

Synchronization status of technical assets. This parameter is read-only.

business_asset

String

Service asset synchronization status. This parameter is read-only.

meta_data_link

String

Asset association status. This parameter is read-only.

data_quality

String

Quality job status. This parameter is read-only.

dlf_task

String

Status of a data development job. This parameter is read-only.

materialization

String

Status of saving lookup table values to the database. This parameter is read-only.

publish_to_dlm

String

DLM API generation status. This parameter is read-only.

summary_status

String

Overall synchronization status. This parameter is read-only.

standard_count

String

Standard quantity, which is read-only. Set this parameter to the string type instead of the long type.

alias

String

Alias

api_id

String

API ID of the SDR table.

workspace_id

String

Workspace ID

workspace_name

String

Workspace name

dev_version

String

Development environment version. Set this parameter to the string type instead of the long type.

prod_version

String

Production environment version. Set this parameter to the string type instead of the long type.

dev_version_name

String

Development Environment Version Name

prod_version_name

String

Production Environment Version Name

env_type

String

Type of the development and production environment.

Options:

  • INVALID_TYPE: invalid environment

  • DEV_TYPE: development environment

  • PROD_TYPE: production environment

  • DEV_PROD_TYPE: development and production environment

Table 8 BizVersionManageVO

Parameter

Type

Description

id

String

ID information. The value of this parameter is of the String type instead of the Long type.

biz_type

String

Business entity type.

Options:

  • AGGREGATION_LOGIC_TABLE: summary table

  • ATOMIC_INDEX: atomic metric

  • ATOMIC_METRIC: atomic metric (new)

  • BIZ_CATALOG: process architecture directory

  • BIZ_METRIC: service indicator

  • CODE_TABLE: code table

  • COMMON_CONDITION: general filter

  • COMPOSITE_METRIC: Compound Metric (new)

  • COMPOUND_METRIC: compound metric

  • CONDITION_GROUP: restriction group

  • DEGENERATE_DIMENSION: degenerate dimension

  • DERIVATIVE_INDEX: derivative indicator

  • DERIVED_METRIC: derivative indicator (new)

  • DIMENSION: dimension

  • DIMENSION_ATTRIBUTE: dimension attribute

  • DIMENSION_HIERARCHIES: dimension level

  • DIMENSION_LOGIC_TABLE: dimension table

  • DIMENSION_TABLE_ATTRIBUTE: dimension attribute

  • DIRECTORY: directory

  • FACT_ATTRIBUTE: fact table attribute

  • FACT_DIMENSION: fact table dimension

  • FACT_LOGIC_TABLE: fact table

  • FACT_MEASURE: fact table measurement

  • FUNCTION: function

  • INFO_ARCH: information architecture (used for modifying themes in batches)

  • MODEL: model

  • QUALITY_RULE: quality rule

  • SECRECY_LEVEL: security level

  • STANDARD_ELEMENT: data standard

  • STANDARD_ELEMENT_TEMPLATE: data standard template

  • SUBJECT: theme

  • Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables

  • SUMMARY_INDEX: summary table indicator attribute

  • SUMMARY_TIME: time period attribute of the SDR table

  • TABLE_MODEL: relationship model (logical model/physical model)

  • TABLE_MODEL_ATTRIBUTE: relationship model attribute (logical model/physical model)

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_TYPE: table type

  • TAG: tag

  • TIME_CONDITION: time restriction

biz_id

String

Service ID. The value is of the String type instead of the Long type.

biz_info

String

Business object information.

status

String

Release status of an entity. This parameter is read-only and does not need to be set during creation and update.

Options:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be reviewed

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be reviewed

  • OFFLINE: offline

  • REJECT: rejected

biz_version

Integer

Service version, which is read-only.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 401

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 403

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Example Requests

Query the first ten data records of logical entities, physical tables, dimension tables, fact tables, and summary tables from the information architecture.

GET https://{endpoint}/v2/{project_id}/design/all-tables?page_start=1&page_size=10&biz_type_list=TABLE_MODEL_LOGIC&biz_type_list=TABLE_MODEL&biz_type_list=DIMENSION_LOGIC_TABLE&biz_type_list=FACT_LOGIC_TABLE&biz_type_list=AGGREGATION_LOGIC_TABLE&advOnInitFlg=true

Example Responses

Status code: 200

This operation succeeds, and the returned data is an AllTableVO list.

{
  "data" : {
    "value" : {
      "total" : 86,
      "records" : [ {
        "id" : "1229920251379118081",
        "name" : "test_czh_0416",
        "tb_logic_guid" : "",
        "quality_id" : "1230938508982857728",
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "test_czh_0416",
        "create_by" : "ei_dayu_y00321344_01",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "OFFLINE",
        "biz_type" : "TABLE_MODEL",
        "create_time" : "2024-04-16T22:23:59+08:00",
        "update_time" : "2024-04-19T17:55:49+08:00",
        "db_name" : "bi",
        "dw_type" : "DLI",
        "queue_name" : null,
        "schema" : null,
        "l1" : "test_czh_catalog",
        "l2" : null,
        "l3" : null,
        "l1_id" : "1194966710038474752",
        "l2_id" : null,
        "l3_id" : null,
        "new_biz" : null,
        "physical_table" : "CREATE_FAILED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "CREATE_FAILED",
        "business_asset" : "CREATE_SUCCESS",
        "meta_data_link" : "UPDATE_FAILED",
        "data_quality" : "CREATE_SUCCESS",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_FAILED",
        "standard_count" : null,
        "alias" : null,
        "api_id" : "0",
        "workspace_id" : null,
        "workspace_name" : null,
        "dev_version" : null,
        "prod_version" : null,
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE"
      }, {
        "id" : "1229812609512062976",
        "name" : "test_czh_sl_003",
        "tb_logic_guid" : "86ddea4c-0dda-4a7e-8ca1-a3ddce64ad97",
        "quality_id" : null,
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "test_czh_sl_003",
        "create_by" : "ei_dayu_y00321344_01",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "PUBLISHED",
        "biz_type" : "TABLE_MODEL",
        "create_time" : "2024-04-16T15:16:15+08:00",
        "update_time" : "2024-04-17T17:07:55+08:00",
        "db_name" : null,
        "dw_type" : "UNSPECIFIED",
        "queue_name" : null,
        "schema" : null,
        "l1" : "test_czh2",
        "l2" : null,
        "l3" : null,
        "l1_id" : "1170064724101115904",
        "l2_id" : null,
        "l3_id" : null,
        "new_biz" : null,
        "physical_table" : "NO_NEED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "NO_NEED",
        "business_asset" : "CREATE_SUCCESS",
        "meta_data_link" : "NO_NEED",
        "data_quality" : "CREATE_FAILED",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_SUCCESS",
        "standard_count" : null,
        "alias" : null,
        "api_id" : "0",
        "workspace_id" : null,
        "workspace_name" : null,
        "dev_version" : null,
        "prod_version" : null,
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE"
      }, {
        "id" : "1229812231022243840",
        "name" : "test_czh_sl_002",
        "tb_logic_guid" : "bafa9927-9f2b-4197-b8fa-cc94338b707b",
        "quality_id" : null,
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "test_czh_sl_002",
        "create_by" : "ei_dayu_y00321344_01",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "PUBLISHED",
        "biz_type" : "TABLE_MODEL",
        "create_time" : "2024-04-16T15:14:45+08:00",
        "update_time" : "2024-04-16T15:14:52+08:00",
        "db_name" : null,
        "dw_type" : "UNSPECIFIED",
        "queue_name" : null,
        "schema" : null,
        "l1" : "test_czh2",
        "l2" : null,
        "l3" : null,
        "l1_id" : "1170064724101115904",
        "l2_id" : null,
        "l3_id" : null,
        "new_biz" : null,
        "physical_table" : "NO_NEED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "NO_NEED",
        "business_asset" : "CREATE_SUCCESS",
        "meta_data_link" : "NO_NEED",
        "data_quality" : "NO_NEED",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_SUCCESS",
        "standard_count" : null,
        "alias" : null,
        "api_id" : "0",
        "workspace_id" : null,
        "workspace_name" : null,
        "dev_version" : null,
        "prod_version" : null,
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE"
      }, {
        "id" : "1229805021919621120",
        "name" : "test_czh_sl_001",
        "tb_logic_guid" : "cec6e323-ec00-457a-aaee-9ec931326bc7",
        "quality_id" : null,
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "test_czh_sl_001",
        "create_by" : "ei_dayu_y00321344_01",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "PUBLISHED",
        "biz_type" : "TABLE_MODEL",
        "create_time" : "2024-04-16T14:46:06+08:00",
        "update_time" : "2024-04-16T14:50:34+08:00",
        "db_name" : null,
        "dw_type" : "UNSPECIFIED",
        "queue_name" : null,
        "schema" : null,
        "l1" : "test_czh_catalog",
        "l2" : null,
        "l3" : null,
        "l1_id" : "1194966710038474752",
        "l2_id" : null,
        "l3_id" : null,
        "new_biz" : null,
        "physical_table" : "NO_NEED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "NO_NEED",
        "business_asset" : "CREATE_SUCCESS",
        "meta_data_link" : "NO_NEED",
        "data_quality" : "NO_NEED",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_SUCCESS",
        "standard_count" : null,
        "alias" : null,
        "api_id" : "0",
        "workspace_id" : null,
        "workspace_name" : null,
        "dev_version" : null,
        "prod_version" : null,
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE"
      }, {
        "id" : "1226973789422813184",
        "name" : "test_0408_004",
        "tb_logic_guid" : "40322535-e903-44e1-a0c0-f79573fc09e6",
        "quality_id" : "1227637237613944833",
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "test_0408_004",
        "create_by" : "ei_dayu_y00321344_01",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "PUBLISHED",
        "biz_type" : "TABLE_MODEL",
        "create_time" : "2024-04-08T19:15:47+08:00",
        "update_time" : "2024-04-10T15:12:17+08:00",
        "db_name" : null,
        "dw_type" : "DWS",
        "queue_name" : null,
        "schema" : null,
        "l1" : "Email Title",
        "l2" : null,
        "l3" : null,
        "l1_id" : "1170064658061799424",
        "l2_id" : null,
        "l3_id" : null,
        "new_biz" : null,
        "physical_table" : "CREATE_FAILED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "CREATE_FAILED",
        "business_asset" : "CREATE_SUCCESS",
        "meta_data_link" : "UPDATE_FAILED",
        "data_quality" : "CREATE_SUCCESS",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_FAILED",
        "standard_count" : null,
        "alias" : null,
        "api_id" : "0",
        "workspace_id" : null,
        "workspace_name" : null,
        "dev_version" : null,
        "prod_version" : null,
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE"
      }, {
        "id" : "1226973648695504896",
        "name" : "test_0408_003",
        "tb_logic_guid" : "d6b610a5-de9f-43f6-b3ef-aa4bc23ae766",
        "quality_id" : null,
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "test_0408_003",
        "create_by" : "ei_dayu_y00321344_01",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "PUBLISHED",
        "biz_type" : "TABLE_MODEL",
        "create_time" : "2024-04-08T19:15:14+08:00",
        "update_time" : "2024-04-08T19:18:36+08:00",
        "db_name" : null,
        "dw_type" : "DWS",
        "queue_name" : null,
        "schema" : null,
        "l1" : "My Tests",
        "l2" : null,
        "l3" : null,
        "l1_id" : "1178033294286176256",
        "l2_id" : null,
        "l3_id" : null,
        "new_biz" : null,
        "physical_table" : "CREATE_FAILED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "CREATE_FAILED",
        "business_asset" : "UPDATE_SUCCESS",
        "meta_data_link" : "UPDATE_FAILED",
        "data_quality" : "NO_NEED",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_FAILED",
        "standard_count" : null,
        "alias" : null,
        "api_id" : "0",
        "workspace_id" : null,
        "workspace_name" : null,
        "dev_version" : null,
        "prod_version" : null,
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE"
      }, {
        "id" : "1226923543347003392",
        "name" : "test_0408_002",
        "tb_logic_guid" : "b11128db-ba65-40b6-99a5-6103106fac79",
        "quality_id" : null,
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "test_0408_002",
        "create_by" : "ei_dayu_y00321344_01",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "PUBLISHED",
        "biz_type" : "TABLE_MODEL",
        "create_time" : "2024-04-08T15:56:08+08:00",
        "update_time" : "2024-04-08T19:14:09+08:00",
        "db_name" : null,
        "dw_type" : "DWS",
        "queue_name" : null,
        "schema" : null,
        "l1" : "test_czh2",
        "l2" : null,
        "l3" : null,
        "l1_id" : "1170064724101115904",
        "l2_id" : null,
        "l3_id" : null,
        "new_biz" : null,
        "physical_table" : "CREATE_FAILED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "CREATE_FAILED",
        "business_asset" : "UPDATE_SUCCESS",
        "meta_data_link" : "UPDATE_FAILED",
        "data_quality" : "NO_NEED",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_FAILED",
        "standard_count" : null,
        "alias" : null,
        "api_id" : "0",
        "workspace_id" : null,
        "workspace_name" : null,
        "dev_version" : null,
        "prod_version" : null,
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE"
      }, {
        "id" : "1226923406239399936",
        "name" : "test_0408",
        "tb_logic_guid" : "",
        "quality_id" : null,
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "test_0408",
        "create_by" : "ei_dayu_y00321344_01",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "DRAFT",
        "biz_type" : "TABLE_MODEL",
        "create_time" : "2024-04-08T15:55:35+08:00",
        "update_time" : "2024-04-19T17:22:02+08:00",
        "db_name" : null,
        "dw_type" : "DWS",
        "queue_name" : null,
        "schema" : null,
        "l1" : "test_import",
        "l2" : null,
        "l3" : null,
        "l1_id" : "1193142949320474624",
        "l2_id" : null,
        "l3_id" : null,
        "new_biz" : null,
        "physical_table" : "CREATE_FAILED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "CREATE_FAILED",
        "business_asset" : "CREATE_SUCCESS",
        "meta_data_link" : "UPDATE_FAILED",
        "data_quality" : "NO_NEED",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_FAILED",
        "standard_count" : null,
        "alias" : null,
        "api_id" : "0",
        "workspace_id" : null,
        "workspace_name" : null,
        "dev_version" : null,
        "prod_version" : null,
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE"
      }, {
        "id" : "1222930979413499904",
        "name" : "test_czh_0328",
        "tb_logic_guid" : "712edcdd-3bba-4077-b182-4a1f17e5bcd8",
        "quality_id" : null,
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "dim_test_czh_0328",
        "create_by" : "ei_dayu_y00321344_01",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "PUBLISHED",
        "biz_type" : "DIMENSION_LOGIC_TABLE",
        "create_time" : "2024-03-28T15:31:06+08:00",
        "update_time" : "2024-03-28T15:31:10+08:00",
        "db_name" : "bi",
        "dw_type" : "DLI",
        "queue_name" : null,
        "schema" : null,
        "l1" : "test_czh_catalog",
        "l2" : null,
        "l3" : null,
        "l1_id" : "1194966710038474752",
        "l2_id" : null,
        "l3_id" : null,
        "new_biz" : null,
        "physical_table" : "CREATE_FAILED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "CREATE_FAILED",
        "business_asset" : "CREATE_SUCCESS",
        "meta_data_link" : "UPDATE_FAILED",
        "data_quality" : "NO_NEED",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_FAILED",
        "standard_count" : null,
        "alias" : "",
        "api_id" : "0",
        "workspace_id" : null,
        "workspace_name" : null,
        "dev_version" : null,
        "prod_version" : null,
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE"
      }, {
        "id" : "1222853173564289024",
        "name" : "test_czh_0328",
        "tb_logic_guid" : "",
        "quality_id" : null,
        "reversed" : null,
        "partition_conf" : null,
        "dirty_out_switch" : false,
        "dirty_out_database" : "",
        "dirty_out_prefix" : "",
        "dirty_out_suffix" : "",
        "tb_guid" : null,
        "code" : "test_czh_0328",
        "create_by" : "ei_dayu_y00321344_01",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "description" : "None",
        "status" : "OFFLINE",
        "biz_type" : "TABLE_MODEL",
        "create_time" : "2024-03-28T10:21:56+08:00",
        "update_time" : "2024-04-19T17:55:50+08:00",
        "db_name" : "bi",
        "dw_type" : "DLI",
        "queue_name" : null,
        "schema" : null,
        "l1" : "test_czh_catalog",
        "l2" : null,
        "l3" : null,
        "l1_id" : "1194966710038474752",
        "l2_id" : null,
        "l3_id" : null,
        "new_biz" : null,
        "physical_table" : "CREATE_FAILED",
        "dev_physical_table" : "NO_NEED",
        "technical_asset" : "CREATE_FAILED",
        "business_asset" : "CREATE_SUCCESS",
        "meta_data_link" : "UPDATE_FAILED",
        "data_quality" : "NO_NEED",
        "dlf_task" : "NO_NEED",
        "materialization" : null,
        "publish_to_dlm" : null,
        "summary_status" : "SUMMARY_FAILED",
        "standard_count" : null,
        "alias" : null,
        "api_id" : "0",
        "workspace_id" : null,
        "workspace_name" : null,
        "dev_version" : null,
        "prod_version" : null,
        "dev_version_name" : null,
        "prod_version_name" : null,
        "env_type" : "PROD_TYPE"
      } ]
    }
  }
}

Status code: 400

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

Status code: 401

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

Status code: 403

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;


public class ListAllTablesSolution {

    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);

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAllTablesRequest request = new ListAllTablesRequest();
        try {
            ListAllTablesResponse response = client.listAllTables(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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 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 = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAllTablesRequest()
        response = client.list_all_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)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/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 := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

This operation succeeds, and the returned data is an AllTableVO list.

400

BadRequest

401

Unauthorized

403

Forbidden