Creating Summary Tables
Function
Manually create a summary table based on the input parameters.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/design/aggregation-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. |
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Unique system ID of the summary table, which is a string. This parameter is mandatory when you update an SDR table and is not required when you create an SDR table. |
tb_name |
Yes |
String |
Specifies the English name of the SDR table, which corresponds to the actual physical table name. |
tb_logic_name |
Yes |
String |
Chinese name of the summary table, which is used for display. |
l2_id |
No |
String |
Subject area ID. This parameter is read-only and does not need to be set during creation and update. |
l3_id |
Yes |
String |
ID of the subject to which the summary table belongs, which is a string. This parameter is mandatory. |
description |
No |
String |
Description of the summary table. |
owner |
Yes |
String |
Asset owner of the summary table. |
secret_type |
No |
String |
Confidentiality type. Options:
|
apply_bg |
No |
String |
Applicable to bg. |
queue_name |
No |
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 |
Yes |
String |
ID of the data connection where the SDR table is located. The value is a 32-digit hexadecimal number. |
db_name |
Yes |
String |
Name of the database where the summary table is located. |
schema |
No |
String |
Specifies the name of the schema where the SDR table is located. This parameter is mandatory for DWS. |
dw_name |
No |
String |
Data connection name. This parameter is read-only and does not need to be set when you create or update a data connection. |
status |
No |
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 |
No |
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 |
No |
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 |
Yes |
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 |
No |
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 |
No |
String |
Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update. |
l3 |
No |
String |
Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update. |
approval_info |
No |
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 |
No |
BizVersionManageVO object |
Service version management. This parameter is read-only. |
dimension_group |
No |
String |
Granularity ID. |
time_period |
No |
Time period attribute information of the summary table. |
|
table_attributes |
No |
Array of AggregationLogicTableAttributeVO objects |
Attribute information of the summary table. The type is determined based on attribute_type. |
distribute |
No |
String |
DISTRIBUTE BY [HASH(column)|REPLICATION]. Options:
|
distribute_column |
No |
String |
DISTRIBUTE BY HASH column. |
compression |
No |
String |
DWS data compression level. The column compression level is no/low/middle/high, and the row compression level is no/yes. Options:
|
obs_location |
No |
String |
Path of the foreign table. |
pre_combine_field |
No |
String |
Version field. |
table_type |
No |
String |
Table type |
dlf_task_id |
No |
String |
ID of a DLF job. |
quality_id |
No |
String |
Quality ID, which is a string |
partition_conf |
No |
String |
Partition expression. |
dirty_out_switch |
No |
Boolean |
Indicates whether to output abnormal data. |
dirty_out_database |
No |
String |
Abnormal data output library. |
dirty_out_prefix |
No |
String |
Prefix of an exception table. |
dirty_out_suffix |
No |
String |
Suffix of an exception table. |
alias |
No |
String |
Alias |
configs |
No |
String |
Other configurations. |
self_defined_fields |
No |
Array of SelfDefinedFieldVO objects |
User-defined item. |
api_id |
No |
String |
API ID |
sql |
No |
String |
SQL statement bound to the SDR table. |
model_id |
No |
Long |
Model ID |
model |
No |
WorkspaceVO object |
Model information |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Application ID, which is a string |
tenant_id |
No |
String |
Project ID. For details about how to obtain the project ID, see the API path parameter project_id. |
name_ch |
No |
String |
Chinese name of a service. |
name_en |
No |
String |
English name of a service. |
biz_id |
No |
String |
Business ID, which is a string |
biz_type |
No |
String |
Business entity type. Options:
|
biz_info |
No |
String |
Serialized service details. The type is string. |
biz_info_obj |
No |
Object |
Service details. The type is object. |
biz_version |
No |
Integer |
Service version. |
biz_status |
No |
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 |
No |
String |
Service approval status. This parameter is read-only. Options:
|
approval_type |
No |
String |
Service review type. Options:
|
submit_time |
No |
String |
Submitted At |
create_by |
No |
String |
Creator. |
l1 |
No |
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 |
No |
String |
Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update. |
l3 |
No |
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 |
No |
String |
Review time. |
approver |
No |
String |
Reviewer. |
|
No |
String |
Email address of the reviewer. |
msg |
No |
String |
Review information. |
directory_path |
No |
String |
Directory tree. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Field ID, which is a string |
biz_type |
No |
String |
Business entity type. Options:
|
biz_id |
No |
String |
Business ID, which is a string |
biz_info |
No |
String |
Business object information. |
status |
No |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
ID, which is a string |
aggregation_logic_table_id |
No |
String |
ID of the summary table, which is a string |
ordinal |
No |
Integer |
Sequence number. |
name_en |
Yes |
String |
Field name. |
name_ch |
Yes |
String |
Service attribute. |
attribute_type |
No |
String |
Business entity type. Options:
|
is_primary_key |
Yes |
Boolean |
Indicates whether a key is a primary key. |
is_partition_key |
Yes |
Boolean |
Indicates whether the key is a partition key. |
not_null |
No |
Boolean |
Indicates whether the value is empty. |
description |
No |
String |
Description. |
data_type |
Yes |
String |
Field type |
data_type_extend |
No |
String |
Extended field of the data type. |
ref_id |
No |
String |
ID of the object associated with the attribute. |
stand_row_id |
No |
String |
ID of the associated data standard, which is a string |
alias |
No |
String |
Alias |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
fd_name_ch |
No |
String |
Chinese name of a user-defined item. |
fd_name_en |
No |
String |
English name of a customized item. |
not_null |
No |
Boolean |
Whether a parameter is mandatory. |
fd_value |
No |
String |
Attribute value |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
ID, which is a string |
name |
Yes |
String |
Name of the workspace. |
description |
No |
String |
Description. |
is_physical |
No |
Boolean |
Indicates whether a table is a physical table. |
frequent |
No |
Boolean |
Indicates whether it is commonly used. |
top |
No |
Boolean |
Hierarchical governance. |
level |
No |
String |
Data governance layers. Options:
|
dw_type |
No |
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_by |
No |
String |
Creator. |
update_by |
No |
String |
Person who updates the information. |
type |
Yes |
String |
Defines the workspace type enumeration. Options:
|
biz_catalog_ids |
No |
String |
{"l1Ids":[],"l2Ids":[],"l3Ids":[]}: ID list of associated service catalogs. |
databases |
No |
Array of strings |
Array of database names. |
table_model_prefix |
No |
String |
Model verification prefix. The value contains a maximum of 100 characters, including digits, letters, and underscores (_), and starts with a letter. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
Returned data. |
Parameter |
Type |
Description |
---|---|---|
value |
AggregationLogicTableVO object |
Returned data information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Unique system ID of the summary table, which is a string. This parameter is mandatory when you update an SDR table and is not required when you create an SDR table. |
tb_name |
String |
Specifies the English name of the SDR table, which corresponds to the actual physical table name. |
tb_logic_name |
String |
Chinese name of the summary table, which is used for display. |
l1_id |
String |
Subject area group ID, which is a string. This parameter is read-only and does not need to be set during creation and update. |
l2_id |
String |
Subject area ID. This parameter is read-only and does not need to be set during creation and update. |
l3_id |
String |
ID of the subject to which the summary table belongs, which is a string. This parameter is mandatory. |
description |
String |
Description of the summary table. |
owner |
String |
Asset owner of the summary table. |
secret_type |
String |
Confidentiality type. Options:
|
apply_bg |
String |
Applicable to bg. |
create_by |
String |
Creator of the summary table. This parameter is read-only and does not need to be set during creation and update. |
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 |
ID of the data connection where the SDR table is located. The value is a 32-digit hexadecimal number. |
db_name |
String |
Name of the database where the summary table is located. |
tb_id |
String |
Specifies the ID of the table created by the summary table. It is an internal service ID and is read-only. You do not need to set this parameter when creating or updating a table. |
schema |
String |
Specifies the name of the schema where the SDR table is located. This parameter is mandatory for DWS. |
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. |
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 |
Specifies the creation time. This parameter is read-only and does not need to be set during creation and update. |
update_time |
String |
Specifies the update time. This parameter is read-only and does not need to be set during creation and update. |
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. |
dimension_group |
String |
Granularity ID. |
group_name |
String |
Granularity name, which is read-only. |
group_code |
String |
Granularity code, which is read-only. |
time_period |
Time period attribute information of the summary table. |
|
table_attributes |
Array of AggregationLogicTableAttributeVO objects |
Attribute information of the summary table. The type is determined based on attribute_type. |
physical_table |
String |
Status of the table created in the production environment. This parameter is read-only. |
dev_physical_table |
String |
Status of the table created in the development environment. This parameter is read-only. |
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. |
publish_to_dlm |
String |
DLM API generation status. This parameter is read-only. |
summary_status |
String |
Overall synchronization status. This parameter is read-only. |
distribute |
String |
DISTRIBUTE BY [HASH(column)|REPLICATION]. Options:
|
distribute_column |
String |
DISTRIBUTE BY HASH column. |
compression |
String |
DWS data compression level. The column compression level is no/low/middle/high, and the row compression level is no/yes. Options:
|
obs_location |
String |
Path of the foreign table. |
pre_combine_field |
String |
Version field. |
table_type |
String |
Table type |
dlf_task_id |
String |
ID of a DLF job. |
quality_id |
String |
Quality ID, which is a string |
reversed |
Boolean |
Indicates whether the operation is reverse. This parameter is read-only. |
table_version |
Integer |
If this parameter is set to 2, the summary table is generated and read-only. |
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. |
alias |
String |
Alias |
configs |
String |
Other configurations. |
self_defined_fields |
Array of SelfDefinedFieldVO objects |
User-defined item. |
api_id |
String |
API ID |
sql |
String |
SQL statement bound to the SDR table. |
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 |
Long |
Model ID |
model |
WorkspaceVO object |
Model information |
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 |
aggregation_logic_table_id |
String |
ID of the summary table, which is a string |
ordinal |
Integer |
Sequence number. |
name_en |
String |
Field name. |
name_ch |
String |
Service attribute. |
attribute_type |
String |
Business entity type. Options:
|
is_primary_key |
Boolean |
Indicates whether a key is a primary key. |
is_partition_key |
Boolean |
Indicates whether the key is a partition key. |
secrecy_levels |
Array of SecrecyLevelVO objects |
Confidentiality |
not_null |
Boolean |
Indicates whether the value is empty. |
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. |
ref_id |
String |
ID of the object associated with the attribute. |
ref_name_ch |
String |
Chinese name of the object associated with the attribute. |
ref_name_en |
String |
English name of the object associated with the attribute. |
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 |
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 |
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 |
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
Manually create a summary table based on the input parameters.
POST https://{endpoint}/v2/{project_id}/design/aggregation-logic-tables { "tb_name" : "test_create_aggregation_logic_table", "tb_logic_name" : "test_create_aggregation_logic_table", "alias" : "", "dimension_group" : "0", "secret_type" : "PUBLIC", "apply_bg" : "", "l3_id" : "1105525024175058944", "description" : "None", "owner" : "autotest_tics", "dw_type" : "DWS", "dw_id" : "8259af52bd294f98920ebce75a426391", "db_name" : "bi", "schema" : "", "queue_name" : "default", "self_defined_fields" : [ { "fd_name_ch" : "aaa", "fd_name_en" : "aaa", "not_null" : false, "fd_value" : "" } ], "configs" : "{}", "table_type" : "MANAGED", "obs_location" : "", "table_attributes" : [ { "id" : null, "name_ch" : "col_aa", "name_en" : "col_aa", "ordinal" : 1, "is_primary_key" : false, "is_partition_key" : false, "not_null" : false, "description" : "", "data_type" : "BIGINT", "data_type_extend" : "", "stand_row_id" : null, "stand_row_name" : null, "ref_id" : null, "ref_name_ch" : null, "secrecy_levels" : [ { "name" : "secrecy_level_name" } ] } ], "id" : 0, "sql" : "" }
Example Responses
Status code: 200
This operation succeeds, and the returned data is AggregationLogicTableVO.
{ "data" : { "value" : { "id" : "1227937502401331200", "tb_name" : "test_create_aggregation_logic_table", "tb_logic_name" : "test_create_aggregation_logic_table", "l1_id" : null, "l2_id" : null, "l3_id" : "1105525024175058944", "description" : "None", "owner" : "autotest_tics", "create_by" : "test_uesr", "queue_name" : "default", "dw_id" : "8259af52bd294f98920ebce75a426391", "db_name" : "bi", "tb_id" : null, "schema" : "", "dw_name" : null, "status" : "DRAFT", "tb_guid" : null, "tb_logic_guid" : null, "dw_type" : "DWS", "l1" : null, "l2" : null, "l3" : null, "create_time" : "2024-04-11T11:05:14.548+08:00", "update_time" : "2024-04-11T11:05:14.548+08:00", "approval_info" : null, "new_biz" : null, "dimension_group" : "0", "group_name" : null, "group_code" : null, "time_period" : null, "table_attributes" : [ { "id" : null, "aggregation_logic_table_id" : null, "ordinal" : 1, "name_en" : "col_aa", "name_ch" : "col_aa", "attribute_type" : null, "is_primary_key" : false, "is_partition_key" : false, "not_null" : false, "secrecy_levels" : null, "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : "", "ref_id" : null, "ref_name_ch" : null, "ref_name_en" : null, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null }, { "id" : null, "aggregation_logic_table_id" : null, "ordinal" : 2, "name_en" : "col_bb", "name_ch" : "col_bb", "attribute_type" : null, "is_primary_key" : false, "is_partition_key" : false, "not_null" : false, "secrecy_levels" : null, "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : "", "ref_id" : null, "ref_name_ch" : null, "ref_name_en" : null, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null } ], "physical_table" : null, "dev_physical_table" : null, "technical_asset" : null, "business_asset" : null, "meta_data_link" : null, "data_quality" : null, "dlf_task" : null, "publish_to_dlm" : null, "summary_status" : null, "distribute" : null, "distribute_column" : null, "compression" : null, "obs_location" : null, "pre_combine_field" : null, "table_type" : "MANAGED", "dlf_task_id" : null, "quality_id" : null, "reversed" : false, "table_version" : 0, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "alias" : "", "configs" : "{}", "self_defined_fields" : [ { "fd_name_ch" : "aaa", "fd_name_en" : "aaa", "not_null" : false, "fd_value" : "" } ], "api_id" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : null, "sql" : "" } } }
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.
Manually create a summary table based on the input parameters.
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
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.*; import java.util.List; import java.util.ArrayList; public class CreateDesignAggregationLogicTableSolution { 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(); CreateDesignAggregationLogicTableRequest request = new CreateDesignAggregationLogicTableRequest(); AggregationLogicTableVO body = new AggregationLogicTableVO(); List<SelfDefinedFieldVO> listbodySelfDefinedFields = new ArrayList<>(); listbodySelfDefinedFields.add( new SelfDefinedFieldVO() .withFdNameCh("aaa") .withFdNameEn("aaa") .withNotNull(false) .withFdValue("") ); List<SecrecyLevelVO> listTableAttributesSecrecyLevels = new ArrayList<>(); listTableAttributesSecrecyLevels.add( new SecrecyLevelVO() .withName("secrecy_level_name") ); List<AggregationLogicTableAttributeVO> listbodyTableAttributes = new ArrayList<>(); listbodyTableAttributes.add( new AggregationLogicTableAttributeVO() .withOrdinal(1) .withNameEn("col_aa") .withNameCh("col_aa") .withIsPrimaryKey(false) .withIsPartitionKey(false) .withSecrecyLevels(listTableAttributesSecrecyLevels) .withNotNull(false) .withDescription("") .withDataType("BIGINT") .withDataTypeExtend("") ); body.withSql(""); body.withSelfDefinedFields(listbodySelfDefinedFields); body.withConfigs("{}"); body.withAlias(""); body.withTableType("MANAGED"); body.withObsLocation(""); body.withTableAttributes(listbodyTableAttributes); body.withDimensionGroup("0"); body.withDwType("DWS"); body.withSchema(""); body.withDbName("bi"); body.withDwId("8259af52bd294f98920ebce75a426391"); body.withQueueName("default"); body.withApplyBg(AggregationLogicTableVO.ApplyBgEnum.fromValue("")); body.withSecretType(AggregationLogicTableVO.SecretTypeEnum.fromValue("PUBLIC")); body.withOwner("autotest_tics"); body.withDescription("None"); body.withL3Id("1105525024175058944"); body.withTbLogicName("test_create_aggregation_logic_table"); body.withTbName("test_create_aggregation_logic_table"); body.withId("0"); request.withBody(body); try { CreateDesignAggregationLogicTableResponse response = client.createDesignAggregationLogicTable(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()); } } } |
Manually create a summary table based on the input parameters.
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# 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 = CreateDesignAggregationLogicTableRequest() listSelfDefinedFieldsbody = [ SelfDefinedFieldVO( fd_name_ch="aaa", fd_name_en="aaa", not_null=False, fd_value="" ) ] listSecrecyLevelsTableAttributes = [ SecrecyLevelVO( name="secrecy_level_name" ) ] listTableAttributesbody = [ AggregationLogicTableAttributeVO( ordinal=1, name_en="col_aa", name_ch="col_aa", is_primary_key=False, is_partition_key=False, secrecy_levels=listSecrecyLevelsTableAttributes, not_null=False, description="", data_type="BIGINT", data_type_extend="" ) ] request.body = AggregationLogicTableVO( sql="", self_defined_fields=listSelfDefinedFieldsbody, configs="{}", alias="", table_type="MANAGED", obs_location="", table_attributes=listTableAttributesbody, dimension_group="0", dw_type="DWS", schema="", db_name="bi", dw_id="8259af52bd294f98920ebce75a426391", queue_name="default", apply_bg="", secret_type="PUBLIC", owner="autotest_tics", description="None", l3_id="1105525024175058944", tb_logic_name="test_create_aggregation_logic_table", tb_name="test_create_aggregation_logic_table", id="0" ) response = client.create_design_aggregation_logic_table(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Manually create a summary table based on the input parameters.
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
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.CreateDesignAggregationLogicTableRequest{} fdNameChSelfDefinedFields:= "aaa" fdNameEnSelfDefinedFields:= "aaa" notNullSelfDefinedFields:= false fdValueSelfDefinedFields:= "" var listSelfDefinedFieldsbody = []model.SelfDefinedFieldVo{ { FdNameCh: &fdNameChSelfDefinedFields, FdNameEn: &fdNameEnSelfDefinedFields, NotNull: ¬NullSelfDefinedFields, FdValue: &fdValueSelfDefinedFields, }, } var listSecrecyLevelsTableAttributes = []model.SecrecyLevelVo{ { Name: "secrecy_level_name", }, } ordinalTableAttributes:= int32(1) notNullTableAttributes:= false descriptionTableAttributes:= "" dataTypeExtendTableAttributes:= "" var listTableAttributesbody = []model.AggregationLogicTableAttributeVo{ { Ordinal: &ordinalTableAttributes, NameEn: "col_aa", NameCh: "col_aa", IsPrimaryKey: false, IsPartitionKey: false, SecrecyLevels: &listSecrecyLevelsTableAttributes, NotNull: ¬NullTableAttributes, Description: &descriptionTableAttributes, DataType: "BIGINT", DataTypeExtend: &dataTypeExtendTableAttributes, }, } sqlAggregationLogicTableVo:= "" configsAggregationLogicTableVo:= "{}" aliasAggregationLogicTableVo:= "" tableTypeAggregationLogicTableVo:= "MANAGED" obsLocationAggregationLogicTableVo:= "" dimensionGroupAggregationLogicTableVo:= "0" schemaAggregationLogicTableVo:= "" queueNameAggregationLogicTableVo:= "default" applyBgApplyBg:= model.GetApplyBgEnumApplyBgEnum().EMPTY secretTypeSecretType:= model.GetSecretTypeEnumSecretTypeEnum().PUBLIC descriptionAggregationLogicTableVo:= "None" idAggregationLogicTableVo:= "0" request.Body = &model.AggregationLogicTableVo{ Sql: &sqlAggregationLogicTableVo, SelfDefinedFields: &listSelfDefinedFieldsbody, Configs: &configsAggregationLogicTableVo, Alias: &aliasAggregationLogicTableVo, TableType: &tableTypeAggregationLogicTableVo, ObsLocation: &obsLocationAggregationLogicTableVo, TableAttributes: &listTableAttributesbody, DimensionGroup: &dimensionGroupAggregationLogicTableVo, DwType: "DWS", Schema: &schemaAggregationLogicTableVo, DbName: "bi", DwId: "8259af52bd294f98920ebce75a426391", QueueName: &queueNameAggregationLogicTableVo, ApplyBg: &applyBgApplyBg, SecretType: &secretTypeSecretType, Owner: "autotest_tics", Description: &descriptionAggregationLogicTableVo, L3Id: "1105525024175058944", TbLogicName: "test_create_aggregation_logic_table", TbName: "test_create_aggregation_logic_table", Id: &idAggregationLogicTableVo, } response, err := client.CreateDesignAggregationLogicTable(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 AggregationLogicTableVO. |
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