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

时间:2024-05-16 16:18:23

请求参数

表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

support.huaweicloud.com/api-dataartsinsight/zh-cn_topic_0000001881542278.html