文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ ai功能/ 查询订阅AI助手的项目，用户组，用户列表 - ListSubscribeAiAssistantUsers
更新时间：2026-05-21 GMT+08:00
查看PDF
分享

查询订阅AI助手的项目，用户组，用户列表 - ListSubscribeAiAssistantUsers

功能介绍

查询订阅AI助手的项目，用户组，用户列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:users:listSubscribeAiAssistantUsers

    List

    -

    -

    -

    -

URI

GET /v3/users/ai-assistant/subscribe

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

用于分页查询，返回用户数量限制。如果不指定，则返回所有符合条件的用户。

offset

否

Integer

分页查询起始条数。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

total_count

Integer

订阅用户总数。

users

Array of SubscribeUserInfo objects

订阅用户列表。

usergroups

Array of SubscribeUserGroupInfo objects

订阅用户组列表。

project

project object

订阅项目信息。
表3 SubscribeUserInfo

参数

参数类型

描述

user_id

String

用户id。

user_name

String

桌面用户名。

user_phone

String

用户手机号。

ai_func

Boolean

ai 功能是否启用。

  • true： 启用

  • false： 不启用
表4 SubscribeUserGroupInfo

参数

参数类型

描述

group_id

String

用户组ID。

group_name

String

用户组名称。

ai_func

Boolean

ai 功能是否启用。

  • true： 启用

  • false： 不启用
表5 project

参数

参数类型

描述

project_id

String

项目ID。

ai_func

Boolean

ai 功能是否启用。

  • true： 启用

  • false： 不启用

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：405

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：503

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users/ai-function/subscribe?limit=10

响应示例

状态码：200

查询订阅AI助手用户列表响应。

{
  "total_count" : 100,
  "users" : [ {
    "user_id" : "1c873056-9f4d-11ec-b909-0242ac120002",
    "ai_func" : true
  } ],
  "usergroups" : [ {
    "group_id" : "8885bcc45da1f762015da20130a1000",
    "ai_func" : false
  } ],
  "project" : {
    "project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
    "ai_func" : true
  }
}

状态码

状态码

描述

200

查询订阅AI助手用户列表响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： ai功能