Updated on 2024-11-06 GMT+08:00

Update Summary Table

Function

Update the summary table.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/design/aggregation-logic-tables

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

This field is mandatory for authentication using tokens.

workspace

Yes

String

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

X-Project-Id

No

String

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

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

Content-Type

No

String

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

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

No

String

Unique system ID of the SDR table. This parameter is mandatory for updating SDR tables and is not required for creating SDR tables. Set this parameter to a string instead of a long value.

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 theme to which the summary table belongs. This parameter is mandatory. The value of this parameter is of the String type instead of the Long type.

description

No

String

Description of the summary table.

owner

Yes

String

Asset owner of the summary table.

secret_type

No

String

Confidentiality type.

Options:

  • PUBLIC: public

  • SECRET: secret

  • CONFIDENTIAL: confidential

  • SUPER_SECRET: top secret

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:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be reviewed

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be reviewed

  • OFFLINE: offline

  • REJECT: rejected

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 DLI, 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

AggregationLogicTableAttributeVO object

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:

  • HASH: Hashes specified columns and distributes data to specified DNs through mapping.

  • REPLICATION: Each row in the table exists on all DNs, that is, each DN has complete table data.

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:

  • NO: no compression

  • YES: indicates that the file is compressed.

  • LOW: low-level compression

  • MIDDLE: medium-level compression

  • HIGH: high-level compression

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. Set this parameter to a value of the String type instead of the Long type.

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.

Table 4 ApprovalVO

Parameter

Mandatory

Type

Description

id

No

String

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

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

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

biz_type

No

String

Business entity type.

Options:

  • AGGREGATION_LOGIC_TABLE: summary table

  • ATOMIC_INDEX: atomic metric

  • ATOMIC_METRIC: atomic metric (new)

  • BIZ_CATALOG: process architecture directory

  • BIZ_METRIC: service indicator

  • CODE_TABLE: code table

  • COMMON_CONDITION: general filter

  • COMPOSITE_METRIC: Compound Metric (new)

  • COMPOUND_METRIC: compound metric

  • CONDITION_GROUP: restriction group

  • DEGENERATE_DIMENSION: degenerate dimension

  • DERIVATIVE_INDEX: derivative indicator

  • DERIVED_METRIC: derivative indicator (new)

  • DIMENSION: dimension

  • DIMENSION_ATTRIBUTE: dimension attribute

  • DIMENSION_HIERARCHIES: dimension level

  • DIMENSION_LOGIC_TABLE: dimension table

  • DIMENSION_TABLE_ATTRIBUTE: dimension attribute

  • DIRECTORY: directory

  • FACT_ATTRIBUTE: fact table attribute

  • FACT_DIMENSION: fact table dimension

  • FACT_LOGIC_TABLE: fact table

  • FACT_MEASURE: fact table measurement

  • FUNCTION: function

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

  • MODEL: model

  • QUALITY_RULE: quality rule

  • SECRECY_LEVEL: security level

  • STANDARD_ELEMENT: data standard

  • STANDARD_ELEMENT_TEMPLATE: data standard template

  • SUBJECT: theme

  • Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables

  • SUMMARY_INDEX: summary table indicator attribute

  • SUMMARY_TIME: time period attribute of the SDR table

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

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

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_TYPE: table type

  • TAG: tag

  • TIME_CONDITION: time restriction

biz_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:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be reviewed

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be reviewed

  • OFFLINE: offline

  • REJECT: rejected

approval_status

No

String

Service approval status. This parameter is read-only.

Options:

  • DEVELOPING: being reviewed

  • APPROVED: approved

  • REJECT: rejected

  • WITHDREW: approval cancellation

approval_type

No

String

Service review type.

Options:

  • PUBLISH: released

  • OFFLINE: offline

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.

email

No

String

Email address of the reviewer.

msg

No

String

Review information.

directory_path

No

String

Directory tree.

Table 5 BizVersionManageVO

Parameter

Mandatory

Type

Description

id

No

String

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

biz_type

No

String

Business entity type.

