Updating a Table Model
Function
Updates a table model and its attributes, including logical entities and physical tables, in relational modeling.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/design/table-model
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 |
Yes |
String |
ID, which is a string |
model_id |
Yes |
String |
ID of the relational model, which is a string |
parent_table_id |
No |
String |
Parent table ID, which is a string |
model |
No |
WorkspaceVO object |
Model information |
data_format |
No |
String |
Data Format, |
obs_bucket |
No |
String |
OBS bucket. |
obs_location |
No |
String |
OBS path. |
configs |
No |
String |
Other configurations. |
owner |
No |
String |
Owner of the instance. |
tb_name |
Yes |
String |
Table name. |
dw_id |
No |
String |
Data connection ID. |
db_name |
No |
String |
Indicates the database name. |
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. |
schema |
No |
String |
Required by the DWS type. |
extend_info |
No |
String |
Indicates the extension information. |
logic_tb_name |
Yes |
String |
Name of a logical entity. |
description |
Yes |
String |
Description. |
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:
|
logic_tb_id |
No |
String |
ID of a logical entity, which is a string |
biz_catalog_id |
No |
String |
ID of the business catalog, which is a string |
catalog_path |
No |
String |
Path of the home service category. The format is {"l1Id":"958408897973161984","l2Id":"958408897973161985","l3Id":"958408897973161986"}. |
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. |
attributes |
Yes |
Array of TableModelAttributeVO objects |
Table attribute information. |
mappings |
No |
Array of TableMappingVO objects |
Table mapping information. |
relations |
No |
Array of RelationVO objects |
Relationship. |
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. |
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. |
l2_id |
No |
String |
Subject area ID. |
partition_conf |
No |
String |
Partition Expression |
dlf_task_id |
No |
String |
ID of a DLF job. |
use_recently_partition |
No |
Boolean |
Indicates whether to use the latest partition. |
reversed |
No |
Boolean |
Indicates whether it is reverse. |
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. |
quality_owner |
No |
String |
Quality owner. |
quality_id |
No |
String |
Quality ID, which is a string |
distribute |
No |
String |
DISTRIBUTE BY [HASH(column)|REPLICATION]. Options:
|
distribute_column |
No |
String |
DISTRIBUTE BY HASH column. |
alias |
No |
String |
Alias |
self_defined_fields |
No |
Array of SelfDefinedFieldVO objects |
User-defined item. |
has_related_physical_table |
No |
Boolean |
Indicates whether a physical table is associated. |
has_related_logic_table |
No |
Boolean |
Indicates whether a logical entity is associated. |
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. |
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 |
name_en |
Yes |
String |
Field name. |
name_ch |
Yes |
String |
Service attribute. |
description |
No |
String |
Description. |
obs_location |
No |
String |
OBS path, which is a subpath. |
create_by |
No |
String |
Creator. |
update_by |
No |
String |
Person who updates the information. |
data_type |
Yes |
String |
Field type |
data_type_extend |
No |
String |
Extended field of the data type. |
is_primary_key |
Yes |
Boolean |
Indicates whether a key is a primary key. |
is_partition_key |
No |
Boolean |
Indicates whether the key is a partition key. |
is_foreign_key |
No |
Boolean |
Indicates whether a key is a foreign key. |
extend_field |
No |
Boolean |
Indicates whether an attribute is inherited. |
not_null |
No |
Boolean |
Indicates whether the value is empty. |
ordinal |
No |
Integer |
Sequence number. |
table_model_id |
No |
String |
ID of the relational model, which is a string |
stand_row_id |
No |
String |
ID of the associated data standard, which is a string |
alias |
No |
String |
Alias |
self_defined_fields |
No |
Array of SelfDefinedFieldVO objects |
User-defined item. |
code |
No |
String |
Logical Attribute Code |
related_logic_attr_id |
No |
String |
ID of the associated logical attribute, which is a string |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
ID, which is a string |
name |
Yes |
String |
Name. |
description |
No |
String |
Description. |
target_table_id |
No |
String |
Destination table ID, which is a string |
src_model_id |
No |
String |
ID of the relational model for the source table. The value is a string. |
src_model_name |
No |
String |
Source model name. |
view_text |
No |
String |
Source of the collected view. The dws view is used reversely. |
target_table_name |
No |
String |
Name of the destination table. |
details |
No |
Array of TableMappingDetailVO objects |
Details. |
source_tables |
No |
Array of MappingSourceTableVO objects |
Mapped table information. |
source_fields |
No |
Array of MappingSourceFieldVO objects |
Mapped field information. |
create_time |
No |
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 |
No |
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 |
No |
String |
Creator. |
update_by |
No |
String |
Person who updates the information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
ID, which is a string |
mapping_id |
No |
String |
Name. |
target_attr_id |
No |
String |
ID of the destination attribute, which is a string |
target_attr_name |
Yes |
String |
Sort by destination field. |
src_table_ids |
No |
String |
Source table ID. |
src_attr_ids |
No |
String |
ID of a field in the source table. |
remark |
No |
String |
Description. |
create_time |
No |
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 |
No |
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 |
No |
String |
Creator. |
update_by |
No |
String |
Person who updates the information. |
target_attr |
No |
Object |
Target attribute. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
table1_id |
Yes |
String |
Table 1 ID, which is a string |
table2_id |
No |
String |
Table 2 ID, which is a string |
table1_name |
Yes |
String |
Name of table 1. |
table2_name |
No |
String |
Name of table 2. |
join_type |
Yes |
String |
Association type. Options:
|
join_fields |
Yes |
Array of MappingJoinFieldVO objects |
on condition. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
field1_id |
Yes |
String |
Attribute 1 ID, which is a string |
field2_id |
Yes |
String |
Attribute 2 ID, which is a string |
field1_name |
Yes |
String |
Name of attribute 1. |
field2_name |
Yes |
String |
Name of attribute 2. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
target_field_id |
No |
String |
ID of the target field, which is a field in the current table. The ID is a string. |
target_field_name |
Yes |
String |
Target field code. |
field_ids |
No |
String |
Source field ID. Use commas (,) to separate multiple IDs. |
transform_expression |
No |
String |
Conversion expression. |
field_names |
No |
Array of strings |
List of source field names. |
changed |
No |
Boolean |
Indicates whether a field is changed. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
ID, which is a string |
source_table_id |
No |
String |
Source table ID, which is a string |
target_table_id |
No |
String |
Destination table ID, which is a string |
name |
Yes |
String |
Relationship name. |
source_table_name |
No |
String |
Name of the source table. |
target_table_name |
No |
String |
Name of the destination table. |
role |
No |
String |
Role. |
tenant_id |
No |
String |
Tenant ID. |
source_type |
No |
String |
Relationship type, which is read-only. Options:
|
target_type |
No |
String |
Relationship type, which is read-only. Options:
|
create_by |
No |
String |
Creator. |
update_by |
No |
String |
Person who updates the information. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
data: unified outermost data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
value |
TableModelVO object |
value: unified outer data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
model_id |
String |
ID of the relational model, which is a string |
parent_table_id |
String |
Parent table ID, which is a string |
parent_table_name |
String |
Parent table name, which is read-only. |
parent_table_code |
String |
Parent table code, which is read-only. |
related_logic_table_id |
String |
ID of the associated logical entity, which is a string |
related_logic_table_name |
String |
Name of an associated logical entity. |
related_logic_table_model_id |
String |
ID of the model associated with a logical entity, which is a string |
related_logic_table_model_name |
String |
Name of the model associated with a logical entity. |
model |
WorkspaceVO object |
Model information |
data_format |
String |
Data Format, |
obs_bucket |
String |
OBS bucket. |
obs_location |
String |
Foreign Table Path |
configs |
String |
Other configurations. |
table_type |
String |
Table type, which is read-only. |
owner |
String |
Person in charge. |
tb_name |
String |
Table name. |
dw_id |
String |
Data connection ID. |
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. |
extend_info |
String |
Indicates the extension information. |
tb_guid |
String |
GUID after table materialization. This parameter is read-only. |
tb_id |
String |
Data table ID. This parameter is read-only. |
logic_tb_name |
String |
Name of a logical entity. |
logic_tb_guid |
String |
GUID of a logical entity. This parameter is read-only. |
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:
|
logic_tb_id |
String |
ID of a logical entity, which is a string |
biz_catalog_id |
String |
ID of the business catalog, which is a string |
catalog_path |
String |
Path of the home service category: {"l1Id":"","l2Id":"","l3Id":""}. |
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. |
tags |
Array of TagRecordVO objects |
Read-only table tags |
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. |
attributes |
Array of TableModelAttributeVO objects |
Table attribute information. |
mappings |
Array of TableMappingVO objects |
Table mapping information. |
relations |
Array of RelationVO objects |
Relationship. |
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_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. |
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. |
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 read-only string |
partition_conf |
String |
Partition expression. |
dlf_task_id |
String |
ID of a DLF job. |
use_recently_partition |
Boolean |
Indicates whether to use the latest partition. |
reversed |
Boolean |
Indicates whether it is reverse. |
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. |
quality_owner |
String |
Quality owner. |
quality_id |
String |
Quality ID, which is a string |
distribute |
String |
DISTRIBUTE BY [HASH(column)|REPLICATION]. Options:
|
distribute_column |
String |
DISTRIBUTE BY HASH column. |
is_partition |
Boolean |
Indicates whether the table is a partition table. 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. |
summary_status |
String |
Overall synchronization status. This parameter is read-only. |
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:
|
alias |
String |
Alias |
self_defined_fields |
Array of SelfDefinedFieldVO objects |
User-defined item. |
code |
String |
Message |
has_related_physical_table |
Boolean |
Indicates whether an associated physical table exists. |
has_related_logic_table |
Boolean |
Indicates whether an associated logical entity exists. |
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. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
tag_id |
String |
Tag ID, which is a string |
tag_name |
String |
Tag name. |
biz_id |
String |
Entity ID, which is a string |
biz_type |
String |
Business entity type. Options:
|
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. |
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_en |
String |
Field name. |
name_ch |
String |
Service attribute. |
description |
String |
Description. |
obs_location |
String |
OBS path, which is a subpath. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
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_partition_key |
Boolean |
Indicates whether the key is a partition key. |
is_foreign_key |
Boolean |
Indicates whether a key is a foreign key. |
extend_field |
Boolean |
Indicates whether an attribute is inherited. |
not_null |
Boolean |
Indicates whether the value is empty. |
ordinal |
Integer |
Sequence number. |
table_model_id |
String |
ID of the relational model, which is a string |
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. |
tags |
Array of TagVO objects |
Read-only table tags |
secrecy_levels |
Array of SecrecyLevelVO objects |
Confidentiality |
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. |
code |
String |
Logical Attribute Code |
related_logic_attr_id |
String |
ID of the associated logical attribute, which is a string |
related_logic_attr_name |
String |
Associated Logical Entity Attribute Name (Zh) |
related_logic_attr_name_en |
String |
Associated Logical Entity Attribute Name (En) |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
name |
String |
Label name |
description |
String |
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 |
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 |
---|---|---|
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 |
source_table_id |
String |
Source table ID, which is a string |
target_table_id |
String |
Destination table ID, which is a string |
name |
String |
Relationship name. |
source_table_name |
String |
Name of the source table. |
target_table_name |
String |
Name of the destination table. |
role |
String |
Role. |
tenant_id |
String |
Tenant ID. |
source_type |
String |
Relationship type, which is read-only. Options:
|
target_type |
String |
Relationship type, which is read-only. Options:
|
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. |
mappings |
Array of RelationMappingVO objects |
Table attribute information, which is read-only. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
relation_id |
String |
Relationship ID, which is a string |
source_field_id |
String |
Source field ID, which is a string |
target_field_id |
String |
Destination field ID, which is a string |
source_field_name |
String |
Name of the source table. |
target_field_name |
String |
Name of the destination table. |
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. |
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 |
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
Update the physical table based on the request parameters.
PUT https://{endpoint}/v2/{project_id}/design/table-model { "id" : "1231932180633112576", "model_id" : "1208730797675311104", "parent_table_id" : null, "parent_table_name" : null, "parent_table_code" : null, "model" : { "id" : "1208730797675311104", "name" : "xingneng2", "description" : "", "is_physical" : true, "frequent" : false, "top" : false, "level" : null, "dw_type" : "MRS_HIVE", "create_time" : "2024-02-18T11:04:39+08:00", "update_time" : "2024-02-18T11:04:39+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr", "type" : "THIRD_NF", "biz_catalog_ids" : null, "databases" : null, "table_model_prefix" : "" }, "data_format" : "Parquet", "obs_bucket" : null, "obs_location" : null, "configs" : "{}", "table_type" : "HIVE_TABLE", "owner" : "", "tb_name" : "test_update_table_model", "dw_id" : "0fafdd43a342436e87e42d7217d26679", "db_name" : null, "queue_name" : null, "schema" : null, "extend_info" : "{\"dirtyOutDatabase\":\"\",\"dirtyOutPrefix\":\"\",\"dirtyOutSuffix\":\"\",\"dirtyOutSwitch\":\"false\"}", "tb_guid" : null, "tb_id" : null, "logic_tb_name" : "test_update_table_model", "logic_tb_guid" : null, "description" : "None", "status" : "DRAFT", "logic_tb_id" : null, "biz_catalog_id" : "958408897973161984", "catalog_path" : "{\"l1Id\":\"958408897973161984\",\"l2Id\":\"\",\"l3Id\":\"\",\"l4Id\":\"\",\"l5Id\":\"\",\"l6Id\":\"\",\"l7Id\":\"\"}", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-04-22T11:38:40+08:00", "update_time" : "2024-04-22T11:38:40+08:00", "tags" : [ { "name" : "tag1" } ], "approval_info" : null, "new_biz" : null, "attributes" : [ { "id" : "1231932180754747392", "name_en" : "col_a", "name_ch" : "col_a", "description" : "", "obs_location" : null, "create_by" : null, "update_by" : null, "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : false, "ordinal" : 1, "table_model_id" : null, "create_time" : "2024-04-22T11:38:40+08:00", "update_time" : "2024-04-22T11:38:40+08:00", "tags" : [ { "name" : "tag1" } ], "secrecy_levels" : [ { "name" : "secrecy_level_name" } ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : [ { "data_quality_id" : "1231932180754747392" } ], "alias" : "", "self_defined_fields" : [ { "fd_name_ch" : "Sue", "fd_name_en" : "SDSDFD", "not_null" : false, "fd_value" : "" }, { "fd_name_ch" : "test", "fd_name_en" : "test", "not_null" : false, "fd_value" : "" } ], "code" : "", "related_logic_attr_id" : null, "related_logic_attr_name" : null, "related_logic_attr_name_en" : null } ], "mappings" : [ { "name" : "mapping_name" } ], "relations" : [ { "name" : "relation_name" } ], "dw_type" : "MRS_HIVE", "dw_name" : "MRS_Hive", "l1" : "tesy", "l2" : "", "l3" : null, "l1_id" : "958408897973161984", "l2_id" : "", "l3_id" : null, "partition_conf" : null, "dlf_task_id" : null, "use_recently_partition" : false, "reversed" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "quality_owner" : null, "quality_id" : null, "distribute" : null, "distribute_column" : null, "is_partition" : false, "physical_table" : "NO_NEED", "dev_physical_table" : "NO_NEED", "technical_asset" : "NO_NEED", "business_asset" : "NO_NEED", "meta_data_link" : "NO_NEED", "data_quality" : "NO_NEED", "summary_status" : "NO_NEED", "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "INVALID_TYPE", "alias" : null, "self_defined_fields" : null, "has_related_physical_table" : false, "has_related_logic_table" : false }
Example Responses
Status code: 200
This operation succeeds, and the returned data is TableModelVO.
{ "data" : { "value" : { "id" : "1012314146584301568", "model_id" : "873242752312385536", "parent_table_id" : null, "parent_table_name" : null, "parent_table_code" : null, "model" : null, "data_format" : "Parquet", "obs_bucket" : null, "obs_location" : null, "configs" : "{}", "table_type" : "MANAGED", "owner" : "", "tb_name" : "staff_info", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "db_name" : "ctz_test", "queue_name" : "default", "schema" : "", "extend_info" : "{\"dirtyOutDatabase\":\"\",\"dirtyOutPrefix\":\"\",\"dirtyOutSuffix\":\"\",\"dirtyOutSwitch\":\"false\"}", "tb_guid" : null, "tb_id" : "NativeTable-2c9080f07b03db8d017b198a4a20002f-ctz_test-staff_info", "logic_tb_name" : "staff_info", "logic_tb_guid" : "1ab1a58b-9412-4901-bb80-4ccaaa0580e4", "description" : "N/A", "status" : "PUBLISHED", "logic_tb_id" : null, "biz_catalog_id" : "1012306178602041344", "catalog_path" : "Factory/Personnel management/Personnel archive", "create_by" : "abc", "update_by" : "abc", "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:45+08:00", "tags" : [ ], "approval_info" : null, "new_biz" : null, "attributes" : [ { "id" : "1012314146626244608", "name_en" : "id", "name_ch" : "Primary Key", "description" : "", "obs_location" : null, "create_by" : "abc", "update_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : true, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : true, "ordinal" : 1, "table_model_id" : null, "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:00+08:00", "tags" : [ ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ ] }, { "id" : "1012314146626244609", "name_en" : "name", "name_ch" : "Name", "description" : "", "obs_location" : null, "create_by" : "abc", "update_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : false, "ordinal" : 2, "table_model_id" : null, "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:00+08:00", "tags" : [ ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ ] }, { "id" : "1012314146592690176", "name_en" : "age", "name_ch" : "Age", "description" : "", "obs_location" : null, "create_by" : "abc", "update_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : false, "ordinal" : 3, "table_model_id" : null, "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:00+08:00", "tags" : [ ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ ] } ], "mappings" : null, "relations" : [ ], "dw_type" : "DWS", "dw_name" : null, "l1" : "Factory", "l2" : "Staff Management", "l3" : "Personnel Profile", "l1_id" : "1012305751919689728", "l2_id" : "1012306048792526848", "l3_id" : "1012306178602041344", "partition_conf" : null, "dlf_task_id" : null, "use_recently_partition" : false, "reversed" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "quality_owner" : null, "quality_id" : "1012314332484304897", "distribute" : null, "distribute_column" : null, "is_partition" : false, "physical_table" : "CREATE_SUCCESS", "technical_asset" : "CREATE_FAILED", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "CREATE_SUCCESS", "summary_status" : "SUMMARY_FAILED", "alias" : null, "self_defined_fields" : null } } }
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.
Update the physical table based on the request 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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
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.time.OffsetDateTime; import java.time.format.DateTimeFormatter; import java.util.List; import java.util.ArrayList; public class UpdateTableModelSolution { 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(); UpdateTableModelRequest request = new UpdateTableModelRequest(); TableModelUpdateVO body = new TableModelUpdateVO(); List<RelationVO> listbodyRelations = new ArrayList<>(); listbodyRelations.add( new RelationVO() .withName("relation_name") ); List<TableMappingVO> listbodyMappings = new ArrayList<>(); listbodyMappings.add( new TableMappingVO() .withName("mapping_name") ); List<SelfDefinedFieldVO> listAttributesSelfDefinedFields = new ArrayList<>(); listAttributesSelfDefinedFields.add( new SelfDefinedFieldVO() .withFdNameCh("Sue") .withFdNameEn("SDSDFD") .withNotNull(false) .withFdValue("") ); listAttributesSelfDefinedFields.add( new SelfDefinedFieldVO() .withFdNameCh("test") .withFdNameEn("test") .withNotNull(false) .withFdValue("") ); List<QualityInfoVO> listAttributesQualityInfos = new ArrayList<>(); listAttributesQualityInfos.add( new QualityInfoVO() .withDataQualityId("1231932180754747392") ); List<SecrecyLevelVO> listAttributesSecrecyLevels = new ArrayList<>(); listAttributesSecrecyLevels.add( new SecrecyLevelVO() .withName("secrecy_level_name") ); List<TagVO> listAttributesTags = new ArrayList<>(); listAttributesTags.add( new TagVO() .withName("tag1") ); List<TableModelAttributeVO> listbodyAttributes = new ArrayList<>(); listbodyAttributes.add( new TableModelAttributeVO() .withId("1231932180754747392") .withNameEn("col_a") .withNameCh("col_a") .withDescription("") .withDataType("STRING") .withDomainType(TableModelAttributeVO.DomainTypeEnum.fromValue("STRING")) .withDataTypeExtend("") .withIsPrimaryKey(false) .withIsPartitionKey(false) .withIsForeignKey(false) .withExtendField(false) .withNotNull(false) .withOrdinal(1) .withCreateTime(OffsetDateTime.parse("2024-04-22T11:38:40+08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME)) .withUpdateTime(OffsetDateTime.parse("2024-04-22T11:38:40+08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME)) .withTags(listAttributesTags) .withSecrecyLevels(listAttributesSecrecyLevels) .withQualityInfos(listAttributesQualityInfos) .withAlias("") .withSelfDefinedFields(listAttributesSelfDefinedFields) .withCode("") ); List<TagVO> listbodyTags = new ArrayList<>(); listbodyTags.add( new TagVO() .withName("tag1") ); WorkspaceVO modelbody = new WorkspaceVO(); modelbody.withId("1208730797675311104") .withName("xingneng2") .withDescription("") .withIsPhysical(true) .withFrequent(false) .withTop(false) .withDwType("MRS_HIVE") .withCreateTime(OffsetDateTime.parse("2024-02-18T11:04:39+08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME)) .withUpdateTime(OffsetDateTime.parse("2024-02-18T11:04:39+08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME)) .withCreateBy("test_uesr") .withUpdateBy("test_uesr") .withType(WorkspaceVO.TypeEnum.fromValue("THIRD_NF")) .withTableModelPrefix(""); body.withHasRelatedLogicTable(false); body.withHasRelatedPhysicalTable(false); body.withEnvType(TableModelUpdateVO.EnvTypeEnum.fromValue("INVALID_TYPE")); body.withSummaryStatus(TableModelUpdateVO.SummaryStatusEnum.fromValue("NO_NEED")); body.withDataQuality(TableModelUpdateVO.DataQualityEnum.fromValue("NO_NEED")); body.withMetaDataLink(TableModelUpdateVO.MetaDataLinkEnum.fromValue("NO_NEED")); body.withBusinessAsset(TableModelUpdateVO.BusinessAssetEnum.fromValue("NO_NEED")); body.withTechnicalAsset(TableModelUpdateVO.TechnicalAssetEnum.fromValue("NO_NEED")); body.withDevPhysicalTable(TableModelUpdateVO.DevPhysicalTableEnum.fromValue("NO_NEED")); body.withPhysicalTable(TableModelUpdateVO.PhysicalTableEnum.fromValue("NO_NEED")); body.withIsPartition(false); body.withDirtyOutSuffix(""); body.withDirtyOutPrefix(""); body.withDirtyOutDatabase(""); body.withDirtyOutSwitch(false); body.withUseRecentlyPartition(false); body.withL2Id(""); body.withL1Id("958408897973161984"); body.withL2(""); body.withL1("tesy"); body.withDwName("MRS_Hive"); body.withDwType("MRS_HIVE"); body.withRelations(listbodyRelations); body.withMappings(listbodyMappings); body.withAttributes(listbodyAttributes); body.withTags(listbodyTags); body.withUpdateTime(OffsetDateTime.parse("2024-04-22T11:38:40+08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME)); body.withCreateTime(OffsetDateTime.parse("2024-04-22T11:38:40+08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME)); body.withUpdateBy("test_uesr"); body.withCreateBy("test_uesr"); body.withCatalogPath("{"l1Id":"958408897973161984","l2Id":"","l3Id":"","l4Id":"","l5Id":"","l6Id":"","l7Id":""}"); body.withBizCatalogId("958408897973161984"); body.withStatus(TableModelUpdateVO.StatusEnum.fromValue("DRAFT")); body.withDescription("None"); body.withLogicTbName("test_update_table_model"); body.withExtendInfo("{"dirtyOutDatabase":"","dirtyOutPrefix":"","dirtyOutSuffix":"","dirtyOutSwitch":"false"}"); body.withDwId("0fafdd43a342436e87e42d7217d26679"); body.withTbName("test_update_table_model"); body.withOwner(""); body.withTableType("HIVE_TABLE"); body.withConfigs("{}"); body.withDataFormat("Parquet"); body.withModel(modelbody); body.withModelId("1208730797675311104"); body.withId("1231932180633112576"); request.withBody(body); try { UpdateTableModelResponse response = client.updateTableModel(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()); } } } |
Update the physical table based on the request 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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# 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 = UpdateTableModelRequest() listRelationsbody = [ RelationVO( name="relation_name" ) ] listMappingsbody = [ TableMappingVO( name="mapping_name" ) ] listSelfDefinedFieldsAttributes = [ SelfDefinedFieldVO( fd_name_ch="Sue", fd_name_en="SDSDFD", not_null=False, fd_value="" ), SelfDefinedFieldVO( fd_name_ch="test", fd_name_en="test", not_null=False, fd_value="" ) ] listQualityInfosAttributes = [ QualityInfoVO( data_quality_id="1231932180754747392" ) ] listSecrecyLevelsAttributes = [ SecrecyLevelVO( name="secrecy_level_name" ) ] listTagsAttributes = [ TagVO( name="tag1" ) ] listAttributesbody = [ TableModelAttributeVO( id="1231932180754747392", name_en="col_a", name_ch="col_a", description="", data_type="STRING", domain_type="STRING", data_type_extend="", is_primary_key=False, is_partition_key=False, is_foreign_key=False, extend_field=False, not_null=False, ordinal=1, create_time="2024-04-22T11:38:40+08:00", update_time="2024-04-22T11:38:40+08:00", tags=listTagsAttributes, secrecy_levels=listSecrecyLevelsAttributes, quality_infos=listQualityInfosAttributes, alias="", self_defined_fields=listSelfDefinedFieldsAttributes, code="" ) ] listTagsbody = [ TagVO( name="tag1" ) ] modelbody = WorkspaceVO( id="1208730797675311104", name="xingneng2", description="", is_physical=True, frequent=False, top=False, dw_type="MRS_HIVE", create_time="2024-02-18T11:04:39+08:00", update_time="2024-02-18T11:04:39+08:00", create_by="test_uesr", update_by="test_uesr", type="THIRD_NF", table_model_prefix="" ) request.body = TableModelUpdateVO( has_related_logic_table=False, has_related_physical_table=False, env_type="INVALID_TYPE", summary_status="NO_NEED", data_quality="NO_NEED", meta_data_link="NO_NEED", business_asset="NO_NEED", technical_asset="NO_NEED", dev_physical_table="NO_NEED", physical_table="NO_NEED", is_partition=False, dirty_out_suffix="", dirty_out_prefix="", dirty_out_database="", dirty_out_switch=False, use_recently_partition=False, l2_id="", l1_id="958408897973161984", l2="", l1="tesy", dw_name="MRS_Hive", dw_type="MRS_HIVE", relations=listRelationsbody, mappings=listMappingsbody, attributes=listAttributesbody, tags=listTagsbody, update_time="2024-04-22T11:38:40+08:00", create_time="2024-04-22T11:38:40+08:00", update_by="test_uesr", create_by="test_uesr", catalog_path="{"l1Id":"958408897973161984","l2Id":"","l3Id":"","l4Id":"","l5Id":"","l6Id":"","l7Id":""}", biz_catalog_id="958408897973161984", status="DRAFT", description="None", logic_tb_name="test_update_table_model", extend_info="{"dirtyOutDatabase":"","dirtyOutPrefix":"","dirtyOutSuffix":"","dirtyOutSwitch":"false"}", dw_id="0fafdd43a342436e87e42d7217d26679", tb_name="test_update_table_model", owner="", table_type="HIVE_TABLE", configs="{}", data_format="Parquet", model=modelbody, model_id="1208730797675311104", id="1231932180633112576" ) response = client.update_table_model(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Update the physical table based on the request 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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
package main import ( "fmt" "time" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/sdktime" 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.UpdateTableModelRequest{} var listRelationsbody = []model.RelationVo{ { Name: "relation_name", }, } var listMappingsbody = []model.TableMappingVo{ { Name: "mapping_name", }, } fdNameChSelfDefinedFields:= "Sue" fdNameEnSelfDefinedFields:= "SDSDFD" notNullSelfDefinedFields:= false fdValueSelfDefinedFields:= "" fdNameChSelfDefinedFields1:= "test" fdNameEnSelfDefinedFields1:= "test" notNullSelfDefinedFields1:= false fdValueSelfDefinedFields1:= "" var listSelfDefinedFieldsAttributes = []model.SelfDefinedFieldVo{ { FdNameCh: &fdNameChSelfDefinedFields, FdNameEn: &fdNameEnSelfDefinedFields, NotNull: ¬NullSelfDefinedFields, FdValue: &fdValueSelfDefinedFields, }, { FdNameCh: &fdNameChSelfDefinedFields1, FdNameEn: &fdNameEnSelfDefinedFields1, NotNull: ¬NullSelfDefinedFields1, FdValue: &fdValueSelfDefinedFields1, }, } var listQualityInfosAttributes = []model.QualityInfoVo{ { DataQualityId: "1231932180754747392", }, } var listSecrecyLevelsAttributes = []model.SecrecyLevelVo{ { Name: "secrecy_level_name", }, } var listTagsAttributes = []model.TagVo{ { Name: "tag1", }, } idAttributes:= "1231932180754747392" descriptionAttributes:= "" domainTypeAttributes:= model.GetTableModelAttributeVoDomainTypeEnum().STRING dataTypeExtendAttributes:= "" isPartitionKeyAttributes:= false isForeignKeyAttributes:= false extendFieldAttributes:= false notNullAttributes:= false ordinalAttributes:= int32(1) dateTimeCreateTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2024-04-22T11:38:40+08:00", time.UTC) createTimeAttributes:= sdktime.SdkTime(dateTimeCreateTime) dateTimeUpdateTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2024-04-22T11:38:40+08:00", time.UTC) updateTimeAttributes:= sdktime.SdkTime(dateTimeUpdateTime) aliasAttributes:= "" codeAttributes:= "" var listAttributesbody = []model.TableModelAttributeVo{ { Id: &idAttributes, NameEn: "col_a", NameCh: "col_a", Description: &descriptionAttributes, DataType: "STRING", DomainType: &domainTypeAttributes, DataTypeExtend: &dataTypeExtendAttributes, IsPrimaryKey: false, IsPartitionKey: &isPartitionKeyAttributes, IsForeignKey: &isForeignKeyAttributes, ExtendField: &extendFieldAttributes, NotNull: ¬NullAttributes, Ordinal: &ordinalAttributes, CreateTime: &createTimeAttributes, UpdateTime: &updateTimeAttributes, Tags: &listTagsAttributes, SecrecyLevels: &listSecrecyLevelsAttributes, QualityInfos: &listQualityInfosAttributes, Alias: &aliasAttributes, SelfDefinedFields: &listSelfDefinedFieldsAttributes, Code: &codeAttributes, }, } var listTagsbody = []model.TagVo{ { Name: "tag1", }, } idModel:= "1208730797675311104" descriptionModel:= "" isPhysicalModel:= true frequentModel:= false topModel:= false dwTypeModel:= "MRS_HIVE" dateTimeCreateTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2024-02-18T11:04:39+08:00", time.UTC) createTimeModel:= sdktime.SdkTime(dateTimeCreateTime) dateTimeUpdateTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2024-02-18T11:04:39+08:00", time.UTC) updateTimeModel:= sdktime.SdkTime(dateTimeUpdateTime) createByModel:= "test_uesr" updateByModel:= "test_uesr" tableModelPrefixModel:= "" modelbody := &model.WorkspaceVo{ Id: &idModel, Name: "xingneng2", Description: &descriptionModel, IsPhysical: &isPhysicalModel, Frequent: &frequentModel, Top: &topModel, DwType: &dwTypeModel, CreateTime: &createTimeModel, UpdateTime: &updateTimeModel, CreateBy: &createByModel, UpdateBy: &updateByModel, Type: model.GetWorkspaceVoTypeEnum().THIRD_NF, TableModelPrefix: &tableModelPrefixModel, } hasRelatedLogicTableTableModelUpdateVo:= false hasRelatedPhysicalTableTableModelUpdateVo:= false envTypeEnvType:= model.GetEnvTypeEnumEnvTypeEnum().INVALID_TYPE summaryStatusSummaryStatus:= model.GetSyncStatusEnumSummaryStatusEnum().NO_NEED dataQualityDataQuality:= model.GetSyncStatusEnumDataQualityEnum().NO_NEED metaDataLinkMetaDataLink:= model.GetSyncStatusEnumMetaDataLinkEnum().NO_NEED businessAssetBusinessAsset:= model.GetSyncStatusEnumBusinessAssetEnum().NO_NEED technicalAssetTechnicalAsset:= model.GetSyncStatusEnumTechnicalAssetEnum().NO_NEED devPhysicalTableDevPhysicalTable:= model.GetSyncStatusEnumDevPhysicalTableEnum().NO_NEED physicalTablePhysicalTable:= model.GetSyncStatusEnumPhysicalTableEnum().NO_NEED isPartitionTableModelUpdateVo:= false dirtyOutSuffixTableModelUpdateVo:= "" dirtyOutPrefixTableModelUpdateVo:= "" dirtyOutDatabaseTableModelUpdateVo:= "" dirtyOutSwitchTableModelUpdateVo:= false useRecentlyPartitionTableModelUpdateVo:= false l2IdTableModelUpdateVo:= "" l1IdTableModelUpdateVo:= "958408897973161984" l2TableModelUpdateVo:= "" l1TableModelUpdateVo:= "tesy" dwNameTableModelUpdateVo:= "MRS_Hive" dwTypeTableModelUpdateVo:= "MRS_HIVE" dateTimeUpdateTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2024-04-22T11:38:40+08:00", time.UTC) updateTimeTableModelUpdateVo:= sdktime.SdkTime(dateTimeUpdateTime) dateTimeCreateTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2024-04-22T11:38:40+08:00", time.UTC) createTimeTableModelUpdateVo:= sdktime.SdkTime(dateTimeCreateTime) updateByTableModelUpdateVo:= "test_uesr" createByTableModelUpdateVo:= "test_uesr" catalogPathTableModelUpdateVo:= "{"l1Id":"958408897973161984","l2Id":"","l3Id":"","l4Id":"","l5Id":"","l6Id":"","l7Id":""}" bizCatalogIdTableModelUpdateVo:= "958408897973161984" statusStatus:= model.GetBizStatusEnumStatusEnum().DRAFT extendInfoTableModelUpdateVo:= "{"dirtyOutDatabase":"","dirtyOutPrefix":"","dirtyOutSuffix":"","dirtyOutSwitch":"false"}" dwIdTableModelUpdateVo:= "0fafdd43a342436e87e42d7217d26679" ownerTableModelUpdateVo:= "" tableTypeTableModelUpdateVo:= "HIVE_TABLE" configsTableModelUpdateVo:= "{}" dataFormatTableModelUpdateVo:= "Parquet" request.Body = &model.TableModelUpdateVo{ HasRelatedLogicTable: &hasRelatedLogicTableTableModelUpdateVo, HasRelatedPhysicalTable: &hasRelatedPhysicalTableTableModelUpdateVo, EnvType: &envTypeEnvType, SummaryStatus: &summaryStatusSummaryStatus, DataQuality: &dataQualityDataQuality, MetaDataLink: &metaDataLinkMetaDataLink, BusinessAsset: &businessAssetBusinessAsset, TechnicalAsset: &technicalAssetTechnicalAsset, DevPhysicalTable: &devPhysicalTableDevPhysicalTable, PhysicalTable: &physicalTablePhysicalTable, IsPartition: &isPartitionTableModelUpdateVo, DirtyOutSuffix: &dirtyOutSuffixTableModelUpdateVo, DirtyOutPrefix: &dirtyOutPrefixTableModelUpdateVo, DirtyOutDatabase: &dirtyOutDatabaseTableModelUpdateVo, DirtyOutSwitch: &dirtyOutSwitchTableModelUpdateVo, UseRecentlyPartition: &useRecentlyPartitionTableModelUpdateVo, L2Id: &l2IdTableModelUpdateVo, L1Id: &l1IdTableModelUpdateVo, L2: &l2TableModelUpdateVo, L1: &l1TableModelUpdateVo, DwName: &dwNameTableModelUpdateVo, DwType: &dwTypeTableModelUpdateVo, Relations: &listRelationsbody, Mappings: &listMappingsbody, Attributes: listAttributesbody, Tags: &listTagsbody, UpdateTime: &updateTimeTableModelUpdateVo, CreateTime: &createTimeTableModelUpdateVo, UpdateBy: &updateByTableModelUpdateVo, CreateBy: &createByTableModelUpdateVo, CatalogPath: &catalogPathTableModelUpdateVo, BizCatalogId: &bizCatalogIdTableModelUpdateVo, Status: &statusStatus, Description: "None", LogicTbName: "test_update_table_model", ExtendInfo: &extendInfoTableModelUpdateVo, DwId: &dwIdTableModelUpdateVo, TbName: "test_update_table_model", Owner: &ownerTableModelUpdateVo, TableType: &tableTypeTableModelUpdateVo, Configs: &configsTableModelUpdateVo, DataFormat: &dataFormatTableModelUpdateVo, Model: modelbody, ModelId: "1208730797675311104", Id: "1231932180633112576", } response, err := client.UpdateTableModel(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 TableModelVO. |
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