华为云用户手册

响应示例 状态码： 200 查询智能分析助手列表成功。 { "count" : 1, "page_data" : [ { "name" : "xxxxxxxxx", "subject_id" : "xxxxxxxxxxxxx", "comments" : "", "status" : 3, "permission_list" : [ "edit", "use" ], "workspace_id" : "xx4xxaxxxxac8x51xxx30", "project_id" : "xxb4dxx4xxx886xx33xx27", "create_user" : "xxxb4xxx4b0baxxxxx0dc18xxx3", "create_user_name" : "xxv_l00xxxx", "create_date" : 1702046652513, "update_user" : "xxxxxxx4b0xxxb8xxxx27x", "update_user_name" : "xxv_l00xxxx", "update_date" : 1710496061316, "datasets" : [ { "dataset_id" : "xxxxxxxxxxxxx", "name" : "xxxxxxxxxx" } ], "recommended_questions" : "xxxxxxxxxxxxx" } ] }

URI GET /v1/{project_id}/subjects 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 最小长度：0 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 keyword 否 String 智能分析助手名称。 最小长度：0 最大长度：128 sort_dir 否 String 排序类别： desc：倒序。 asc：正序。 最小长度：0 最大长度：128 枚举值： desc asc sort_key 否 String 排序字段。 最小长度：0 最大长度：128 limit 否 Integer 返回条目数。不传该参数时，默认查询前10条信息。 最小值：0 最大值：1000 缺省值：10 offset 否 Integer 返回条目的起始offset。 最小值：0 最大值：1000 缺省值：0

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总条目数。 最小值：0 最大值：2147483647 page_data Array of ExtSubjectVO objects 当前页的数据，元素类型为ExtSubjectVO。 数组长度：0 - 1000000 表5 ExtSubjectVO 参数 参数类型 描述 name String 智能分析助手名称。 最小长度：0 最大长度：128 id String 智能分析助手ID。 最小长度：0 最大长度：128 comments String 智能分析助手描述。 最小长度：0 最大长度：128 status Integer 智能分析助手状态。初始化（0），图构建（1），索引构建（2），训练成功（3），训练失败（4），训练停止（5）。 最小值：0 最大值：5 枚举值： 0 1 2 3 4 5 permission_list Array of strings 当前用户拥有的协同授权权限点：edit、export、use、read。 数组长度：0 - 10000 workspace_id String 智能分析助手所属工作空间ID。 最小长度：0 最大长度：128 project_id String 智能分析助手所属的项目ID。 最小长度：0 最大长度：128 create_user String 智能分析助手的创建者。 最小长度：0 最大长度：128 create_user_name String 智能分析助手的创建者名称。 最小长度：0 最大长度：128 create_date Long 智能分析助手的创建时间。 最小值：0 最大值：9223372036854774807 update_user String 智能分析助手的更新者。 最小长度：0 最大长度：128 update_user_name String 智能分析助手的更新者名称。 最小长度：0 最大长度：128 update_date Long 智能分析助手的更新时间。 最小值：0 最大值：9223372036854774807 datasets Array of ExtSubjectDatasetVO objects 智能分析助手关联数据集列表。 recommended_questions String 智能分析助手的推荐问题。 最小长度：0 最大长度：128 表6 ExtSubjectDatasetVO 参数 参数类型 描述 dataset_id String 数据集ID。 最小长度：0 最大长度：128 name String 数据集名称。 最小长度：0 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 仪表板ID。 最小长度：0 最大长度：128 name 是 String 仪表板名称。 最小长度：1 最大长度：32

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 仪表板ID。 最小长度：0 最大长度：128 name String 仪表板名称。 最小长度：1 最大长度：32 create_user_name String 创建者。 最小长度：0 最大长度：128 create_date Long 创建时间戳。 最小值：0 最大值：9007199254740991 update_user_name String 更新者。 最小长度：0 最大长度：128 update_date Long 更新时间戳。 最小值：0 最大值：9007199254740991 status Integer 仪表板状态： 0：未发布。 1：已发布。 2：已下线。 枚举值： 0 1 2