Options:

  • AGGREGATION_LOGIC_TABLE: summary table

  • ATOMIC_INDEX: atomic metric

  • ATOMIC_METRIC: atomic metric (new)

  • BIZ_CATALOG: process architecture directory

  • BIZ_METRIC: service indicator

  • CODE_TABLE: code table

  • COMMON_CONDITION: general filter

  • COMPOSITE_METRIC: Compound Metric (new)

  • COMPOUND_METRIC: compound metric

  • CONDITION_GROUP: restriction group

  • DEGENERATE_DIMENSION: degenerate dimension

  • DERIVATIVE_INDEX: derivative indicator

  • DERIVED_METRIC: derivative indicator (new)

  • DIMENSION: dimension

  • DIMENSION_ATTRIBUTE: dimension attribute

  • DIMENSION_HIERARCHIES: dimension level

  • DIMENSION_LOGIC_TABLE: dimension table

  • DIMENSION_TABLE_ATTRIBUTE: dimension attribute

  • DIRECTORY: directory

  • FACT_ATTRIBUTE: fact table attribute

  • FACT_DIMENSION: fact table dimension

  • FACT_LOGIC_TABLE: fact table

  • FACT_MEASURE: fact table measurement

  • FUNCTION: function

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

  • MODEL: model

  • QUALITY_RULE: quality rule

  • SECRECY_LEVEL: security level

  • STANDARD_ELEMENT: data standard

  • STANDARD_ELEMENT_TEMPLATE: data standard template

  • SUBJECT: theme

  • Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables

  • SUMMARY_INDEX: summary table indicator attribute

  • SUMMARY_TIME: time period attribute of the SDR table

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

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

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_TYPE: table type

  • TAG: tag

  • TIME_CONDITION: time restriction

biz_id

No

String

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

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:

  • DRAFT: draft

  • PUBLISH_DEVELOPING: to be reviewed

  • PUBLISHED: released

  • OFFLINE_DEVELOPING: to be reviewed

  • OFFLINE: offline

  • REJECT: rejected

Table 6 AggregationLogicTableAttributeVO

Parameter

Mandatory

Type

Description

id

No

String

Code. Set this parameter to a value of the String type instead of the Long type.

aggregation_logic_table_id

No

String

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

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:

  • AGGREGATION_LOGIC_TABLE: summary table

  • ATOMIC_INDEX: atomic metric

  • ATOMIC_METRIC: atomic metric (new)

  • BIZ_CATALOG: process architecture directory

  • BIZ_METRIC: service indicator

  • CODE_TABLE: code table

  • COMMON_CONDITION: general filter

  • COMPOSITE_METRIC: Compound Metric (new)

  • COMPOUND_METRIC: compound metric

  • CONDITION_GROUP: restriction group

  • DEGENERATE_DIMENSION: degenerate dimension

  • DERIVATIVE_INDEX: derivative indicator

  • DERIVED_METRIC: derivative indicator (new)

  • DIMENSION: dimension

  • DIMENSION_ATTRIBUTE: dimension attribute

  • DIMENSION_HIERARCHIES: dimension level

  • DIMENSION_LOGIC_TABLE: dimension table

  • DIMENSION_TABLE_ATTRIBUTE: dimension attribute

  • DIRECTORY: directory

  • FACT_ATTRIBUTE: fact table attribute

  • FACT_DIMENSION: fact table dimension

  • FACT_LOGIC_TABLE: fact table

  • FACT_MEASURE: fact table measurement

  • FUNCTION: function

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

  • MODEL: model

  • QUALITY_RULE: quality rule

  • SECRECY_LEVEL: security level

  • STANDARD_ELEMENT: data standard

  • STANDARD_ELEMENT_TEMPLATE: data standard template

  • SUBJECT: theme

  • Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables

  • SUMMARY_INDEX: summary table indicator attribute

  • SUMMARY_TIME: time period attribute of the SDR table

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

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

  • TABLE_MODEL_LOGIC: logical entity

  • TABLE_TYPE: table type

  • TAG: tag

  • TIME_CONDITION: time restriction

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. The value is of the String type instead of the Long type.

alias

No

String

Alias

Table 7 SelfDefinedFieldVO

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

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

data

Object

Returned data information.

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

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

error_msg

String

Error message

data

Object

Returned data information.

Status code: 401

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

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

error_msg

String

Error message

data

Object

Returned data information.

Status code: 403

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

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

error_msg

String

Error message

data

Object

Returned data information.

Example Requests

This API modifies summary table information based on input parameters.

