文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 智能分析助手/ 智能分析助手列表查询接口
更新时间：2024-07-31 GMT+08:00
查看PDF
分享

智能分析助手列表查询接口

功能介绍

查询智能分析助手列表。

URI

GET /v1/{project_id}/subjects

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：0

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

keyword

否

String

智能分析助手名称。

最小长度：0

最大长度：128

sort_dir

否

String

排序类别：

  • desc：倒序。
  • asc：正序。

最小长度：0

最大长度：128

枚举值：

  • desc
  • asc

sort_key

否

String

排序字段。

最小长度：0

最大长度：128

limit

否

Integer

返回条目数。不传该参数时，默认查询前10条信息。

最小值：0

最大值：1000

缺省值：10

offset

否

Integer

返回条目的起始offset。

最小值：0

最大值：1000

缺省值：0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

是

String

工作空间ID，即控制台的项目ID。

最小长度：0

最大长度：128

X-Auth-Token

是

String

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

最小长度：0

最大长度：8192

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总条目数。

最小值：0

最大值：2147483647

page_data

Array of ExtSubjectVO objects

当前页的数据，元素类型为ExtSubjectVO。

数组长度：0 - 1000000
表5 ExtSubjectVO

参数

参数类型

描述

name

String

智能分析助手名称。

最小长度：0

最大长度：128

id

String

智能分析助手ID。

最小长度：0

最大长度：128

comments

String

智能分析助手描述。

最小长度：0

最大长度：128

status

Integer

智能分析助手状态。初始化（0），图构建（1），索引构建（2），训练成功（3），训练失败（4），训练停止（5）。

最小值：0

最大值：5

枚举值：

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5

permission_list

Array of strings

当前用户拥有的协同授权权限点：edit、export、use、read。

数组长度：0 - 10000

workspace_id

String

智能分析助手所属工作空间ID。

最小长度：0

最大长度：128

project_id

String

智能分析助手所属的项目ID。

最小长度：0

最大长度：128

create_user

String

智能分析助手的创建者。

最小长度：0

最大长度：128

create_user_name

String

智能分析助手的创建者名称。

最小长度：0

最大长度：128

create_date

Long

智能分析助手的创建时间。

最小值：0

最大值：9223372036854774807

update_user

String

智能分析助手的更新者。

最小长度：0

最大长度：128

update_user_name

String

智能分析助手的更新者名称。

最小长度：0

最大长度：128

update_date

Long

智能分析助手的更新时间。

最小值：0

最大值：9223372036854774807

datasets

Array of ExtSubjectDatasetVO objects

智能分析助手关联数据集列表。

recommended_questions

String

智能分析助手的推荐问题。

最小长度：0

最大长度：128
表6 ExtSubjectDatasetVO

参数

参数类型

描述

dataset_id

String

数据集ID。

最小长度：0

最大长度：128

name

String

数据集名称。

最小长度：0

最大长度：128

请求示例

查询智能分析助手列表。

GET https://{endpoint}/v1/{project_id}/subjects?subjects?keyword=&sort_key=&sort_dir=&limit=20&offset=0

响应示例

状态码： 200

查询智能分析助手列表成功。

{
  "count" : 1,
  "page_data" : [ {
    "name" : "xxxxxxxxx",
    "subject_id" : "xxxxxxxxxxxxx",
    "comments" : "",
    "status" : 3,
    "permission_list" : [ "edit", "use" ],
    "workspace_id" : "xx4xxaxxxxac8x51xxx30",
    "project_id" : "xxb4dxx4xxx886xx33xx27",
    "create_user" : "xxxb4xxx4b0baxxxxx0dc18xxx3",
    "create_user_name" : "xxv_l00xxxx",
    "create_date" : 1702046652513,
    "update_user" : "xxxxxxx4b0xxxb8xxxx27x",
    "update_user_name" : "xxv_l00xxxx",
    "update_date" : 1710496061316,
    "datasets" : [ {
      "dataset_id" : "xxxxxxxxxxxxx",
      "name" : "xxxxxxxxxx"
    } ],
    "recommended_questions" : "xxxxxxxxxxxxx"
  } ]
}

状态码

状态码

描述

200

查询智能分析助手列表成功。

错误码

请参见错误码。

父主题： 智能分析助手

相关文档