响应示例 状态码： 200 更新仪表板成功。 { "id" : "009b3d3e-xxxx-4cc3-xxxx-dc54cd42424d", "name" : "更新仪表板", "create_user_name" : "xxxx", "create_date" : 1706062051243, "update_user_name" : "xxxx", "update_date" : 1706062051243, "status" : 0 }

URI GET /v1/{project_id}/quota-users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 最小长度：0 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 account_name 否 String 用户名（模糊搜索）。 最小长度：0 最大长度：512 sys_role 否 String 系统角色： 1通用角色； 2只读用户。 最小长度：0 最大长度：128 type 否 String 角色类型：IAM、SELF-BUILT 最小长度：0 最大长度：128 sort_key 否 String 排序字段：effectiveTime、accountName 最小长度：0 最大长度：128 sort_dir 否 String 排序方式：desc、asc 最小长度：0 最大长度：128 offset 否 Integer 页数，默认0 最小值：0 最大值：1000 limit 否 Integer 每页数据数，默认10 最小值：0 最大值：1000

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 数据总量。 最小值：0 最大值：2147483647 page_data Array of 表5 objects 数据 数组长度：0-2147483647 表5 page_data 参数 参数类型 描述 user_id String 用户id 最小长度：0 最大长度：128 account_name String 用户名称 最小长度：0 最大长度：512 user_type String 用户类型, IAM|SELF-BUILT|DEFAULT 最小长度：0 最大长度：128 sys_role Integer 用户角色： 0未激活； 1通用角色； 2只读用户。 最小值：0 最大值：128 枚举值： 0 1 2 effective_time Long 生效时间戳。 最小值：0 最大值：9223372036854775807

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 表3 请求Body参数 参数 是否必选 参数类型 描述 subject_id 是 String 智能分析助手ID。 最小长度：0 最大长度：128 dialog_id 是 String 对话ID。如果不想触发多轮问答能力，需每次调用请求时传入不同的dialog_id。 最小长度：0 最大长度：128 message_content 是 String 查询问题。 最小长度：0 最大长度：128 need_insight 否 Boolean 是否需要智能见解。

请求示例 自然语言查数。 POST https://{endpoint}/v1/{project_id}/nl-query { "message_content" : "去年11月公司的收入是多少", "dialog_id" : "66xxxx02x5axxx9xx12fxxx9c2xxxx6d", "subject_id" : "xa4axxx4-9xx9-4xx2-9xxx-3axxxxf4a5c3" }

