华为云用户手册

URI GET /v1/{project_id}/resources/{resource_type} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 最小长度：0 最大长度：128 resource_type 是 String 资源类型。 最小长度：0 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移值。 最小值：0 缺省值：0 limit 否 Integer 返回列表数量。 最小值：10 缺省值：10 sort_key 否 String 排序字段。 sort_dir 否 String 排序类别： desc：倒序。 asc：正序。 缺省值：asc

响应示例 状态码： 200 查询资源列表成功。 { "count" : 1, "page_data" : [ { "id" : "e2xxxx66f-81bxxxxxx9c38-80xxx0fxx9c84", "name" : "未命名大屏1", "create_user_name" : "dat***ig***", "create_date" : 1707215155901, "update_user_name" : "dat***ig***", "update_date" : 1707215155901, "status" : 0 } ] }

响应示例 { "row_permission_config" : { "is_open" : true, "is_open_by_condition" : true, "others_has_permission_by_condition" : false, "is_open_by_tag" : true }, "col_permission_config" : { "is_open" : true } }

响应参数 表3 响应Body参数 参数 参数类型 描述 row_permission_config object 行级权限配置。具体请参考表4。 col_permission_config object 列级权限配置。具体请参考表5。 表4 row_permission_config 参数 参数类型 描述 is_open Boolean 是否开启行权限。 is_open_by_condition Boolean 是否开启条件组合授权。 others_has_permission_by_condition Boolean 其他用户（未在行级条件组合授权中指定）的权限。 is_open_by_tag Boolean 行列权限额外配置，如是否开启行级条件组合授权。 表5 col_permission_config 参数 参数类型 描述 is_open Boolean 是否开启列权限。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 col_permission_config 否 object 列级权限配置。具体请参考表4。 row_permission_config 否 object 行级权限配置。具体请参考表5。 表4 ColPermissionConfig 参数 是否必选 参数类型 描述 is_open 否 Boolean 是否开启列权限。 表5 RowPermissionConfig 参数 是否必选 参数类型 描述 is_open 否 Boolean 是否开启行权限。 is_open_by_condition 否 Boolean 是否开启条件组合授权。 is_open_by_tag 否 Boolean 行列权限额外配置，是否开启行级条件组合授权。 others_has_permission_by_condition 否 Boolean 其他用户（未在行级条件组合授权中指定）的权限。

响应示例 状态码：200 获取数据集详情成功。 { "create_date" : 1705458279173, "create_user" : "cfcxxxx4501811aedcxxxxbbfe8", "create_user_name" : "xxxxxxx", "update_date" : 1705458279173, "update_user" : "cfcc77xxxx364501811aedcxxxxbbfe8", "update_user_name" : "xxxxxxx", "project_id" : "34ba64e53axxxb68cd7xxxxa8cc17bd", "workspace_id" : "d39157xxxx5f43c2bdxxxx74792b2d5e", "id" : "b745d57b-xxxx-4f2a-xxxx-3c0ff5fcf92f", "caption" : "api测试数据集10", "version" : "2.0", "ds_id" : "2eaa208dxxxxxxx9496914134fae2d4", "ds_type" : "DWS", "domain_id" : "10ae45e7xxxxxxbe954a211426d003", "physical_schema" : { "tables" : [ { "id" : "a25173cb-xxxx-42ec-xxxxx-67483f6cdaab", "database_name" : "modernbi_demo", "schema_name" : "autotest", "table_name" : "order_info", "table_type" : "table", "sql_text" : "", "is_fact_table" : false }, { "id" : "b745d57b-xxxx-4f2a-xxxx-3c0ff5fcf92f", "database_name" : "modernbi_demo", "schema_name" : "autotest", "table_name" : "sql_order_info", "table_type" : "sql", "sql_text" : "select * from autotest.order_info", "is_fact_table" : true } ] }, "logical_schema" : { "field_schema" : { "measures" : [ { "id" : "2d83ad17-32bb-xxxx-9c55-xxxxxxx", "caption" : "cs_bill_customer_sk", "is_expansion" : 0, "expansion_type" : 0, "column_formula" : "cs_xxxxx_customer_sk", "origin_column_name" : "cs_xxxx_customer_sk", "origin_column_type" : "int8", "data_type" : "NUMBER", "origin_data_type" : "NUMBER", "cube_id" : "2d83ad17-xxxxxxxxx-9c55-2a47415bdaf6" } ], "dimensions" : [ { "id" : "a25173cb-e229-xxxxxxx-67483f6cdaab.id", "caption" : "id1", "dimension_type" : "StandardDimension", "hierarchies" : [ { "caption" : "id1", "levels" : [ { "id" : "a25173cb-xxxxxxxxc-a4b4-67483f6cdaab.id", "caption" : "id1", "data_type" : "STRING", "origin_data_type" : "STRING", "origin_column_name" : "id", "origin_column_type" : "varchar(255)", "column_formula" : "id", "level_type" : null, "is_expansion" : 0, "expansion_type" : 0 } ] } ], "cube_id" : "a25173cb-xxxxxxxc-a4b4-67483f6cdaab" } ] }, "variables" : null, "relations" : [ { "source" : "b745d57b-axxxxx8ee4-3c0ff5fcf92f", "target" : "a25173cb-xxxxxx-a4b4-67483f6cdaab", "join_type" : "left join", "relation" : "many-to-one", "joins" : [ { "source_key" : "product_id", "source_type" : "dimension", "target_key" : "product_id", "target_type" : "dimension", "condition" : "equal-to" } ] } ] } }

