智能分析助手列表查询接口 - ListSubjects
功能介绍
查询智能分析助手列表。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/subjects
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
keyword | 否 | String | 参数解释: 智能分析助手名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
sort_dir | 否 | String | 参数解释: 排序类型。 约束限制: 不涉及 取值范围:
默认取值: asc |
sort_key | 否 | String | 参数解释: 排序字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
limit | 否 | Integer | 参数解释: 返回条目数。 约束限制: 不涉及 取值范围: [1,1000] 默认取值: 10 |
offset | 否 | Integer | 参数解释: 分页查询偏移量。 约束限制: 不涉及 取值范围: [0,1000] 默认取值: 0 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Workspace-Id | 是 | String | 参数解释: 工作空间ID。获取方法请参见获取工作空间ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
count | Integer | 参数解释: 总条目数。 取值范围: 不涉及 |
page_data | Array of ExtSubjectVO objects | 当前页的数据,元素类型为ExtSubjectVO。 |
参数 | 参数类型 | 描述 |
|---|---|---|
name | String | 参数解释: 智能分析助手名称。 取值范围: 不涉及 |
id | String | 参数解释: 智能分析助手ID。 取值范围: 不涉及 |
comments | String | 参数解释: 智能分析助手描述。 取值范围: 不涉及 |
status | Integer | 参数解释: 智能分析助手状态。 取值范围:
|
permission_list | Array of strings | 参数解释: 当前用户拥有的协同授权权限点 取值范围:
|
workspace_id | String | 参数解释: 智能分析助手所属工作空间ID。 取值范围: 不涉及 |
project_id | String | 参数解释: 智能分析助手所属的项目ID。 取值范围: 不涉及 |
create_user | String | 参数解释: 智能分析助手的创建者。 取值范围: 不涉及 |
create_user_name | String | 参数解释: 智能分析助手的创建者名称。 取值范围: 不涉及 |
create_date | Long | 参数解释: 智能分析助手的创建时间。 取值范围: 不涉及 |
update_user | String | 参数解释: 智能分析助手的更新者。 取值范围: 不涉及 |
update_user_name | String | 参数解释: 智能分析助手的更新者名称。 取值范围: 不涉及 |
update_date | Long | 参数解释: 智能分析助手的更新时间。 取值范围: 不涉及 |
datasets | Array of ExtSubjectDatasetVO objects | 智能分析助手关联数据集列表。 |
recommended_questions | String | 参数解释: 智能分析助手的推荐问题。 取值范围: 不涉及 |
请求示例
查询智能分析助手列表。
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 | 查询智能分析助手列表成功。 |
错误码
请参见错误码。

