# 查询码表列表 - SearchCodeTables #### 功能介绍 查询码表列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v2/{project_id}/design/code-tables 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 按名称或编码模糊查询。 | | name_ch | 否 | String | 按名称精确查询。 | | name_en | 否 | String | 按编码精确查询。 | | create_by | 否 | String | 按创建者查询。 | | approver | 否 | String | 按审核人查询。 | | directory_id | 否 | String | 目录ID，ID字符串。 | | status | 否 | String | 业务状态。 枚举值： - DRAFT: 草稿 - PUBLISH_DEVELOPING: 发布待审批 - PUBLISHED: 已发布 - OFFLINE_DEVELOPING: 下线待审批 - OFFLINE: 已下线 - REJECT: 已驳回 | | begin_time | 否 | String | 时间过滤左边界，与end_time一起使用，只支持时间范围过滤，单边过滤无效。格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 | | end_time | 否 | String | 时间过滤右边界，与begin_time一起使用只支持时间范围过滤，单边过滤无效。格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 | | limit | 否 | Integer | 每页查询条数，即查询Y条数据。默认值50，取值范围\[1,100\]。 | | offset | 否 | Integer | 查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整，默认值0。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 使用Token认证时必选。 | | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | | X-Project-Id | 否 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 多project场景采用AK/SK认证的接口请求，则该字段必选。 | | Content-Type | 否 | String | 默认值：application/json;charset=UTF-8 可选，有Body体的情况下必选，没有Body体则无需填写和校验。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [data] object | data，统一的返回结果的最外层数据结构。 | 表5data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | [value] object | value，统一的返回结果的外层数据结构。 | 表6value | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 总量。 | | records | Array of [CodeTableVO] objects | 查询到的码表对象（CodeTableVO）数组。 | 表7CodeTableVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 码表ID，ID字符串。 | | name_en | String | 表名称，英文名。 | | name_ch | String | 表名称，中文名。 | | tb_version | Integer | 表版本。 | | directory_id | String | 目录ID，ID字符串。 | | 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 | 码表属性信息。 | 表8ApprovalVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 审批单ID，ID字符串。 | | tenant_id | String | 项目ID，获取方式参考接口路径参数"project_id"。 | | name_ch | String | 业务中文名。 | | name_en | String | 业务英文名。 | | biz_id | String | 业务ID，ID字符串。 | | 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 | 目录树。 | 表9BizVersionManageVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | ID信息，ID字符串。 | | 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，ID字符串。 | | 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。 | 表10CodeTableFieldVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 码表字段ID，ID字符串。 | | code_table_id | String | 所属码表ID（更新时必填），ID字符串。 | | ordinal | Integer | 序号。 | | name_en | String | 字段名，英文。 | | name_ch | String | 字段名，中文。 | | description | String | 描述。 | | data_type | String | 字段类型。 枚举值： - BIGINT: 长整型 - STRING: 字符类型 - DATE: 日期类型 | | 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 | 码表属性值总数。 | 表11CodeTableFieldValueVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 码表字段ID，ID字符串。 | | fd_id | String | 所属码表属性ID，ID字符串。 | | fd_value | String | 码表属性值。 | | ordinal | Integer | 序号。 | | description | String | 描述。 | **状态码：400** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：401** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：403** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：404** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | #### 请求示例 获取前十条码表列表信息。 ``` GET https://{endpoint}/v2/{project_id}/design/code-tables?offset=1&limit=10 ``` #### 响应示例 **状态码：200** Success，返回data数据是CodeTableVO 数组，以及总数。 ``` { "data" : { "value" : { "total" : 10, "records" : [ { "id" : "1014131824240230400", "name_en" : "test", "name_ch" : "test", "tb_version" : 0, "directory_id" : "1012307270173851648", "directory_path" : null, "description" : "", "create_by" : "abc", "status" : "DRAFT", "create_time" : "2022-08-30T11:17:48.557+08:00", "update_time" : "2022-08-30T11:17:48.557+08:00", "approval_info" : null, "new_biz" : null, "code_table_fields" : [ { "id" : null, "code_table_id" : null, "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" : null, "code_table_id" : null, "ordinal" : 2, "name_en" : "value", "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** BadRequest ``` { "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." } ``` **状态码：401** Unauthorized ``` { "error_code" : "DS.60xx", "error_msg" : "User authentication failed." } ``` **状态码：403** Forbidden ``` { "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." } ``` **状态码：404** Not Found ``` { "error_code" : "DS.60xx", "error_msg" : "The User Request API does not exist." } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class SearchCodeTablesSolution { 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("")) .build(); SearchCodeTablesRequest request = new SearchCodeTablesRequest(); try { SearchCodeTablesResponse response = client.searchCodeTables(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = SearchCodeTablesRequest() response = client.search_code_tables(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.SearchCodeTablesRequest{} response, err := client.SearchCodeTables(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=SearchCodeTables)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success，返回data数据是CodeTableVO 数组，以及总数。 | | 400 | BadRequest | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found |