响应参数 状态码：200 表3 响应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 表4 object 数据集逻辑schema。 physical_schema 表13 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 表4 LogicalSchema 参数 参数类型 描述 field_schema 表5 object 字段schema。 relations Array of 表10 objects 物理表关系。 数组长度：0-2147483647 variables Array of 表12 objects SQL变量列表。 数组长度：0-2147483647 表5 DatasetFieldSchemaVO 参数 参数类型 描述 dimensions Array of 表6 objects 维度。 数组长度：0-2147483647 measures Array of 表9 objects 度量。 数组长度：0-2147483647 表6 DimensionVo 参数 参数类型 描述 caption String 维度语义化名。 最小长度：0 最大长度：128 cube_id String 维度所属物理表ID。 最小长度：0 最大长度：128 description String 维度描述。 最小长度：0 最大长度：1000 id String 维度ID。 最小长度：0 最大长度：128 hierarchies Array of 表7 objects 维度层级。 数组长度：0-2147483647 表7 Hierarchy 参数 参数类型 描述 caption String 层级结构语义化名。 最小长度：0 最大长度：128 levels Array of 表8 objects 层级结构level。 数组长度：0-2147483647 表8 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 表9 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 表10 DatasetRelationVO 参数 参数类型 描述 join_type String 关联类型：left join|right join|inner join。 最小长度：0 最大长度：128 joins Array of 表11 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 表11 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 表12 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 表13 PhysicalSchema 参数 参数类型 描述 tables Array of 表14 objects 物理表信息。 数组长度：0-2147483647 表14 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 最大长度：8192

响应参数 表3 响应Body参数 参数 参数类型 描述 id String 任务ID。 最小长度：0 最大长度：128 name String 导入名称。 最小长度：0 最大长度：256 domain_id String domainID。 最小长度：0 最大长度：128 project_id String 项目ID。 最小长度：0 最大长度：64 workspace_id String 工作空间id。 最小长度：0 最大长度：128 import_param String 导入参数清单。 最小长度：0 最大长度：512 obs_bucket String obs桶名称。 最小长度：0 最大长度：128 obs_object_key String obs对象路径。 最小长度：0 最大长度：1024 import_detail String 导入明细。 最小长度：0 最大长度：4000 status Integer 结果状态：-1:未激活 0：待处理 1：成功；2：失败；3：部分成功 4：处理中。 枚举值： -1 0 1 2 3 4 error_msg String 任务失败原因。 最小长度：0 最大长度：512 import_type String import：资源包导入；crossSpaceImport：跨空间一键导入。 最小长度：0 最大长度：128 create_user String 创建者ID。 最小长度：0 最大长度：64 create_user_name String 创建者名称。 最小长度：0 最大长度：256 create_date Long 创建时间戳。 最小值：0 最大值：9223372036854775807 update_date Long 更新时间戳。 最小值：0 最大值：9223372036854775807

