文档首页> 数据治理中心 DataArts Studio> API参考> 数据架构API> 码表管理接口> 修改码表
更新时间：2024-05-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改码表

功能介绍

修改码表。

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/design/code-tables/{id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

id

是

String

实体ID，填写String类型替代Long类型。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

使用Token认证时必选。

workspace

是

String

工作空间ID，获取方法请参见实例ID和工作空间ID。

X-Project-Id

否

String

项目ID，获取方法请参见项目ID和账号ID。

多project场景采用AK/SK认证的接口请求，则该字段必选。

Content-Type

否

String

默认值：application/json;charset=UTF-8

可选，有Body体的情况下必选，没有Body体则无需填写和校验。
表3 请求Body参数

参数

是否必选

参数类型

描述

id

否

String

码表ID，填写String类型替代Long类型。

name_en

是

String

表名称，英文名。

name_ch

是

String

表名称，中文名。

tb_version

否

Integer

表版本。

directory_id

是

String

目录ID，填写String类型替代Long类型。

directory_path

否

String

目录树。

description

否

String

描述。

create_by

否

String

创建人。

status

否

String

实体的发布状态，只读，创建和更新时无需填写。

枚举值：

  • DRAFT: 草稿

  • PUBLISH_DEVELOPING: 发布待审核

  • PUBLISHED: 已发布

  • OFFLINE_DEVELOPING: 下线待审核

  • OFFLINE: 已下线

  • REJECT: 已驳回

create_time

否

String

创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。

update_time

否

String

更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。

approval_info

否

ApprovalVO object

审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。

new_biz

否

BizVersionManageVO object

业务版本管理，只读。

code_table_fields

是

Array of CodeTableFieldVO objects

码表属性信息。
表4 ApprovalVO

参数

是否必选

参数类型

描述

id

否

String

审批单ID，填写String类型替代Long类型。

tenant_id

否

String

项目ID，获取方式参考接口路径参数“project_id”。

name_ch

否

String

业务中文名。

name_en

否

String

业务英文名。

biz_id

否

String

业务ID，填写String类型替代Long类型。

biz_type

否

String

业务实体类型。

枚举值：

  • AGGREGATION_LOGIC_TABLE: 汇总表

  • ATOMIC_INDEX: 原子指标

  • ATOMIC_METRIC: 原子指标（新）

  • BIZ_CATALOG: 流程架构目录

  • BIZ_METRIC: 业务指标

  • CODE_TABLE: 码表

  • COMMON_CONDITION: 通用限定

  • COMPOSITE_METRIC: 复合指标（新）

  • COMPOUND_METRIC: 复合指标

  • CONDITION_GROUP: 限定分组

  • DEGENERATE_DIMENSION: 退化维度

  • DERIVATIVE_INDEX: 衍生指标

  • DERIVED_METRIC: 衍生指标（新）

  • DIMENSION: 维度

  • DIMENSION_ATTRIBUTE: 维度属性

  • DIMENSION_HIERARCHIES: 维度层级

  • DIMENSION_LOGIC_TABLE: 维度表

  • DIMENSION_TABLE_ATTRIBUTE: 维度属性

  • DIRECTORY: 目录

  • FACT_ATTRIBUTE: 事实表属性

  • FACT_DIMENSION: 事实表维度

  • FACT_LOGIC_TABLE: 事实表

  • FACT_MEASURE: 事实表度量

  • FUNCTION: 函数

  • INFO_ARCH: 信息架构（批量修改主题使用）

  • MODEL: 模型

  • QUALITY_RULE: 质量规则

  • SECRECY_LEVEL: 密级

  • STANDARD_ELEMENT: 数据标准

  • STANDARD_ELEMENT_TEMPLATE: 数据标准模板

  • SUBJECT: 主题

  • SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性

  • SUMMARY_INDEX: 汇总表指标属性

  • SUMMARY_TIME: 汇总表时间周期属性

  • TABLE_MODEL: 关系模型（逻辑模型/物理模型）

  • TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型）

  • TABLE_MODEL_LOGIC: 逻辑实体

  • TABLE_TYPE: 表类型

  • TAG: 标签

  • TIME_CONDITION: 时间限定

biz_info

否

String

序列化之后的业务详情，类型是string。

biz_info_obj

否

Object

业务详情，类型是object。

biz_version

否

Integer

业务版本。

biz_status

否

String

实体的发布状态，只读，创建和更新时无需填写。

枚举值：

  • DRAFT: 草稿

  • PUBLISH_DEVELOPING: 发布待审核

  • PUBLISHED: 已发布

  • OFFLINE_DEVELOPING: 下线待审核

  • OFFLINE: 已下线

  • REJECT: 已驳回

approval_status

否

String

业务审批状态，只读。

枚举值：

  • DEVELOPING: 审核中

  • APPROVED: 审核通过

  • REJECT: 审核驳回

  • WITHDREW: 审核撤销

approval_type

否

String

业务审核类型。

枚举值：

  • PUBLISH: 发布

  • OFFLINE: 下线

submit_time

否

String

提交时间。

create_by

否

String

创建者。

l1

否

String

主题域分组中文名，只读，创建和更新时无需填写。

l2

否

String

主题域中文名，只读，创建和更新时无需填写。

l3

否

String

业务对象中文名，只读，创建和更新时无需填写。

approval_time

否

String

审核时间。

approver

否

String

审核人。

email

否

String

审核人邮箱。

msg

否

String

审核信息。

directory_path

否

String

目录树。
表5 BizVersionManageVO

参数

是否必选

参数类型

描述

id

否

String

ID信息，填写String类型替代Long类型。

biz_type

否

String

业务实体类型。

枚举值：

  • AGGREGATION_LOGIC_TABLE: 汇总表

  • ATOMIC_INDEX: 原子指标

  • ATOMIC_METRIC: 原子指标（新）

  • BIZ_CATALOG: 流程架构目录

  • BIZ_METRIC: 业务指标

  • CODE_TABLE: 码表

  • COMMON_CONDITION: 通用限定

  • COMPOSITE_METRIC: 复合指标（新）

  • COMPOUND_METRIC: 复合指标

  • CONDITION_GROUP: 限定分组

  • DEGENERATE_DIMENSION: 退化维度

  • DERIVATIVE_INDEX: 衍生指标

  • DERIVED_METRIC: 衍生指标（新）

  • DIMENSION: 维度

  • DIMENSION_ATTRIBUTE: 维度属性

  • DIMENSION_HIERARCHIES: 维度层级

  • DIMENSION_LOGIC_TABLE: 维度表

  • DIMENSION_TABLE_ATTRIBUTE: 维度属性

  • DIRECTORY: 目录

  • FACT_ATTRIBUTE: 事实表属性

  • FACT_DIMENSION: 事实表维度

  • FACT_LOGIC_TABLE: 事实表

  • FACT_MEASURE: 事实表度量

  • FUNCTION: 函数

  • INFO_ARCH: 信息架构（批量修改主题使用）

  • MODEL: 模型

  • QUALITY_RULE: 质量规则

  • SECRECY_LEVEL: 密级

  • STANDARD_ELEMENT: 数据标准

  • STANDARD_ELEMENT_TEMPLATE: 数据标准模板

  • SUBJECT: 主题

  • SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性

  • SUMMARY_INDEX: 汇总表指标属性

  • SUMMARY_TIME: 汇总表时间周期属性

  • TABLE_MODEL: 关系模型（逻辑模型/物理模型）

  • TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型）

  • TABLE_MODEL_LOGIC: 逻辑实体

  • TABLE_TYPE: 表类型

  • TAG: 标签

  • TIME_CONDITION: 时间限定

biz_id

否

String

业务ID，填写String类型替代Long类型。

biz_info

否

String

业务对象信息。

status

否

String

实体的发布状态，只读，创建和更新时无需填写。

枚举值：

  • DRAFT: 草稿

  • PUBLISH_DEVELOPING: 发布待审核

  • PUBLISHED: 已发布

  • OFFLINE_DEVELOPING: 下线待审核

  • OFFLINE: 已下线

  • REJECT: 已驳回

biz_version

否

Integer

业务版本，只读。

create_time

否

String

创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。

update_time

否

String

更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
表6 CodeTableFieldVO

参数

是否必选

参数类型

描述

id

否

String

码表字段ID，填写String类型替代Long类型。

code_table_id

否

String

所属码表ID，填写String类型替代Long类型。

ordinal

是

Integer

序号。

name_en

是

String

字段名，英文。

name_ch

是

String

字段名，中文。

description

否

String

描述。

data_type

是

String

字段类型。

domain_type

否

String

字段类型所属域。

枚举值：

  • NUMBER: 数字类型

  • STRING: 字符类型

  • DATETIME: 日期类型

  • BLOB: 大对象(BLOB)

  • OTHER: 其它类型

data_type_extend

否

String

数据类型扩展字段。

is_unique_key

否

Boolean

是否唯一。

code_table_field_values

否

Array of CodeTableFieldValueVO objects

码表属性值。

count_field_values

否

Integer

码表属性值总数。
表7 CodeTableFieldValueVO

参数

是否必选

参数类型

描述

id

否

String

码表字段ID，填写String类型替代Long类型。

fd_id

否

String

所属码表属性ID，填写String类型替代Long类型。

fd_value

否

String

码表属性值。

ordinal

否

Integer

序号。

description

否

String

描述。

响应参数

状态码： 200

表8 响应Body参数

参数

参数类型

描述

data

data object

data，统一的返回结果的最外层数据结构。
表9 data

参数

参数类型

描述

value

CodeTableVO object

码表结构。
表10 CodeTableVO

参数

参数类型

描述

id

String

码表ID，填写String类型替代Long类型。

name_en

String

表名称，英文名。

name_ch

String

表名称，中文名。

tb_version

Integer

表版本。

directory_id

String

目录ID，填写String类型替代Long类型。

directory_path

String

目录树。

description

String

描述。

create_by

String

创建人。

status

String

实体的发布状态，只读，创建和更新时无需填写。

枚举值：

  • DRAFT: 草稿

  • PUBLISH_DEVELOPING: 发布待审核

  • PUBLISHED: 已发布

  • OFFLINE_DEVELOPING: 下线待审核

  • OFFLINE: 已下线

  • REJECT: 已驳回

create_time

String

创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。

update_time

String

更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。

approval_info

ApprovalVO object

审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。

new_biz

BizVersionManageVO object

业务版本管理，只读。

code_table_fields

Array of CodeTableFieldVO objects

码表属性信息。
表11 ApprovalVO

参数

参数类型

描述

id

String

审批单ID，填写String类型替代Long类型。

tenant_id

String

项目ID，获取方式参考接口路径参数“project_id”。

name_ch

String

业务中文名。

name_en

String

业务英文名。

biz_id

String

业务ID，填写String类型替代Long类型。

biz_type

String

业务实体类型。

枚举值：

  • AGGREGATION_LOGIC_TABLE: 汇总表

  • ATOMIC_INDEX: 原子指标

  • ATOMIC_METRIC: 原子指标（新）

  • BIZ_CATALOG: 流程架构目录

  • BIZ_METRIC: 业务指标

  • CODE_TABLE: 码表

  • COMMON_CONDITION: 通用限定

  • COMPOSITE_METRIC: 复合指标（新）

  • COMPOUND_METRIC: 复合指标

  • CONDITION_GROUP: 限定分组

  • DEGENERATE_DIMENSION: 退化维度

  • DERIVATIVE_INDEX: 衍生指标

  • DERIVED_METRIC: 衍生指标（新）

  • DIMENSION: 维度

  • DIMENSION_ATTRIBUTE: 维度属性

  • DIMENSION_HIERARCHIES: 维度层级

  • DIMENSION_LOGIC_TABLE: 维度表

  • DIMENSION_TABLE_ATTRIBUTE: 维度属性

  • DIRECTORY: 目录

  • FACT_ATTRIBUTE: 事实表属性

  • FACT_DIMENSION: 事实表维度

  • FACT_LOGIC_TABLE: 事实表

  • FACT_MEASURE: 事实表度量

  • FUNCTION: 函数

  • INFO_ARCH: 信息架构（批量修改主题使用）

  • MODEL: 模型

  • QUALITY_RULE: 质量规则

  • SECRECY_LEVEL: 密级

  • STANDARD_ELEMENT: 数据标准

  • STANDARD_ELEMENT_TEMPLATE: 数据标准模板

  • SUBJECT: 主题

  • SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性

  • SUMMARY_INDEX: 汇总表指标属性

  • SUMMARY_TIME: 汇总表时间周期属性

  • TABLE_MODEL: 关系模型（逻辑模型/物理模型）

  • TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型）

  • TABLE_MODEL_LOGIC: 逻辑实体

  • TABLE_TYPE: 表类型

  • TAG: 标签

  • TIME_CONDITION: 时间限定

biz_info

String

序列化之后的业务详情，类型是string。

biz_info_obj

Object

业务详情，类型是object。

biz_version

Integer

业务版本。

biz_status

String

实体的发布状态，只读，创建和更新时无需填写。

枚举值：

  • DRAFT: 草稿

  • PUBLISH_DEVELOPING: 发布待审核

  • PUBLISHED: 已发布

  • OFFLINE_DEVELOPING: 下线待审核

  • OFFLINE: 已下线

  • REJECT: 已驳回

approval_status

String

业务审批状态，只读。

枚举值：

  • DEVELOPING: 审核中

  • APPROVED: 审核通过

  • REJECT: 审核驳回

  • WITHDREW: 审核撤销

approval_type

String

业务审核类型。

枚举值：

  • PUBLISH: 发布

  • OFFLINE: 下线

submit_time

String

提交时间。

create_by

String

创建者。

l1

String

主题域分组中文名，只读，创建和更新时无需填写。

l2

String

主题域中文名，只读，创建和更新时无需填写。

l3

String

业务对象中文名，只读，创建和更新时无需填写。

approval_time

String

审核时间。

approver

String

审核人。

email

String

审核人邮箱。

msg

String

审核信息。

directory_path

String

目录树。
表12 BizVersionManageVO

参数

参数类型

描述

id

String

ID信息，填写String类型替代Long类型。

biz_type

String

业务实体类型。

枚举值：

  • AGGREGATION_LOGIC_TABLE: 汇总表

  • ATOMIC_INDEX: 原子指标

  • ATOMIC_METRIC: 原子指标（新）

  • BIZ_CATALOG: 流程架构目录

  • BIZ_METRIC: 业务指标

  • CODE_TABLE: 码表

  • COMMON_CONDITION: 通用限定

  • COMPOSITE_METRIC: 复合指标（新）

  • COMPOUND_METRIC: 复合指标

  • CONDITION_GROUP: 限定分组

  • DEGENERATE_DIMENSION: 退化维度

  • DERIVATIVE_INDEX: 衍生指标

  • DERIVED_METRIC: 衍生指标（新）

  • DIMENSION: 维度

  • DIMENSION_ATTRIBUTE: 维度属性

  • DIMENSION_HIERARCHIES: 维度层级

  • DIMENSION_LOGIC_TABLE: 维度表

  • DIMENSION_TABLE_ATTRIBUTE: 维度属性

  • DIRECTORY: 目录

  • FACT_ATTRIBUTE: 事实表属性

  • FACT_DIMENSION: 事实表维度

  • FACT_LOGIC_TABLE: 事实表

  • FACT_MEASURE: 事实表度量

  • FUNCTION: 函数

  • INFO_ARCH: 信息架构（批量修改主题使用）

  • MODEL: 模型

  • QUALITY_RULE: 质量规则

  • SECRECY_LEVEL: 密级

  • STANDARD_ELEMENT: 数据标准

  • STANDARD_ELEMENT_TEMPLATE: 数据标准模板

  • SUBJECT: 主题

  • SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性

  • SUMMARY_INDEX: 汇总表指标属性

  • SUMMARY_TIME: 汇总表时间周期属性

  • TABLE_MODEL: 关系模型（逻辑模型/物理模型）

  • TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型）

  • TABLE_MODEL_LOGIC: 逻辑实体

  • TABLE_TYPE: 表类型

  • TAG: 标签

  • TIME_CONDITION: 时间限定

biz_id

String

业务ID，填写String类型替代Long类型。

biz_info

String

业务对象信息。

status

String

实体的发布状态，只读，创建和更新时无需填写。

枚举值：

  • DRAFT: 草稿

  • PUBLISH_DEVELOPING: 发布待审核

  • PUBLISHED: 已发布

  • OFFLINE_DEVELOPING: 下线待审核

  • OFFLINE: 已下线

  • REJECT: 已驳回

biz_version

Integer

业务版本，只读。

create_time

String

创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。

update_time

String

更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
表13 CodeTableFieldVO

参数

参数类型

描述

id

String

码表字段ID，填写String类型替代Long类型。

code_table_id

String

所属码表ID，填写String类型替代Long类型。

ordinal

Integer

序号。

name_en

String

字段名，英文。

name_ch

String

字段名，中文。

description

String

描述。

data_type

String

字段类型。

domain_type

String

字段类型所属域。

枚举值：

  • NUMBER: 数字类型

  • STRING: 字符类型

  • DATETIME: 日期类型

  • BLOB: 大对象(BLOB)

  • OTHER: 其它类型

data_type_extend

String

数据类型扩展字段。

is_unique_key

Boolean

是否唯一。

code_table_field_values

Array of CodeTableFieldValueVO objects

码表属性值。

count_field_values

Integer

码表属性值总数。
表14 CodeTableFieldValueVO

参数

参数类型

描述

id

String

码表字段ID，填写String类型替代Long类型。

fd_id

String

所属码表属性ID，填写String类型替代Long类型。

fd_value

String

码表属性值。

ordinal

Integer

序号。

description

String

描述。

状态码： 400

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DS.6000，请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码： 401

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DS.6000，请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码： 403

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DS.6000，请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码： 404

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DS.6000，请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

请求示例

根据请求参数，修改码表，返回的是修改后的码表信息。

PUT https://{endpoint}/v2/{project_id}/design/code-tables/1230204979835502592

{
  "name_en" : "DC000007",
  "name_ch" : "test_update_code_table",
  "description" : "",
  "code_table_fields" : [ {
    "ordinal" : 1,
    "name_ch" : "编码",
    "name_en" : "code",
    "data_type" : "STRING",
    "description" : "",
    "code_table_field_values" : [ ],
    "code_table_id" : "1230204979835502592",
    "id" : "178101"
  }, {
    "ordinal" : 2,
    "name_ch" : "省",
    "name_en" : "province",
    "data_type" : "STRING",
    "description" : "",
    "code_table_field_values" : [ ],
    "code_table_id" : "1230204979835502592",
    "id" : "178102"
  }, {
    "ordinal" : 3,
    "name_ch" : "市",
    "name_en" : "city",
    "data_type" : "STRING",
    "description" : "",
    "code_table_field_values" : [ ],
    "code_table_id" : "1230204979835502592",
    "id" : "178103"
  }, {
    "ordinal" : 4,
    "name_ch" : "县",
    "name_en" : "county",
    "data_type" : "STRING",
    "description" : "",
    "code_table_field_values" : [ ],
    "code_table_id" : "1230204979835502592",
    "id" : "178104"
  } ],
  "tb_version" : 0,
  "directory_id" : "1194963842254491648",
  "id" : "1230204979835502592"
}

响应示例

状态码： 200

Success，返回data数据是CodeTableVO。

{
  "data" : {
    "value" : {
      "id" : "1230204979835502592",
      "name_en" : "DC000007",
      "name_ch" : "test_update_code_table",
      "tb_version" : 0,
      "directory_id" : "1194963842254491648",
      "directory_path" : null,
      "description" : "",
      "create_by" : "ei_dayu_y00321344_01",
      "status" : "DRAFT",
      "create_time" : "2024-04-17T17:15:23+08:00",
      "update_time" : "2024-04-17T17:25:34.449+08:00",
      "approval_info" : null,
      "new_biz" : null,
      "code_table_fields" : [ {
        "id" : "178101",
        "code_table_id" : "1230204979835502592",
        "ordinal" : 1,
        "name_en" : "code",
        "name_ch" : "编码",
        "description" : "",
        "data_type" : "STRING",
        "domain_type" : null,
        "data_type_extend" : null,
        "is_unique_key" : false,
        "code_table_field_values" : [ ],
        "count_field_values" : null
      }, {
        "id" : "178102",
        "code_table_id" : "1230204979835502592",
        "ordinal" : 2,
        "name_en" : "province",
        "name_ch" : "省",
        "description" : "",
        "data_type" : "STRING",
        "domain_type" : null,
        "data_type_extend" : null,
        "is_unique_key" : false,
        "code_table_field_values" : [ ],
        "count_field_values" : null
      }, {
        "id" : "178103",
        "code_table_id" : "1230204979835502592",
        "ordinal" : 3,
        "name_en" : "city",
        "name_ch" : "市",
        "description" : "",
        "data_type" : "STRING",
        "domain_type" : null,
        "data_type_extend" : null,
        "is_unique_key" : false,
        "code_table_field_values" : [ ],
        "count_field_values" : null
      }, {
        "id" : "178104",
        "code_table_id" : "1230204979835502592",
        "ordinal" : 4,
        "name_en" : "county",
        "name_ch" : "县",
        "description" : "",
        "data_type" : "STRING",
        "domain_type" : null,
        "data_type_extend" : null,
        "is_unique_key" : false,
        "code_table_field_values" : [ ],
        "count_field_values" : null
      } ]
    }
  }
}

状态码： 400

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

状态码： 401

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

状态码： 403

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

状态码： 404

{
  "error_code" : "DS.60xx",
  "error_msg" : "The User Request API does not exist."
}

SDK代码示例

SDK代码示例如下。

根据请求参数，修改码表，返回的是修改后的码表信息。

  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
 
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 UpdateCodeTableSolution {

    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();
        UpdateCodeTableRequest request = new UpdateCodeTableRequest();
        request.withId("{id}");
        CodeTableVO body = new CodeTableVO();
        List<CodeTableFieldVO> listbodyCodeTableFields = new ArrayList<>();
        listbodyCodeTableFields.add(
            new CodeTableFieldVO()
                .withId(178101L)
                .withCodeTableId(1230204979835502592L)
                .withOrdinal(1)
                .withNameEn("code")
                .withNameCh("编码")
                .withDescription("")
                .withDataType("STRING")
                .withCodeTableFieldValues()
        );
        listbodyCodeTableFields.add(
            new CodeTableFieldVO()
                .withId(178102L)
                .withCodeTableId(1230204979835502592L)
                .withOrdinal(2)
                .withNameEn("province")
                .withNameCh("省")
                .withDescription("")
                .withDataType("STRING")
                .withCodeTableFieldValues()
        );
        listbodyCodeTableFields.add(
            new CodeTableFieldVO()
                .withId(178103L)
                .withCodeTableId(1230204979835502592L)
                .withOrdinal(3)
                .withNameEn("city")
                .withNameCh("市")
                .withDescription("")
                .withDataType("STRING")
                .withCodeTableFieldValues()
        );
        listbodyCodeTableFields.add(
            new CodeTableFieldVO()
                .withId(178104L)
                .withCodeTableId(1230204979835502592L)
                .withOrdinal(4)
                .withNameEn("county")
                .withNameCh("县")
                .withDescription("")
                .withDataType("STRING")
                .withCodeTableFieldValues()
        );
        body.withCodeTableFields(listbodyCodeTableFields);
        body.withDescription("");
        body.withDirectoryId(1194963842254491648L);
        body.withTbVersion(0);
        body.withNameCh("test_update_code_table");
        body.withNameEn("DC000007");
        body.withId(1230204979835502592L);
        request.withBody(body);
        try {
            UpdateCodeTableResponse response = client.updateCodeTable(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

根据请求参数，修改码表，返回的是修改后的码表信息。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
 
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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 = UpdateCodeTableRequest()
        request.id = "{id}"
        listCodeTableFieldsbody = [
            CodeTableFieldVO(
                id=178101,
                code_table_id=1230204979835502592,
                ordinal=1,
                name_en="code",
                name_ch="编码",
                description="",
                data_type="STRING",
            ),
            CodeTableFieldVO(
                id=178102,
                code_table_id=1230204979835502592,
                ordinal=2,
                name_en="province",
                name_ch="省",
                description="",
                data_type="STRING",
            ),
            CodeTableFieldVO(
                id=178103,
                code_table_id=1230204979835502592,
                ordinal=3,
                name_en="city",
                name_ch="市",
                description="",
                data_type="STRING",
            ),
            CodeTableFieldVO(
                id=178104,
                code_table_id=1230204979835502592,
                ordinal=4,
                name_en="county",
                name_ch="县",
                description="",
                data_type="STRING",
            )
        ]
        request.body = CodeTableVO(
            code_table_fields=listCodeTableFieldsbody,
            description="",
            directory_id=1194963842254491648,
            tb_version=0,
            name_ch="test_update_code_table",
            name_en="DC000007",
            id=1230204979835502592
        )
        response = client.update_code_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)

根据请求参数，修改码表，返回的是修改后的码表信息。

  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
 
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.UpdateCodeTableRequest{}
	request.Id = "{id}"
	idCodeTableFields:= int64(178101)
	codeTableIdCodeTableFields:= int64(1230204979835502592)
	descriptionCodeTableFields:= ""
	idCodeTableFields1:= int64(178102)
	codeTableIdCodeTableFields1:= int64(1230204979835502592)
	descriptionCodeTableFields1:= ""
	idCodeTableFields2:= int64(178103)
	codeTableIdCodeTableFields2:= int64(1230204979835502592)
	descriptionCodeTableFields2:= ""
	idCodeTableFields3:= int64(178104)
	codeTableIdCodeTableFields3:= int64(1230204979835502592)
	descriptionCodeTableFields3:= ""
	var listCodeTableFieldsbody = []model.CodeTableFieldVo{
        {
            Id: &idCodeTableFields,
            CodeTableId: &codeTableIdCodeTableFields,
            Ordinal: int32(1),
            NameEn: "code",
            NameCh: "编码",
            Description: &descriptionCodeTableFields,
            DataType: "STRING",
        },
        {
            Id: &idCodeTableFields1,
            CodeTableId: &codeTableIdCodeTableFields1,
            Ordinal: int32(2),
            NameEn: "province",
            NameCh: "省",
            Description: &descriptionCodeTableFields1,
            DataType: "STRING",
        },
        {
            Id: &idCodeTableFields2,
            CodeTableId: &codeTableIdCodeTableFields2,
            Ordinal: int32(3),
            NameEn: "city",
            NameCh: "市",
            Description: &descriptionCodeTableFields2,
            DataType: "STRING",
        },
        {
            Id: &idCodeTableFields3,
            CodeTableId: &codeTableIdCodeTableFields3,
            Ordinal: int32(4),
            NameEn: "county",
            NameCh: "县",
            Description: &descriptionCodeTableFields3,
            DataType: "STRING",
        },
    }
	descriptionCodeTableVo:= ""
	tbVersionCodeTableVo:= int32(0)
	idCodeTableVo:= int64(1230204979835502592)
	request.Body = &model.CodeTableVo{
		CodeTableFields: listCodeTableFieldsbody,
		Description: &descriptionCodeTableVo,
		DirectoryId: int64(1194963842254491648),
		TbVersion: &tbVersionCodeTableVo,
		NameCh: "test_update_code_table",
		NameEn: "DC000007",
		Id: &idCodeTableVo,
	}
	response, err := client.UpdateCodeTable(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success，返回data数据是CodeTableVO。

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found
父主题： 码表管理接口
分享：

    相关文档

    相关产品