PUT 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" : "DLI",
  "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" : "1227937502644600832",
    "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,
    "quality_infos" : [ {
      "data_quality_id" : "1227937502644600833"
    } ],
    "secrecy_levels" : [ {
      "name" : "secrecy_level_name"
    } ]
  } ],
  "id" : "1227937502401331200",
  "sql" : "",
  "dirty_out_switch" : false,
  "dirty_out_database" : "",
  "dirty_out_prefix" : "",
  "dirty_out_suffix" : "",
  "partition_conf" : null
}

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" : "ei_dayu_y00321344_01",
      "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" : "DLI",
      "l1" : null,
      "l2" : null,
      "l3" : null,
      "create_time" : "2024-04-11T11:05:15+08:00",
      "update_time" : "2024-04-11T11:28:17.101+08:00",
      "approval_info" : null,
      "new_biz" : null,
      "dimension_group" : "0",
      "group_name" : null,
      "group_code" : null,
      "time_period" : null,
      "table_attributes" : [ {
        "id" : "1227937502644600832",
        "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" : [ ],
        "alias" : null
      }, {
        "id" : "1227937502644600833",
        "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" : [ ],
        "alias" : null
      }, {
        "id" : null,
        "aggregation_logic_table_id" : null,
        "ordinal" : 3,
        "name_en" : "col_cc",
        "name_ch" : "col_cc",
        "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.

This API modifies summary table information based on 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
108
109
110
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 UpdateDesignAggregationLogicTableSolution {

    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();
        UpdateDesignAggregationLogicTableRequest request = new UpdateDesignAggregationLogicTableRequest();
        AggregationLogicTableVO body = new AggregationLogicTableVO();
        List<SelfDefinedFieldVO> listbodySelfDefinedFields = new ArrayList<>();
        listbodySelfDefinedFields.add(
            new SelfDefinedFieldVO()
                .withFdNameCh("aaa")
                .withFdNameEn("aaa")
                .withNotNull(false)
                .withFdValue("")
        );
        List<QualityInfoVO> listTableAttributesQualityInfos = new ArrayList<>();
        listTableAttributesQualityInfos.add(
            new QualityInfoVO()
                .withDataQualityId("1227937502644600833")
        );
        List<SecrecyLevelVO> listTableAttributesSecrecyLevels = new ArrayList<>();
        listTableAttributesSecrecyLevels.add(
            new SecrecyLevelVO()
                .withName("secrecy_level_name")
        );
        List<AggregationLogicTableAttributeVO> listbodyTableAttributes = new ArrayList<>();
        listbodyTableAttributes.add(
            new AggregationLogicTableAttributeVO()
                .withId("1227937502644600832")
                .withOrdinal(1)
                .withNameEn("col_aa")
                .withNameCh("col_aa")
                .withIsPrimaryKey(false)
                .withIsPartitionKey(false)
                .withSecrecyLevels(listTableAttributesSecrecyLevels)
                .withNotNull(false)
                .withDescription("")
                .withDataType("BIGINT")
                .withDataTypeExtend("")
                .withQualityInfos(listTableAttributesQualityInfos)
        );
        body.withSql("");
        body.withSelfDefinedFields(listbodySelfDefinedFields);
        body.withConfigs("{}");
        body.withAlias("");
        body.withDirtyOutSuffix("");
        body.withDirtyOutPrefix("");
        body.withDirtyOutDatabase("");
        body.withDirtyOutSwitch(false);
        body.withTableType("MANAGED");
        body.withObsLocation("");
        body.withTableAttributes(listbodyTableAttributes);
        body.withDimensionGroup("0");
        body.withDwType("DLI");
        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("1227937502401331200");
        request.withBody(body);
        try {
            UpdateDesignAggregationLogicTableResponse response = client.updateDesignAggregationLogicTable(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());
        }
    }
}

This API modifies summary table information based on 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
# 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 = UpdateDesignAggregationLogicTableRequest()
        listSelfDefinedFieldsbody = [
            SelfDefinedFieldVO(
                fd_name_ch="aaa",
                fd_name_en="aaa",
                not_null=False,
                fd_value=""
            )
        ]
        listQualityInfosTableAttributes = [
            QualityInfoVO(
                data_quality_id="1227937502644600833"
            )
        ]
        listSecrecyLevelsTableAttributes = [
            SecrecyLevelVO(
                name="secrecy_level_name"
            )
        ]
        listTableAttributesbody = [
            AggregationLogicTableAttributeVO(
                id="1227937502644600832",
                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="",
                quality_infos=listQualityInfosTableAttributes
            )
        ]
        request.body = AggregationLogicTableVO(
            sql="",
            self_defined_fields=listSelfDefinedFieldsbody,
            configs="{}",
            alias="",
            dirty_out_suffix="",
            dirty_out_prefix="",
            dirty_out_database="",
            dirty_out_switch=False,
            table_type="MANAGED",
            obs_location="",
            table_attributes=listTableAttributesbody,
            dimension_group="0",
            dw_type="DLI",
            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="1227937502401331200"
        )
        response = client.update_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)