响应示例 导入任务详情。 { "id" : "2406a337-xxxx-a5b2-b01a61d2043b", "name" : "string", "domain_id" : "ad9e2f08-xxxx-87eb-1f9619b6c313", "project_id" : "string", "workspace_id" : "12913c92-xxxx-b8fd-a72af3945b61", "import_param" : "", "obs_bucket" : "test", "obs_object_key" : "test.zip", "import_detail" : "导入成功【 导出资源清单 】 数据源: 1 ;【 导入参数清单 】: 目标工作空间: 示例工作空间 ; 是否替换: false ;是否携带权限信息：false", "status" : 1, "error_msg" : "string", "import_type" : "import|crossSpaceImport", "create_user" : "string", "create_user_name" : "string", "create_date" : 9223372036854776000, "update_date" : 9223372036854776000 }

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

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

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

响应示例 状态码： 200 数据源详情。 { "id" : "xxxxxxx3796649a185b012a96xxxxxxx", "name" : "xxx_gaussdbtest", "host" : "xxx.xx.x.xx", "port" : 8000, "server_list" : "xxx.xx.x.xx:xxxx", "database_name" : "gaussdb", "user_name" : "modernbi", "test_url" : "jdbc:gaussdb://xxx.xx.xx.xx:xxxx/gaussdb?socketTimeout=120&loginTimeout=5&ssl=true", "project_id" : "xxxxxxxb4dac4055888643b33xxxxxxx", "domain_id" : "xxxxxxxf3c90428fb22606b64xxxxxxx", "work_space_id" : "xxxxxxxea0764ffa850664804xxxxxxx", "extra" : "[{\"ip\": \"xxx.xx.x.xx\", \"port\": xxxx, \"channelType\": \"eip\"}]", "config" : { "ssl" : true }, "type" : "DWS", "source" : "public", "mode" : "multi-node", "default_schema" : "public", "creation_user" : "xxxxxa863a94b0ba2887b80dxxxxx", "creation_date" : 1700114987113, "creation_user_name" : "test_name", "update_user" : "xxxxxxxa863a94b0ba2887b80dcxxxxxxx", "update_user_name" : "test_name", "update_date" : 1701071948929 }

请求示例 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

请求参数 表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 数据源列表详情。 { "count" : 100, "page_data" : [ { "id" : "xxxxxxx796649a185b012a96xxxxxxx", "name" : "test_name", "host" : "xxx.xx.x.xx", "port" : 80, "server_list" : "xxx.xx.x.xx:xxxx", "database_name" : "db_name", "user_name" : "test_name", "test_url" : "jdbc:gaussdb://xxx.xx.x.xx:xxxx/gaussdb?socketTimeout=120&loginTimeout=5&ssl=true", "project_id" : "xxxxxxxb4dac4055888643b331axxxxxxx", "domain_id" : "xxxxxxxcf3c90428fb22606b64dxxxxxxx", "work_space_id" : "xxxxxxxa5ea0764ffa850664804b9xxxxxxx", "extra" : "[{\"ip\": \"xxx.xx.x.xx\", \"port\": xxxx, \"channelType\": \"eip\"}]", "config" : { "ssl" : true }, "type" : "DWS", "source" : "public", "mode" : "multi-node", "default_schema" : "public", "creation_user" : "xxxxxxx63a94b0ba2887b8xxxxxxx", "creation_date" : 1700114987113, "creation_user_name" : "ei_dlv_l00456193_01", "update_user" : "xxxxxxxa863a94b0ba2887b80dxxxxxxx", "update_user_name" : "name1", "update_date" : 1701071948929 } ] }

