文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 嵌入分析/ 创建嵌入分析
更新时间：2024-08-28 GMT+08:00
查看PDF
分享

创建嵌入分析

功能介绍

创建嵌入分析。

URI

POST /v1/{project_id}/embeddings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：0

最大长度：128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：0

最大长度：8192
表3 请求Body参数

参数

是否必选

参数类型

描述

id

否

String

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

最小长度：0

最大长度：100

name

是

String

嵌入分析名称。

最小长度：0

最大长度：100

resource_type

是

String

嵌入分析对应的资源类型。可填入dashboard、screen。

最小长度：0

最大长度：100

resource_id

是

String

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

最小长度：0

最大长度：100

root_resource_id

是

String

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

最小长度：0

最大长度：100

auth_type

否

String

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

config

否

String

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

最小长度：0

最大长度：500

响应参数

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

创建嵌入分析成功。

错误码

请参见错误码。

父主题： 嵌入分析

相关文档