This API modifies summary table information based on 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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.UpdateDesignAggregationLogicTableRequest{}
	fdNameChSelfDefinedFields:= "aaa"
	fdNameEnSelfDefinedFields:= "aaa"
	notNullSelfDefinedFields:= false
	fdValueSelfDefinedFields:= ""
	var listSelfDefinedFieldsbody = []model.SelfDefinedFieldVo{
        {
            FdNameCh: &fdNameChSelfDefinedFields,
            FdNameEn: &fdNameEnSelfDefinedFields,
            NotNull: &notNullSelfDefinedFields,
            FdValue: &fdValueSelfDefinedFields,
        },
    }
	var listQualityInfosTableAttributes = []model.QualityInfoVo{
        {
            DataQualityId: "1227937502644600833",
        },
    }
	var listSecrecyLevelsTableAttributes = []model.SecrecyLevelVo{
        {
            Name: "secrecy_level_name",
        },
    }
	idTableAttributes:= "1227937502644600832"
	ordinalTableAttributes:= int32(1)
	notNullTableAttributes:= false
	descriptionTableAttributes:= ""
	dataTypeExtendTableAttributes:= ""
	var listTableAttributesbody = []model.AggregationLogicTableAttributeVo{
        {
            Id: &idTableAttributes,
            Ordinal: &ordinalTableAttributes,
            NameEn: "col_aa",
            NameCh: "col_aa",
            IsPrimaryKey: false,
            IsPartitionKey: false,
            SecrecyLevels: &listSecrecyLevelsTableAttributes,
            NotNull: &notNullTableAttributes,
            Description: &descriptionTableAttributes,
            DataType: "BIGINT",
            DataTypeExtend: &dataTypeExtendTableAttributes,
            QualityInfos: &listQualityInfosTableAttributes,
        },
    }
	sqlAggregationLogicTableVo:= ""
	configsAggregationLogicTableVo:= "{}"
	aliasAggregationLogicTableVo:= ""
	dirtyOutSuffixAggregationLogicTableVo:= ""
	dirtyOutPrefixAggregationLogicTableVo:= ""
	dirtyOutDatabaseAggregationLogicTableVo:= ""
	dirtyOutSwitchAggregationLogicTableVo:= false
	tableTypeAggregationLogicTableVo:= "MANAGED"
	obsLocationAggregationLogicTableVo:= ""
	dimensionGroupAggregationLogicTableVo:= "0"
	schemaAggregationLogicTableVo:= ""
	queueNameAggregationLogicTableVo:= "default"
	applyBgApplyBg:= model.GetApplyBgEnumApplyBgEnum().EMPTY
	secretTypeSecretType:= model.GetSecretTypeEnumSecretTypeEnum().PUBLIC
	descriptionAggregationLogicTableVo:= "None"
	idAggregationLogicTableVo:= "1227937502401331200"
	request.Body = &model.AggregationLogicTableVo{
		Sql: &sqlAggregationLogicTableVo,
		SelfDefinedFields: &listSelfDefinedFieldsbody,
		Configs: &configsAggregationLogicTableVo,
		Alias: &aliasAggregationLogicTableVo,
		DirtyOutSuffix: &dirtyOutSuffixAggregationLogicTableVo,
		DirtyOutPrefix: &dirtyOutPrefixAggregationLogicTableVo,
		DirtyOutDatabase: &dirtyOutDatabaseAggregationLogicTableVo,
		DirtyOutSwitch: &dirtyOutSwitchAggregationLogicTableVo,
		TableType: &tableTypeAggregationLogicTableVo,
		ObsLocation: &obsLocationAggregationLogicTableVo,
		TableAttributes: &listTableAttributesbody,
		DimensionGroup: &dimensionGroupAggregationLogicTableVo,
		DwType: "DLI",
		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.UpdateDesignAggregationLogicTable(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