URI GET /v1/{project_id}/connections 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 最小长度：0 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 all 否 Boolean 是否返回全部数据源列表。 limit 否 Integer 返回最大条数。 最小值：0 最大值：2147483647 缺省值：10 offset 否 Integer 偏移量。 最小值：0 最大值：2147483647 缺省值：0 name 否 String 数据源搜索值（按名称模糊匹配）。 最小长度：0 最大长度：512 type 否 String 数据源类型：MySQL、PostgreSQL、DWS、OpenGauss、DLI、ClickHouse、API、Doris。 枚举值： MySQL PostgreSQL DWS OpenGauss DLI ClickHouse API Doris sort_key 否 String 排序字段：支持name、creation_date、update_date。 最小长度：0 最大长度：32 sort_dir 否 String 排序类型：ASC、DESC。 最小长度：0 最大长度：64 枚举值： ASC DESC

响应示例 { "count" : 3, "page_data" : [ { "id" : "xxxxfdff-xxxb-xxxx-8f52-e15e35axxxxx", "name" : "COLUMN", "dataset_id" : "xxxxd682-e129-xxxx-ad8e-673f02xxxxxx", "is_open" : true, "permission_type" : "COLUMN", "rule_type" : "MASK", "rule_scope" : "ALL", "project_id" : "xxxx703a500dxxxxfb3c00f9fxxxxx", "workspace_Id" : "xxxx6703a50xxxxx2fb3c00f9fxxxxxx", "rule_user" : { "users" : [ ], "user_groups" : [ ] }, "rule_content" : { "last" : 1, "first" : 1, "mask_type" : "RETAIN_FIRST_N_LAST_M", "column_ids" : [ "xxxxe9d6-6xxx-4126-bxxx-36fcxxxxce54.amount" ], "special_words" : [ "xxx" ] }, "display_fields" : { "user_map" : { }, "group_map" : { }, "field_map" : { "xxxxe9d6-xxxe-4126-bd51-36fc0ee3ce54.amount" : "amount" } } }, { "id" : "xxxxda33-dace-xxxx-8xxx-c6dfaxxxxxf1", "name" : "USER_TAG", "dataset_id" : "xxxxxd13-cxxx-4xxx-b657-829axxxxx20e", "is_open" : true, "permission_type" : "ROW", "rule_type" : "BY_TAG", "rule_scope" : "ALL", "rule_user" : { "users" : [ ], "user_groups" : [ ] }, "rule_content" : { "condition_node" : null, "logic_operator" : "AND", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "xxxx3355-xxxx-4340-9b5d-0bd856xxxxxx" ], "value_type" : "TAG_USER_GROUP", "value_names" : [ "userGroup2" ] }, "column_id" : "xxxxx722-b74c-4xxx-9630-43ca65xxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "" }, "logic_operator" : null }, { "condition_node" : { "value" : { "values" : [ "xxxxx355-4ffa-xxxx-9b5d-0bd856xxxxx" ], "value_type" : "TAG_USER_GROUP", "value_names" : [ "userGroup2" ] }, "column_id" : "xxxxx22-b74c-4752-xxx0-xxxx65d0d12c.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "" }, "logic_operator" : null } ] }, "display_fields" : null }, { "id" : " xxx14b04-ef3d-4ebc-a9ee-c651f563d67c", "name" : "测试", "dataset_id" : "xxxx4d13-c2a3-426f-b657-829addaxxxxx", "is_open" : true, "permission_type" : "ROW", "rule_type" : "BY_CONDITION", "rule_scope" : "SPECIFIED", "rule_user" : { "users" : [ "xxxxxxxed1b94534xxxxx3de304axxxx", "xxxx987b3dc4xxxx68b8dff1e7xxxxx", "774d5axxxxxb4950aabc8651308xxxxx" ], "user_groups" : [ ] }, "rule_content" : { "condition_node" : null, "logic_operator" : "AND", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "123" ], "value_type" : "CONDITION" }, "column_id" : "xxxx6722-b74c-4752-9xxx-43ca65d0d12xxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "CONTAIN" }, "logic_operator" : null }, { "condition_node" : null, "logic_operator" : "OR", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "qwe" ], "value_type" : "CONDITION" }, "column_id" : "xxxx722-b74c-4752-xxxx-43ca65dxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "CONTAIN" }, "logic_operator" : null } ] } ] }, "display_fields" : { "user_map" : { "xxxx987b3dc4xxxxxxb8dff1e73xxxx" : "auth_test", "xxxxxac55eeb4950axxxx6513080xxxx" : "chenxiantao", "xxxxx57ed1b9453xxxx943de304xxxxx" : "abac_test" }, "group_map" : { }, "field_map" : null } } ] }

