更新时间:2025-03-10 GMT+08:00
分享

创建嵌入分析

功能介绍

创建嵌入分析。

URI

POST /v1/{project_id}/embeddings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

id

String

嵌入分析id。传入该参数则使用传入的id,否则生成新id。

name

String

嵌入分析名称。

resource_type

String

参数解释:

资源类型枚举值,用于指定授权对象的类型。

示例:datasource,指定授权对象类型为数据源。

约束限制:

不涉及

取值范围:

以下枚举值:

  • datasource:数据源;
  • dataset:数据集;
  • metric:指标;
  • dashboard:仪表板;
  • screen:大屏;
  • embedAnalysis:嵌入分析;
  • portal:数据门户;
  • subject:智能分析助手。

默认取值:

不涉及

resource_id

String

嵌入分析对应的资源id,如仪表板或者大屏的id。

root_resource_id

String

嵌入分析对应的根资源id。仪表板或者大屏的根资源id为其本身id。

auth_type

String

嵌入分析的访问类型。0:登录访问;1:ticket认证。默认取值为0。

config

String

嵌入分析配置参数。如'ticket=xxxx',则指定嵌入分析链接里对应的ticket值。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

创建好的嵌入分析id。

请求示例

创建嵌入分析。

POST https://{endpoint}/v1/{project_id}/embeddings 
 
{ 
  "id" : "6cb08a50xxxxxxxxxxxxxxxxxxxxxx", 
  "name" : "新建嵌入分析", 
  "resource_type" : "dashboard", 
  "resource_id" : "866a519fxxxxxxxxxxxxxxxx", 
  "root_resource_id" : "866a519fxxxxxxxxxxxxxxxx", 
  "config" : "ticket=ec85f874axxxxxxxxxxxxxxxxxxxxxxxxxxxx", 
  "auth_type" : 1 
}

响应示例

状态码: 200

创建嵌入分析成功。

{     
"id": "6cb08a50xxxxxxxxxxxxxxxxxxxxxxx", 
}

状态码

状态码

描述

200

创建嵌入分析成功。

错误码

请参见错误码

相关文档