查询应用组 - ListAppGroup

功能介绍

查询用户创建的应用组，按照名称、授权类型分页查询。

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:appGroup:list
List
appGroup *
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:appGroup:list	List	appGroup *	-	-	-

URI

GET /v1/{project_id}/app-groups

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	单次查询的大小[1-100]，默认值10。
offset	否	Integer	查询的偏移量，默认值0。
app_server_group_id	否	String	应用服务器组ID。
app_group_id	否	String	应用组ID。
name	否	String	应用组名称。
authorization_type	否	String	授权类型： APP - 应用 APP_GROUP - 应用组
app_type	否	String	应用组类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
count	Integer	总数。
items	Array of AppGroup objects	应用组列表。

表5 AppGroup
参数	参数类型	描述
id	String	应用组ID。
name	String	应用组名称。
app_server_group_id	String	应用服务器组ID。
app_server_group_name	String	应用服务器组名称。
description	String	应用组描述。
authorization_type	String	授权类型，基于应用(组)授权，默认为APP_GROUP授权。 APP - 按照应用授权（尚未支持）。 APP_GROUP - 按照应用组授权。
tenant_id	String	租户ID。
app_type	String	服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app。 COMMON_APP - 普通app。
create_at	String	发布时间。
app_count	Integer	应用数量。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：405

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：503

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

请求示例

GET /v1/a4da8115c9d8464ead3a38309130523f/app-groups?limit=10&offset=0

响应示例

状态码：200

成功响应。

{
  "count" : 3,
  "items" : [ {
    "id" : "575772274859184145",
    "name" : "开放性API创建应用组测试",
    "app_server_group_id" : "",
    "description" : "开放性API测试。",
    "authorization_type" : "APP_GROUP",
    "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
    "app_type" : "COMMON_APP",
    "create_at" : "2023-06-06T14:14:02.246Z",
    "app_count" : 0
  }, {
    "id" : "573743978327834676",
    "name" : "lmn",
    "app_server_group_id" : "cb5a5079-67cb-45f6-9e4a-e489f3d821d6",
    "app_server_group_name" : "lmn-530test-勿删",
    "description" : "",
    "authorization_type" : "APP_GROUP",
    "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
    "app_type" : "COMMON_APP",
    "create_at" : "2023-06-05T03:43:24.806Z",
    "app_count" : 1
  }, {
    "id" : "561707361090142208",
    "name" : "tmp",
    "app_server_group_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e",
    "app_server_group_name" : "Nas",
    "description" : "",
    "authorization_type" : "APP_GROUP",
    "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
    "app_type" : "COMMON_APP",
    "create_at" : "2023-04-28T07:17:03.085Z",
    "app_count" : 14
  } ]
}

状态码

状态码	描述
200	成功响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。