Searching for a Fact Table
Function
Search for fact table information by Chinese and English names, creator, reviewer, status, and modification time.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/design/fact-logic-tables
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Fuzzy query by name or code. |
create_by |
No |
String |
Query by creator. |
approver |
No |
String |
Query by reviewer. |
owner |
No |
String |
Query by owner. |
status |
No |
String |
Specifies the service status. Options:
|
sync_status |
No |
String |
Defines the enumeration of the synchronization status. Options:
|
sync_key |
No |
Array of strings |
Defines the enumeration of synchronization task types. Options:
|
l3_id |
No |
String |
ID of business object l3, which is a string |
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 |
No |
String |
ID of the service catalog to which the belongs. |
Request 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
Parameter |
Type |
Description |
---|---|---|
data |
data object |
data: unified outermost data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
value |
value object |
value: unified outer data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number. |
records |
Array of FactLogicTableVO objects |
FactLogicTableVO information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Fact table ID, which is a string |
tb_name |
String |
Specifies the name of the table. |
tb_logic_name |
String |
Name of a logical entity. |
l1_id |
String |
Subject area group ID, which is a read-only string |
l2_id |
String |
Subject area ID. |
l3_id |
String |
Business object GUID, which is a string |
description |
String |
Description. |
dw_name |
String |
Data connection name. This parameter is read-only and does not need to be set when you create or update a data connection. |
owner |
String |
Asset owner. |
create_by |
String |
Creator. |
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. |
dw_id |
String |
Data connection ID. |
db_name |
String |
Database name. |
tb_id |
String |
Data table ID. This parameter is read-only. |
dim_table_ids |
Array of strings |
ID of the associated dimension table. |
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. |
schema |
String |
Required by the DWS type. |
distribute |
String |
DISTRIBUTE BY [HASH(column)|REPLICATION]. Options:
|
distribute_column |
String |
DISTRIBUTE BY HASH column. |
table_type |
String |
Table type |
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
tb_guid |
String |
GUID of the created data catalog technology asset after the table is released. This parameter is read-only and does not need to be set during creation and update. |
tb_logic_guid |
String |
GUID of the created data catalog service asset after the table is released. This parameter is read-only and does not need to be set during creation and update. |
dw_type |
String |
Data connection type, which corresponds to the type of the data warehouse where the table is located. The value can be DWS, MRS_HIVE, POSTGRESQL, MRS_SPARK, CLICKHOUSE, MYSQL, ORACLE, or DORIS. |
l1 |
String |
Chinese name of the subject area group. This parameter is read-only and does not need to be set when you create or update a subject area group. |
l2 |
String |
Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update. |
l3 |
String |
Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update. |
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. |
approval_info |
ApprovalVO object |
Approval information. This parameter is read-only. Latest review information about a business object, including the business details, reviewer information, and review time. |
new_biz |
BizVersionManageVO object |
Service version management. This parameter is read-only. |
dimensions |
Array of FactTableAttributeVO objects |
Fact table dimension information, which is read-only. |
attributes |
Array of FactTableAttributeVO objects |
Fact attribute information of the fact table, which is read-only. |
mappings |
Array of TableMappingVO objects |
Table mapping information. |
measures |
Array of FactTableAttributeVO objects |
Fact table measurement information, which is read-only. |
table_attributes |
Array of FactTableAttributeVO objects |
Indicates all attributes of a fact table. |
configs |
String |
Other Configurations |
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. |
summary_status |
String |
Overall synchronization status. This parameter is read-only. |
quality_id |
String |
Quality ID, which is a string |
alias |
String |
Alias |
self_defined_fields |
Array of SelfDefinedFieldVO objects |
User-defined item. |
obs_location |
String |
Foreign Table Path |
dev_version |
String |
Development environment version, which is a read-only string |
prod_version |
String |
Production environment version, which is a read-only string |
dev_version_name |
String |
Version name of the development environment, which is read-only |
prod_version_name |
String |
Version name of the production environment, which is read-only |
env_type |
String |
Type of the development and production environment. Options:
|
secrecy_levels |
Array of SecrecyLevelVO objects |
Confidentiality |
model_id |
Long |
Model ID |
model |
WorkspaceVO object |
Model information |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
fact_logic_table_id |
String |
Fact table ID, which is a read-only string |
ordinal |
Integer |
Sequence number. |
dimension_id |
String |
Dimension ID, which is a string |
dimension_attr_id |
String |
Dimension attribute ID, which is a string |
role |
String |
Dimension role. |
dimension |
DimensionVO object |
Indicates the dimension information corresponding to dimension_id. This parameter is read-only. |
is_primary_key |
Boolean |
Indicates whether a key is a primary key. |
is_partition_key |
Boolean |
Indicates whether the key is a partition key. |
is_foreign_key |
Boolean |
Indicates whether the key is a foreign key. This parameter is read-only. |
secrecy_levels |
Array of SecrecyLevelRecordVO objects |
Confidentiality |
description |
String |
Description. |
data_type |
String |
Field type |
domain_type |
String |
Domain to which a field type belongs. Options:
|
data_type_extend |
String |
Extended field of the data type. |
name_en |
String |
English name of the user. |
name_ch |
String |
Chinese name. |
not_null |
Boolean |
Indicates whether the value is empty. |
attribute_type |
String |
Attribute field type (FACT_DIMENSION, FACT_ATTRIBUTE, FACT_MEASURE). |
stand_row_id |
String |
ID of the associated data standard, which is a string |
stand_row_name |
String |
Name of the associated data standard. This parameter is read-only. |
quality_infos |
Array of QualityInfoVO objects |
Quality information, which is read-only. |
alias |
String |
Alias |
self_defined_fields |
Array of SelfDefinedFieldVO objects |
User-defined item. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID string (It is read-only for creation and mandatory for update.) |
name_en |
String |
Dimension name in English |
dimension_type |
String |
Dimension type (The dimension type can be changed from a common dimension to a hierarchical dimension during an update, and cannot be changed in other scenarios.) Enumerated values:
|
name_ch |
String |
Dimension name |
description |
String |
Description. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
code_table_id |
String |
Referenced lookup table ID (mandatory for creating or updating a lookup table dimension). The value is a string. |
code_table |
CodeTableVO object |
Reference lookup table, which is read-only. |
l1_id |
String |
Subject area group ID, which is a read-only string |
l2_id |
String |
Subject area ID. |
l3_id |
String |
Business object ID, which is a string |
hierarchies |
Array of DimensionHierarchiesVO objects |
Level attribute. |
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
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. |
approval_info |
ApprovalVO object |
Approval information. This parameter is read-only. Latest review information about a business object, including the business details, reviewer information, and review time. |
new_biz |
BizVersionManageVO object |
Service version management. This parameter is read-only. |
l1 |
String |
Chinese name of the subject area group. This parameter is read-only and does not need to be set when you create or update a subject area group. |
l2 |
String |
Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update. |
l3 |
String |
Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update. |
attributes |
Array of DimensionAttributeVO objects |
Dimension attribute information. |
mappings |
Array of TableMappingVO objects |
Table mapping information. |
datasource |
BizDatasourceRelationVO object |
Data source information, which is mandatory for creation or update |
owner |
String |
Asset owner, which is mandatory for creating or updating an asset |
obs_location |
String |
Foreign Table Path |
table_type |
String |
Table type |
distribute |
String |
DISTRIBUTE BY [HASH(column)|REPLICATION]. Options:
|
distribute_column |
String |
DISTRIBUTE BY HASH column. |
alias |
String |
Alias |
self_defined_fields |
Array of SelfDefinedFieldVO objects |
User-defined item. |
configs |
String |
Other Configurations |
dev_version |
String |
Development environment version, which is a read-only string |
prod_version |
String |
Production environment version, which is a read-only string |
dev_version_name |
String |
Version name of the development environment, which is read-only |
prod_version_name |
String |
Version name of the production environment, which is read-only |
env_type |
String |
Type of the development and production environment. Options:
|
model_id |
String |
Model ID |
model |
WorkspaceVO object |
Model information |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Lookup table ID, which is a string |
name_en |
String |
Table name, in English. |
name_ch |
String |
Table name, in Chinese. |
tb_version |
Integer |
Table version. |
directory_id |
String |
Directory ID, which is a string |
directory_path |
String |
Directory tree. |
description |
String |
Description. |
create_by |
String |
Creator. |
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
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. |
approval_info |
ApprovalVO object |
Approval information. This parameter is read-only. Latest review information about a business object, including the business details, reviewer information, and review time. |
new_biz |
BizVersionManageVO object |
Service version management. This parameter is read-only. |
code_table_fields |
Array of CodeTableFieldVO objects |
Code list attribute information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Lookup table field ID, which is a string |
code_table_id |
String |
ID of the lookup table (mandatory for update), which is a string |
ordinal |
Integer |
Sequence number. |
name_en |
String |
Field name, in English. |
name_ch |
String |
Field name, in Chinese. |
description |
String |
Description. |
data_type |
String |
Field type |
domain_type |
String |
Domain to which a field type belongs. Options:
|
data_type_extend |
String |
Extended field of the data type. |
is_unique_key |
Boolean |
Whether the field is unique. |
code_table_field_values |
Array of CodeTableFieldValueVO objects |
Code list attribute value. |
count_field_values |
Integer |
Total number of lookup table attribute values. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Lookup table field ID, which is a string |
fd_id |
String |
Attribute ID of the lookup table, which is a string |
fd_value |
String |
Code list attribute value. |
ordinal |
Integer |
Sequence number. |
description |
String |
Description. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
name |
String |
Level name. |
attrs |
Array of HierarchiesAttrVO objects |
Attributes contained in a hierarchy. |
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. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
hierarchies_id |
String |
Level ID, which is a string |
attr_id |
String |
Attribute ID, which is a string |
level |
Integer |
Indicates the layer. |
attr_name_en |
String |
Referenced attribute code. |
attr_name_ch |
String |
Referenced attribute name, which is read-only. |
detail_attr_ids |
Array of strings |
Details attribute ID, which is a string |
detail_attr_name_ens |
Array of strings |
Details attribute in English. |
detail_attr_name_chs |
Array of strings |
Details attribute in Chinese, which is read-only. |
attr |
DimensionAttributeVO object |
Referenced attribute field, which is read-only. |
detail_attrs |
Array of DimensionAttributeVO objects |
Details field, which is read-only. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
dimension_id |
String |
Dimension ID, which is a read-only string |
code_table_field_id |
String |
Lookup table attribute ID, which is a string |
name_en |
String |
Field name. |
name_ch |
String |
Service attribute. |
description |
String |
Description. |
create_by |
String |
Creator. |
data_type |
String |
Field type |
domain_type |
String |
Domain to which a field type belongs. Options:
|
data_type_extend |
String |
Extended field of the data type. |
is_primary_key |
Boolean |
Indicates whether a key is a primary key. |
is_biz_primary |
Boolean |
Indicates whether it is a service primary key. |
is_partition_key |
Boolean |
Indicates whether to partition. |
ordinal |
Integer |
Sequence number. |
not_null |
Boolean |
Indicates whether the value is empty. |
stand_row_id |
String |
ID of the associated data standard, which is a string |
stand_row_name |
String |
Name of the associated data standard. This parameter is read-only. |
quality_infos |
Array of QualityInfoVO objects |
Quality information, which is read-only. |
secrecy_levels |
Array of SecrecyLevelVO objects |
Confidentiality |
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
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. |
alias |
String |
Alias |
self_defined_fields |
Array of SelfDefinedFieldVO objects |
User-defined item. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Application ID, which is a string |
tenant_id |
String |
Project ID. For details about how to obtain the project ID, see the API path parameter project_id. |
name_ch |
String |
Chinese name of a service. |
name_en |
String |
English name of a service. |
biz_id |
String |
Business ID, which is a string |
biz_type |
String |
Business entity type. Options:
|
biz_info |
String |
Serialized service details. The type is string. |
biz_info_obj |
Object |
Service details. The type is object. |
biz_version |
Integer |
Service version. |
biz_status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
approval_status |
String |
Service approval status. This parameter is read-only. Options:
|
approval_type |
String |
Service review type. Options:
|
submit_time |
String |
Submitted At |
create_by |
String |
Creator. |
l1 |
String |
Chinese name of the subject area group. This parameter is read-only and does not need to be set when you create or update a subject area group. |
l2 |
String |
Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update. |
l3 |
String |
Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update. |
approval_time |
String |
Review time. |
approver |
String |
Reviewer. |
|
String |
Email address of the reviewer. |
msg |
String |
Review information. |
directory_path |
String |
Directory tree. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
name |
String |
Name. |
description |
String |
Description. |
target_table_id |
String |
Destination table ID, which is a string |
src_model_id |
String |
ID of the relational model for the source table. The value is a string. |
src_model_name |
String |
Source model name. |
view_text |
String |
Source of the collected view. The dws view is used reversely. |
target_table_name |
String |
Name of the destination table. |
details |
Array of TableMappingDetailVO objects |
Details. |
source_tables |
Array of MappingSourceTableVO objects |
Mapped table information. |
source_fields |
Array of MappingSourceFieldVO objects |
Mapped field information. |
create_time |
String |
Creation time. 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. 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. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
mapping_id |
String |
Name. |
target_attr_id |
String |
ID of the destination attribute, which is a string |
target_attr_name |
String |
Sort by destination field. |
src_table_ids |
String |
Source table ID. |
src_table_names |
Array of strings |
Source table name array, which is read-only. |
src_table_db_names |
Array of strings |
Database name array of the source table. This parameter is read-only. |
src_table_model_ids |
Array of strings |
IDs of the relational models for the source tables. The value is a read-only string. |
src_table_id_list |
Array of strings |
IDs of source tables. The value is a read-only string. |
src_attr_ids |
String |
ID of a field in the source table. |
src_attr_names |
Array of strings |
Array of field names in the source table. This parameter is read-only. |
src_attr_id_list |
Array of strings |
IDs of the source table attributes. The value is a read-only string. |
remark |
String |
Description. |
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. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
target_attr |
Object |
Target attribute. |
Parameter |
Type |
Description |
---|---|---|
table1_id |
String |
Table 1 ID, which is a string |
table2_id |
String |
Table 2 ID, which is a string |
table1_name |
String |
Name of table 1. |
table2_name |
String |
Name of table 2. |
join_type |
String |
Association type. Options:
|
join_fields |
Array of MappingJoinFieldVO objects |
on condition. |
Parameter |
Type |
Description |
---|---|---|
field1_id |
String |
Attribute 1 ID, which is a string |
field2_id |
String |
Attribute 2 ID, which is a string |
field1_name |
String |
Name of attribute 1. |
field2_name |
String |
Name of attribute 2. |
Parameter |
Type |
Description |
---|---|---|
target_field_id |
String |
ID of the target field, which is a field in the current table. The ID is a string. |
target_field_name |
String |
Target field code. |
field_ids |
String |
Source field ID. Use commas (,) to separate multiple IDs. |
transform_expression |
String |
Conversion expression. |
field_names |
Array of strings |
List of source field names. |
changed |
Boolean |
Indicates whether a field is changed. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
biz_id |
String |
Business object information, which is a string |
biz_type |
String |
Service object type. |
dw_type |
String |
Data connection type, which corresponds to the type of the data warehouse where the table is located. The value can be DWS, MRS_HIVE, POSTGRESQL, MRS_SPARK, CLICKHOUSE, MYSQL, ORACLE, or DORIS. |
dw_id |
String |
Data connection ID. |
dw_name |
String |
Data connection name, which is read-only. |
db_name |
String |
Indicates the database name. |
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. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID of the security level associated with the attribute. The ID is a string. |
secrecyLevel_id |
String |
Security level ID, which is a string |
secrecyLevel_name |
String |
Security level name. |
uuid |
String |
Data security primary key. |
slevel |
Integer |
Confidentiality level. |
description |
String |
Confidentiality description. |
biz_id |
String |
Business object ID, which is a string |
biz_type |
String |
Business entity type. Options:
|
create_by |
String |
Creator. |
update_by |
String |
Updater. |
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. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
table_id |
String |
Table ID, which is a read-only string |
attr_id |
String |
Attribute ID, which is a read-only string |
biz_type |
String |
Business entity type. Options:
|
data_quality_id |
String |
Quality ID, which is a string |
show_control |
Integer |
Indicates whether to display the regular expression. |
data_quality_name |
String |
Quality name. |
alert_conf |
String |
Configure alarms. |
expression |
String |
Regular expression configuration in regular expression-related validation rules. |
extend_info |
String |
Indicates the extension information. |
from_standard |
Boolean |
Indicates whether the data comes from the data standard quality configuration. This parameter is read-only. |
result_description |
String |
Result description. |
create_by |
String |
Creator, which is read-only. |
update_by |
String |
Updater, 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. |
Parameter |
Type |
Description |
---|---|---|
fd_name_ch |
String |
Chinese name of a user-defined item. |
fd_name_en |
String |
English name of a customized item. |
not_null |
Boolean |
Whether a parameter is mandatory. |
fd_value |
String |
Attribute value |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Security level ID, which is a string |
uuid |
String |
Data security primary key. |
name |
String |
Confidentiality name. |
slevel |
Integer |
Confidentiality level. |
description |
String |
Confidentiality description. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
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. |
new_biz |
BizVersionManageVO object |
Service version management. This parameter is read-only. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Field ID, which is a string |
biz_type |
String |
Business entity type. Options:
|
biz_id |
String |
Business ID, which is a string |
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:
|
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. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
name |
String |
Name of the workspace. |
description |
String |
Description. |
is_physical |
Boolean |
Indicates whether a table is a physical table. |
frequent |
Boolean |
Indicates whether it is commonly used. |
top |
Boolean |
Hierarchical governance. |
level |
String |
Data governance layers. Options:
|
dw_type |
String |
Data connection type, which corresponds to the type of the data warehouse where the table is located. The value can be DWS, MRS_HIVE, POSTGRESQL, MRS_SPARK, CLICKHOUSE, MYSQL, ORACLE, or DORIS. |
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. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
type |
String |
Defines the workspace type enumeration. Options:
|
biz_catalog_ids |
String |
{"l1Ids":[],"l2Ids":[],"l3Ids":[]}: ID list of associated service catalogs. |
databases |
Array of strings |
Array of database names. |
table_model_prefix |
String |
Model verification prefix. The value contains a maximum of 100 characters, including digits, letters, and underscores (_), and starts with a letter. |
Status code: 400
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
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
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
This API is used to obtain the fact table list based on search criteria.
GET https://{endpoint}/v2/{project_id}/design/fact-logic-tables?offset=1&limit=10&name=fact_test_czh_0305_003
Example Responses
Status code: 200
This operation succeeds, and the returned data is a FactLogicTableVO array and the total number of records.
{ "data" : { "value" : { "total" : 1, "records" : [ { "id" : "1214584210761940992", "tb_name" : "fact_test_czh_0305_003", "tb_logic_name" : "test_czh_0305_003", "l1_id" : "1194966710038474752", "l2_id" : null, "l3_id" : null, "description" : "N/A", "dw_name" : null, "owner" : "aaa", "create_by" : "test_uesr", "queue_name" : "default", "dw_id" : "8259af52bd294f98920ebce75a426391", "db_name" : "bi", "tb_id" : "NativeTable-8259af52bd294f98920ebce75a426391-bi-fact_test_czh_0305_003", "dim_table_ids" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "schema" : "", "distribute" : null, "distribute_column" : null, "obs_location" : null, "table_type" : "MANAGED", "status" : "PUBLISHED", "tb_guid" : null, "tb_logic_guid" : "5417940a-0d1d-4fea-9b6f-65637da15112", "dw_type" : "DWS", "l1" : "test_czh_catalog", "l2" : null, "l3" : null, "create_time" : "2024-03-05T14:44:02+08:00", "update_time" : "2024-03-05T15:35:48+08:00", "approval_info" : { "id" : "1214597210327646208", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "1214584210761940992", "biz_type" : null, "biz_info" : null, "biz_info_obj" : null, "biz_version" : 0, "biz_status" : "PUBLISHED", "approval_status" : "APPROVED", "approval_type" : null, "submit_time" : "2024-03-05T15:35:41+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2024-03-05T15:35:41+08:00", "approver" : "test_uesr", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "dimensions" : null, "attributes" : null, "mappings" : null, "measures" : [ { "id" : "1214584210866798592", "fact_logic_table_id" : "1214584210761940992", "ordinal" : 1, "dimension_id" : null, "role" : null, "dimension" : null, "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : null, "secrecy_levels" : [ ], "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : "", "name_en" : "aaa", "name_ch" : "aaa", "not_null" : false, "attribute_type" : "FACT_MEASURE", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "aa", "fd_name_en" : "aa", "not_null" : false, "fd_value" : null }, { "fd_name_ch" : "bb", "fd_name_en" : "bb", "not_null" : false, "fd_value" : null } ] }, { "id" : "1214584210866798593", "fact_logic_table_id" : "1214584210761940992", "ordinal" : 2, "dimension_id" : null, "role" : null, "dimension" : null, "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : null, "secrecy_levels" : [ { "id" : "187", "secrecyLevel_id" : "1199020797063208960", "secrecyLevel_name" : "Confidentiality", "uuid" : "8a9481ba8c202835018c237ae6540007", "slevel" : 5, "description" : "Promise me, don't say it to anyone.", "biz_id" : "1214584210866798593", "biz_type" : "FACT_LOGIC_TABLE", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-03-05T15:35:41+08:00", "update_time" : "2024-03-05T15:35:41+08:00" } ], "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : "", "name_en" : "bbb", "name_ch" : "bbb", "not_null" : false, "attribute_type" : "FACT_MEASURE", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "aa", "fd_name_en" : "aa", "not_null" : false, "fd_value" : null }, { "fd_name_ch" : "bb", "fd_name_en" : "bb", "not_null" : false, "fd_value" : null } ] }, { "id" : "1214584210866798594", "fact_logic_table_id" : "1214584210761940992", "ordinal" : 3, "dimension_id" : null, "role" : null, "dimension" : null, "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : null, "secrecy_levels" : [ { "id" : "186", "secrecyLevel_id" : "1199020797063208960", "secrecyLevel_name" : "Confidentiality", "uuid" : "8a9481ba8c202835018c237ae6540007", "slevel" : 5, "description" : "Promise me, don't say it to anyone.", "biz_id" : "1214584210866798594", "biz_type" : "FACT_LOGIC_TABLE", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-03-05T15:35:41+08:00", "update_time" : "2024-03-05T15:35:41+08:00" } ], "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : "", "name_en" : "ccc", "name_ch" : "ccc", "not_null" : false, "attribute_type" : "FACT_MEASURE", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "aa", "fd_name_en" : "aa", "not_null" : false, "fd_value" : null }, { "fd_name_ch" : "bb", "fd_name_en" : "bb", "not_null" : false, "fd_value" : null } ] } ], "table_attributes" : [ { "id" : "1214584210866798592", "fact_logic_table_id" : "1214584210761940992", "ordinal" : 1, "dimension_id" : null, "role" : null, "dimension" : null, "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : null, "secrecy_levels" : [ { "id" : "188", "secrecyLevel_id" : "1199020797063208960", "secrecyLevel_name" : "Confidentiality", "uuid" : "8a9481ba8c202835018c237ae6540007", "slevel" : 5, "description" : "Promise me, don't say it to anyone.", "biz_id" : "1214584210866798592", "biz_type" : "FACT_LOGIC_TABLE", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-03-05T15:35:41+08:00", "update_time" : "2024-03-05T15:35:41+08:00" } ], "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : "", "name_en" : "aaa", "name_ch" : "aaa", "not_null" : false, "attribute_type" : "FACT_MEASURE", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "aa", "fd_name_en" : "aa", "not_null" : false, "fd_value" : null }, { "fd_name_ch" : "bb", "fd_name_en" : "bb", "not_null" : false, "fd_value" : null } ] }, { "id" : "1214584210866798593", "fact_logic_table_id" : "1214584210761940992", "ordinal" : 2, "dimension_id" : null, "role" : null, "dimension" : null, "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : null, "secrecy_levels" : [ { "id" : "187", "secrecyLevel_id" : "1199020797063208960", "secrecyLevel_name" : "Confidentiality", "uuid" : "8a9481ba8c202835018c237ae6540007", "slevel" : 5, "description" : "Promise me, don't say it to anyone.", "biz_id" : "1214584210866798593", "biz_type" : "FACT_LOGIC_TABLE", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-03-05T15:35:41+08:00", "update_time" : "2024-03-05T15:35:41+08:00" } ], "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : "", "name_en" : "bbb", "name_ch" : "bbb", "not_null" : false, "attribute_type" : "FACT_MEASURE", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "aa", "fd_name_en" : "aa", "not_null" : false, "fd_value" : null }, { "fd_name_ch" : "bb", "fd_name_en" : "bb", "not_null" : false, "fd_value" : null } ] }, { "id" : "1214584210866798594", "fact_logic_table_id" : "1214584210761940992", "ordinal" : 3, "dimension_id" : null, "role" : null, "dimension" : null, "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : null, "secrecy_levels" : [ { "id" : "186", "secrecyLevel_id" : "1199020797063208960", "secrecyLevel_name" : "Confidentiality", "uuid" : "8a9481ba8c202835018c237ae6540007", "slevel" : 5, "description" : "Promise me, don't say it to anyone.", "biz_id" : "1214584210866798594", "biz_type" : "FACT_LOGIC_TABLE", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-03-05T15:35:41+08:00", "update_time" : "2024-03-05T15:35:41+08:00" } ], "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : "", "name_en" : "ccc", "name_ch" : "ccc", "not_null" : false, "attribute_type" : "FACT_MEASURE", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "aa", "fd_name_en" : "aa", "not_null" : false, "fd_value" : null }, { "fd_name_ch" : "bb", "fd_name_en" : "bb", "not_null" : false, "fd_value" : null } ] } ], "physical_table" : "UPDATE_SUCCESS", "dev_physical_table" : "NO_NEED", "technical_asset" : "CREATE_FAILED", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "NO_NEED", "summary_status" : "SUMMARY_FAILED", "quality_id" : null, "alias" : "", "configs" : "{}", "self_defined_fields" : [ { "fd_name_ch" : "User-defined item 1", "fd_name_en" : "selfDefine1", "not_null" : false, "fd_value" : "" }, { "fd_name_ch" : "User-defined item 2", "fd_name_en" : "selfDefine2", "not_null" : true, "fd_value" : "aaa" } ], "dev_version" : null, "prod_version" : "1214597212252831744", "dev_version_name" : null, "prod_version_name" : "V1.1 [latest]", "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 ListFactLogicTablesSolution { 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(); ListFactLogicTablesRequest request = new ListFactLogicTablesRequest(); try { ListFactLogicTablesResponse response = client.listFactLogicTables(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 = ListFactLogicTablesRequest() response = client.list_fact_logic_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.ListFactLogicTablesRequest{} response, err := client.ListFactLogicTables(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 a FactLogicTableVO array and the total number of records. |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot