智能数据洞察 DATAARTS INSIGHT-保存或修改数据集:请求参数

时间:2025-03-10 18:45:11

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

工作空间ID。获取方法请参见获取工作空间ID

X-Auth-Token

String

用户Token。通过调用 IAM 服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

id

String

数据集ID。

caption

String

数据集语义化名称。

status

String

数据集状态:0,1。

description

String

数据集描述。

ds_id

String

数据源ID。

ds_name

String

数据源名称。

ds_type

String

数据源类型。

table_type

String

数据集类型:

  • table:不含自定义SQL表的数据集。
  • sql:含自定义SQL表的数据集。

resource_code

String

数据集资源标识。

physical_schema

表4 object

数据集物理schema。

logical_schema

表6 object

数据集逻辑schema。

表4 PhysicalOpenApiSchema

参数

是否必选

参数类型

描述

tables

Array of 表5 objects

物理表信息。

表5 DatasetTableOpenApiVO

参数

是否必选

参数类型

描述

database_name

String

数据库。

is_fact_table

Boolean

是否为端点表。

schema_name

String

模式。

sql_text

String

查询SQL。

table_name

String

表名。

table_type

String

表类型:

  • table:物理表。
  • sql:自定义SQL表。
表6 LogicalSchemaOpenApiVO

参数

是否必选

参数类型

描述

filed_schema

表7 object

字段选择信息。

variables

Array of 表9 objects

SQL变量列表。

relations

Array of 表10 objects

物理表关系。

表7 DatasetFieldSchemaOpenApiVO

参数

是否必选

参数类型

描述

columns

Array of 表8 objects

字段选择列表和字段名称赋值。

表8 ColumnOpenApiVO

参数

是否必选

参数类型

描述

caption

String

字段名称。

origin_column_name

String

字段物理名称,即表中名称。

schema_name

String

字段所属schema。

table_name

String

字段所属名

表9 SqlVariable

参数

是否必选

参数类型

描述

default_values

Array of objects

变量默认值。

format

String

变量格式,针对日期时间类型变量有效。

name

String

变量名称

type

String

参数解释:

变量类型,目前支持文本、数值、日期、系统变量等类型。

约束限制:

不涉及

取值范围:

以下枚举值:

  • STRING:普通文本类型,组装执行sql时“输入值”使用单引号包裹,如:'value';
  • NUMBER:整数或小数类型,组装执行sql时,直接拼接输入值;
  • YEARREGION:日期-年类型;
  • QUARTERREGION 日期-年季类型;
  • MONTHREGION 日期-年月类型;
  • DATEREGION 日期-年月日类型;
  • YMDHMSREGION 日期-年月日时分秒类型;
  • SYSTEM:系统变量,无法指定具体值,由系统后台填写,如:“访问用户名称”后台将当前访问用户名作为值组装执行sql。

默认取值:

不涉及

use_scope

String

变量作用域,dataset|global。

表10 DatasetRelationOpenApiVO

参数

是否必选

参数类型

描述

source_database_name

String

源表所属数据库名称。

source_schema

String

源表所属schema名称。

source_table_name

String

源表名称。

target_database_name

String

目标表所属数据库名称。

target_schema

String

目标表所属schema名称。

target_table_name

String

目标表名称。

join_type

String

关联类型。

relation

String

关系类型。

joins

Array of 表11 objects

关联键

表11 DatasetJoinOpenApiVO

参数

是否必选

参数类型

描述

condition

String

关联关系,默认equal-to。

source_key

String

源表字段。

target_key

String

目标表字段。

support.huaweicloud.com/api-dataartsinsight/SaveDatasetForOpenApi.html