URI GET /v1/{project_id}/datasets/{dataset_id}/permissions 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 permission_type 是 String 权限类别： ROW：行级权限；COLUMN：列级权限。 offset 是 Integer 偏移值。分页的偏移值，0代表不偏移，也就是第一页，1代表偏移1，指的第二页。 limit 是 Integer 返回列表数量。 sort_key 否 String 排序字段 isOpen，是否开启行列权限。 sort_dir 否 String 排序类别：desc、asc。desc代表减序，asc代表升序。

请求示例 POST https://{endpoint}/v1/{project_id}/exports/config { "service_type" : "obs", "obs_endpoint" : "obs.xxx.com", "obs_bucket_name" : "xxxxx", "max_storage_days" : 1, "obs_path_prefix" : "/dataArts-insight" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。 X-Auth-Token 是 String 用户Token。 Content-Type 是 String 固定值，指定请求体类型和字符集。 表3 请求Body参数 参数 是否必选 参数类型 描述 service_type 是 String 服务类型。 obs_endpoint 是 String OBS终端节点。 obs_bucket_name 是 String OBS桶名。 max_storage_days 是 Integer 导出文件在OBS的最大存储时间。 obs_path_prefix 是 String OBS前缀路径。

URI GET /v1/{project_id}/tags/head 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 用户类型（用户或用户组）。 offset 否 Integer 返回条目的起始offset，默认值0。 limit 是 Integer 返回列表数量。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。 X-Auth-Token 是 String 用户Token。 Content-Type 是 String 固定值，指定请求体类型和字符集。 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 资源包文件。 import_strategy 是 String 导入策略，replace|addNew。 replace_rule 否 String 替换规则，默认值为BY_ID，取值范围：BY_ID、BY_NAME 最小长度：0 最大长度：100 枚举值： BY_ID BY_NAME

响应示例 状态码：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" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 数据数量。 最小值：0 最大值：2147483647 page_data Array of 表5 objects 数据 数组长度：0-2147483647 表5 DatasetListVO 参数 参数类型 描述 create_date Long 创建时间。 最小值：0 最大值：9223372036854774807 create_user String 创建人ID。 最小长度：0 最大长度：128 create_user_name String 创建人姓名。 最小长度：0 最大长度：128 description String 描述。 最小长度：0 最大长度：1024 id String ID 最小长度：0 最大长度：128 name String 名称。 最小长度：0 最大长度：128 permission_list Array of strings 当前用户拥有的协同授权权限点。 edit，export，use，read。 最小长度：0 最大长度：128 数组长度：0-10000 project_id String 项目ID。 最小长度：0 最大长度：128 type String 类型：datasource，dataset，dashboard，screen。 最小长度：0 最大长度：128 update_date Long 修改时间。 最小值：0 最大值：9223372036854774807 update_user String 修改人ID。 最小长度：0 最大长度：128 update_user_name String 修改人姓名。 最小长度：0 最大长度：128 workspace_id String 工作空间ID。 最小长度：0 最大长度：128 ds_name String 绑定的数据源名称。 最小长度：0 最大长度：255 ds_type String 绑定的数据源类型：MYSQL、POSTGRESQL、DWS、OPENGAUSS、DLI、CLICKHOUSE、API、DORIS 最小长度：0 最大长度：64 枚举值： MYSQL POSTGRESQL DWS OPENGAUSS DLI CLICKHOUSE API DORIS ds_id String 绑定的数据源ID。 最小长度：0 最大长度：64 routing_strategy String 查询数据时的路由策略。Direct：直连；Accelerator：内存引擎。 最小长度：0 最大长度：32 resource_code String 数据集资源标识。 最小长度：0 最大长度：64

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

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