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

时间:2024-08-05 11:34:06

响应参数

状态码: 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

是否为端点表。

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