响应示例 状态码： 200 nl-query请求返回体。 { "query_data" : [ [ { "caption" : "收入", "data_type" : "NUMBER", "level_type" : null, "cell_raw_value" : null, "cell_value" : "收入", "model_type" : "measure", "cell_converted_value" : null }, { "caption" : "收入", "data_type" : "NUMBER", "level_type" : null, "cell_raw_value" : "423xxx214.32", "cell_value" : "423xxx214.32", "model_type" : "measure", "cell_converted_value" : null } ] ], "sql_text" : "SELECT xxx AS xxx FROM xxx.xxx AS xxx", "insight" : "查询结果: 去年11月公司的收入为xxx。建议探索的方向：xxx。业务建议：xxx。" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 执行批量操作仪表板ID列表。 最小长度：0 最大长度：120 数组长度：1 - 128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 执行批量操作仪表板ID列表。 最小长度：0 最大长度：120 数组长度：1 - 128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 是 Array of resources objects 待查询血缘关系的资源信息列表。 数组长度：1 - 50 表4 resources 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型。枚举值： datasource：数据源。 dataset：数据集。 metric：指标。 dashboard：仪表板。 screen：大屏。 embedAnalysis：嵌入分析。 subject：智能分析助手。 最小长度：1 最大长度：50 resource_id 是 String 资源ID。 最小长度：1 最大长度：64

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 resources Array of ResourceRelationDetailVO objects 资源血缘关系列表。 数组长度：0 - 50 workspace_id String 项目ID。 最小长度：0 最大长度：64 表6 ResourceRelationDetailVO 参数 参数类型 描述 resource_id String 资源ID。 最小长度：0 最大长度：64 resource_name String 资源名称。 最小长度：0 最大长度：255 resource_type String 资源类型。枚举值： datasource：数据源。 dataset：数据集。 metric：指标。 dashboard：仪表板。 screen：大屏。 embedAnalysis：嵌入分析。 portal：数据门户。 最小长度：1 最大长度：32 relations Array of ResourceRelationDetailVO objects 依赖资源列表。 数组长度：0 - 200

响应示例 状态码： 200 查询资源血缘关系成功。 { "resources" : [ { "resource_id" : "96334c9923****0a0035dff29a7582b", "resource_name" : "测试数据门户", "resource_type" : "portal", "relations" : [ { "resource_id" : "2545c456-****-a6d4-dd8419cac54a", "resource_name" : "大屏", "resource_type" : "screen", "relations" : [ ] }, { "resource_id" : "12e25f5f-4*****-8468-bdf69c25438f", "resource_name" : "仪表板", "resource_type" : "dashboard", "relations" : [ { "resource_id" : "980bc5e2-******4-a168-4d344065bcb3", "resource_name" : "数据集", "resource_type" : "dataset", "relations" : [ { "resource_id" : "c4d84a8******ba190c5cabf75dfe", "resource_name" : "datasource", "resource_type" : "datasource", "relations" : [ ] } ] } ] } ] } ], "workspace_id" : "e10aa3****e713d779c65e74" }

请求示例 查询资源血缘关系。 POST https://{endpoint}/v1/0e****127d****6b7****95750da/resources/relationships { "resources" : [ { "resource_type" : "portal", "resource_id" : "96334c9****4510a0035dff29a7582b" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 执行批量操作仪表板id列表。 最小长度：0 最大长度：120 数组长度：1 - 128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192 表3 请求Body参数 参数 是否必选 参数类型 描述 user_id_list 是 Array of strings 用户id列表。 最小长度：0 最大长度：512 数组长度：1-128 sys_role 是 Integer 用户角色： 0未激活； 1通用角色； 2只读用户。 最小值：0 最大值：128

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of 表5 objects - 表5 UserQuotaVo 参数 参数类型 描述 user_id String 用户id。 最小长度：0 最大长度：128 account_name String 用户名称。 最小长度：0 最大长度：512 user_type String 用户类型,：IAM|SELF-BUILT|DEFAULT 最小长度：0 最大长度：128 sys_role Integer 用户角色： 0未激活； 1通用角色； 2只读用户。 最小值：0 最大值：128 effective_time Long 生效时间戳。 最小值：0 最大值：9223372036854775807

URI GET /v1/{project_id}/quota-users/all 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 最小长度：0 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 account_name 否 String 用户名（模糊查询）。 最小长度：0 最大长度：512 sys_role_list 否 Array 系统角色 0未激活； 1通用用户； 2只读用户。 数组长度：0 - 3

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 resource_id String 资源ID。 最小长度：0 最大长度：128 root_resource_id String 根ID。 最小长度：0 最大长度：128 resource_type String 资源类型。 最小长度：0 最大长度：128 workspace_id String 工作空间ID。 最小长度：0 最大长度：128

响应示例 状态码： 200 { "root_resource_id" : "0cc302c0-xxxxxxx-8bdf-0f726fb36eb4", "resource_type" : "screen", "resource_id" : "2befed28-xxxxx-83df-dbc88e47ee12", "workspace_id" : "b8cbb94cce8xxxxxxx7d8e5498af5dd" }

请求示例 POST https://{endpoint}/v1/{project_id}/datasets/save { "id" : "string", "caption" : "id", "status" : "string", "description" : "string", "ds_id" : "string", "ds_name" : "string", "ds_type" : "string", "table_type" : "table|sql", "resource_code" : "string", "physical_schema" : { "tables" : [ { "database_name" : "db_test", "is_fact_table" : false, "schema_name" : "public", "sql_text" : "SELECT * FROM FACT_GDP", "table_name" : "t_test", "table_type" : "table" } ] }, "logical_schema" : { "field_schema" : { "columns" : [ { "caption" : "age", "origin_column_name" : "age", "schema_name" : "public", "table_name" : "modern_bi_0xxxx1c590b14d9xxxx35227166f7f02" } ] }, "variables" : [ { "default_values" : [ "aaa", "bbb" ], "format" : "yyyy-MM-dd", "name" : "limit", "type" : "STRING", "use_scope" : "dataset" } ], "relations" : [ { "source_database_name" : "string", "source_schema" : "string", "source_table_name" : "string", "target_database_name" : "string", "target_schema" : "string", "target_table_name" : "string", "join_type" : "string", "relation" : "string", "joins" : [ { "condition" : "equal-to", "source_key" : "city", "target_key" : "city" } ] } ] } }

响应参数 状态码： 200 表12 响应Body参数 参数 参数类型 描述 caption String 数据集语义化名称。 最小长度：0 最大长度：128 domain_id String 租户ID。 最小长度：0 最大长度：128 ds_id String 数据源ID。 最小长度：0 最大长度：128 ds_type String 数据源类型。 最小长度：0 最大长度：128 id String 数据集ID。 最小长度：0 最大长度：128 logical_schema 表13 object 数据集逻辑schema。 physical_schema 表22 object 数据集物理schema。 project_id String 项目ID。 最小长度：0 最大长度：128 version String 数据集版本：默认为2.0，1.0|2.0。 最小长度：0 最大长度：128 workspace_id String 项目ID（DataArts Insight侧概念）。 最小长度：0 最大长度：128 create_date Long 创建时间戳。 最小值：0 最大值：9223372036854775807 create_user String 创建者ID。 最小长度：0 最大长度：128 create_user_name String 创建者名称。 最小长度：0 最大长度：128 update_date Long 更新时间戳。 最小值：0 最大值：9223372036854775807 update_user String 更新者ID。 最小长度：0 最大长度：128 update_user_name String 更新者名称。 最小长度：0 最大长度：128 resource_code String 数据集资源标识。 最小长度：0 最大长度：64 表13 LogicalSchema 参数 参数类型 描述 field_schema 表14 object 字段schema。 relations Array of 表19 objects 物理表关系。 数组长度：0-2147483647 variables Array of 表21 objects SQL变量列表。 数组长度：0-2147483647 表14 DatasetFieldSchemaVO 参数 参数类型 描述 dimensions Array of 表15 objects 维度 数组长度：0-2147483647 measures Array of 表18 objects 度量 数组长度：0-2147483647 表15 DimensionVo 参数 参数类型 描述 caption String 维度语义化名。 最小长度：0 最大长度：128 cube_id String 维度所属物理表ID。 最小长度：0 最大长度：128 description String 维度描述。 最小长度：0 最大长度：1000 id String 维度ID。 最小长度：0 最大长度：128 hierarchies Array of 表16 objects 维度层级。 数组长度：0-2147483647 表16 Hierarchy 参数 参数类型 描述 caption String 层级结构语义化名。 最小长度：0 最大长度：128 levels Array of 表17 objects 层级结构level。 数组长度：0-2147483647 表17 LevelVO 参数 参数类型 描述 caption String 语义化名。 最小长度：0 最大长度：128 column_formula String level表达式。 最小长度：0 最大长度：128 data_type String 字段类型，STRING|DATE|DATETIME。 枚举值： STRING|DATE|DATETIME expansion_type Integer 扩展字段类型：0-普通扩展字段；1-聚合扩展字段。 最小值：0 最大值：1 id String ID 最小长度：0 最大长度：128 is_expansion Integer 是否为扩展字段：0-不是、1-是。 枚举值： 0 1 level_type String level类型。 最小长度：0 最大长度：128 origin_column_name String 原始字段名称。 最小长度：0 最大长度：128 origin_column_type String 原始字段类型。 最小长度：0 最大长度：128 origin_data_type String 转换前的数据类型，STRING|DATE|DATETIME。 最小长度：0 最大长度：128 枚举值： STRING|DATE|DATETIME 表18 MeasureVo 参数 参数类型 描述 caption String 度量语义化名。 最小长度：0 最大长度：128 column_formula String 度量字段表达式。 最小长度：0 最大长度：1000 cube_id String 字段所属物理表id 最小长度：0 最大长度：128 data_type String 数据类型，STRING|NUMBER|DATE|DATETIME。 最小长度：0 最大长度：128 枚举值： STRING|NUMBER|DATE|DATETIME expansion_type Integer 扩展字段类型，0-普通扩展字段 1-聚合扩展字段。 最小值：0 最大值：1 id String 度量ID。 最小长度：0 最大长度：128 is_expansion Integer 是否为扩展字段：0-不是，1-是。 最小值：0 最大值：1 origin_column_name String 原始字段名称。 最小长度：0 最大长度：128 origin_column_type String 原始字段类型。 最小长度：0 最大长度：128 origin_data_type String 转换前的数据类型，STRING|NUMBER|DATE|DATETIME。 最小长度：0 最大长度：128 枚举值： STRING|NUMBER|DATE|DATETIME 表19 DatasetRelationVO 参数 参数类型 描述 join_type String 关联类型，left join|right join|inner join。 最小长度：0 最大长度：128 joins Array of 表20 objects 关联键。 数组长度：0-2147483647 relation String 关系类型，one-to-one|one-to-many|many-to-one。 最小长度：0 最大长度：128 source String 源表ID。 最小长度：0 最大长度：128 target String 目标表ID。 最小长度：0 最大长度：128 表20 DatasetJoinVO 参数 参数类型 描述 condition String 关系，equal-to。 最小长度：0 最大长度：128 source_key String 源字段id。 最小长度：0 最大长度：128 source_type String 源字段类型：dimension|measure。 最小长度：0 最大长度：64 target_key String 目标字段ID。 最小长度：0 最大长度：128 target_type String 目标字段类型：dimension|measure。 最小长度：0 最大长度：64 表21 SqlVariable 参数 参数类型 描述 default_values Array of objects 变量默认值。 数组长度：0-3000 format String 变量格式，针对日期时间类型变量有效。 最小长度：0 最大长度：128 name String 变量名称。 最小长度：0 最大长度：128 type String 变量类型，STRING|NUMBER|DATE|DATETIME|TIMESTAMP。 枚举值： STRING|NUMBER|DATE|DATETIME|TIMESTAMP use_scope String 变量作用域，dataset|global。 最小长度：0 最大长度：128 表22 PhysicalSchema 参数 参数类型 描述 tables Array of 表23 objects 物理表信息。 数组长度：0-2147483647 表23 DatasetTableVO 参数 参数类型 描述 id String 表ID。 最小长度：0 最大长度：64 database_name String 数据库。 最小长度：0 最大长度：128 schema_name String schema名称。 最小长度：0 最大长度：128 table_name String 表名。 最小长度：0 最大长度：128 table_type String 数据集类型。 最小长度：0 最大长度：128 sql_text String 查询SQL。 最小长度：0 最大长度：5000 is_fact_table Boolean 是否为端点表。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：128 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 数据集ID。 最小长度：0 最大长度：128 caption 是 String 数据集语义化名称。 最小长度：0 最大长度：128 status 否 String 数据集状态：0，1。 最小长度：0 最大长度：128 description 否 String 数据集描述。 最小长度：0 最大长度：1000 ds_id 是 String 数据源ID。 最小长度：0 最大长度：128 ds_name 否 String 数据源名称。 最小长度：0 最大长度：128 ds_type 否 String 数据源类型。 最小长度：0 最大长度：128 table_type 是 String 数据集类型： table：不含自定义SQL表的数据集。 sql：含自定义SQL表的数据集。 最小长度：0 最大长度：128 resource_code 否 String 数据集资源标识。 最小长度：0 最大长度：64 physical_schema 是 表4 object 数据集物理schema。 logical_schema 是 表6 object 数据集逻辑schema。 表4 PhysicalOpenApiSchema 参数 是否必选 参数类型 描述 tables 是 Array of 表5 objects 物理表信息。 数组长度：0-2147483647 表5 DatasetTableOpenApiVO 参数 是否必选 参数类型 描述 database_name 是 String 数据库。 最小长度：0 最大长度：128 is_fact_table 是 Boolean 是否为端点表。 schema_name 否 String 模式。 最小长度：0 最大长度：128 sql_text 否 String 查询SQL。 最小长度：0 最大长度：128 table_name 是 String 表名。 最小长度：0 最大长度：128 table_type 是 String 表类型： table：物理表。 sql：自定义SQL表。 最小长度：0 最大长度：128 表6 LogicalSchemaOpenApiVO 参数 是否必选 参数类型 描述 filed_schema 否 表7 object 字段选择信息。 variables 否 Array of 表9 objects SQL变量列表。 数组长度：0-2147483647 relations 否 Array of 表10 objects 物理表关系 数组长度：0-2147483647 表7 DatasetFieldSchemaOpenApiVO 参数 是否必选 参数类型 描述 columns 否 Array of 表8 objects 字段选择列表和字段名称赋值。 数组长度：0-10000 表8 ColumnOpenApiVO 参数 是否必选 参数类型 描述 caption 是 String 字段名称。 最小长度：0 最大长度：512 origin_column_name 是 String 字段物理名称，即表中名称。 最小长度：0 最大长度：64 schema_name 否 String 字段所属schema。 最小长度：0 最大长度：64 table_name 是 String 字段所属名 最小长度：0 最大长度：64 表9 SqlVariable 参数 是否必选 参数类型 描述 default_values 否 Array of objects 变量默认值。 数组长度：0-3000 format 否 String 变量格式，针对日期时间类型变量有效。 最小长度：0 最大长度：128 name 是 String 变量名称 最小长度：0 最大长度：128 type 是 String 变量类型：STRING|NUMBER|DATE|DATETIME|TIMESTAMP 枚举值： STRING|NUMBER|DATE|DATETIME|TIMESTAMP use_scope 是 String 变量作用域，dataset|global。 最小长度：0 最大长度：128 表10 DatasetRelationOpenApiVO 参数 是否必选 参数类型 描述 source_database_name 是 String 源表所属数据库名称。 最小长度：0 最大长度：128 source_schema 否 String 源表所属schema名称。 最小长度：0 最大长度：64 source_table_name 是 String 源表名称。 最小长度：0 最大长度：64 target_database_name 是 String 目标表所属数据库名称。 最小长度：0 最大长度：128 target_schema 否 String 目标表所属schema名称。 最小长度：0 最大长度：64 target_table_name 是 String 目标表名称。 最小长度：0 最大长度：64 join_type 是 String 关联类型。 最小长度：0 最大长度：128 relation 是 String 关系类型。 最小长度：0 最大长度：128 joins 是 Array of 表11 objects 关联键 数组长度：0-2147483647 表11 DatasetJoinOpenApiVO 参数 是否必选 参数类型 描述 condition 是 String 关联关系，默认equal-to。 最小长度：0 最大长度：128 source_key 是 String 源表字段。 最小长度：0 最大长度：128 target_key 是 String 目标表字段。 最小长度：0 最大长度：128

响应示例 状态码：200 查询数据集和目录列表成功。 { "count" : 216, "page_data" : [ { "id" : "4df79d49-444c-xxxxx-28f9cfeac554", "name" : "保存数据集", "type" : "table", "permission_list" : [ "edit", "use" ], "workspace_id" : "e77ff0dxxxxxxx1b59fac2cc12faa146f", "project_id" : "34ba64e53a02xxxxxxx75669a8cc17bd", "create_user" : "558def45cexxxxxxxxa20e463e017", "create_user_name" : "xxxxxxxxx", "create_date" : 1704533906073, "update_user" : "558def4xxxxxxxxx648a20e463e017", "update_user_name" : "xxxxxxxx", "update_date" : 1704533906073, "description" : null, "ds_id" : "ff8080818xxxxxxf101886aab31a900e1", "ds_type" : "DWS", "ds_name" : "dws04_public", "routing_strategy" : "Direct", "resource_code" : "xxx" } ] }

URI GET /v1/{project_id}/datasets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 最小长度：0 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 数据集名称。 最小长度：0 最大长度：128 sort_dir 否 String 是否降序。 最小长度：0 最大长度：128 sort_key 否 String 排序字段。 最小长度：0 最大长度：128 limit 否 Integer 返回条目数。不传该参数时，默认查询前10条信息。取值范围：[0,1000] 默认值：10。 最小值：0 最大值：1000 offset 否 Integer 返回条目的起始offset。取值范围：[0,1000] 默认值：0。 最小值：0 最大值：1000

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192