文档首页/ AI科学计算服务/ API参考/ API/ 系统管理/ IAM用户管理/ 查询IAM用户组列表 - ListIamGroups
更新时间:2025-12-26 GMT+08:00
分享

查询IAM用户组列表 - ListIamGroups

功能介绍

查询IAM用户组列表。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/iam/groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,您可以从获取项目ID中获取。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制:

不涉及

取值范围:

长度为[1-32768]个字符。

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

groups

Array of IamGroupDto objects

参数解释:

用户组列表。

约束限制:

不涉及

count

Integer

参数解释:

总数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 IamGroupDto

参数

参数类型

描述

id

String

参数解释:

IAM用户组ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

IAM用户组名。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

查询iam用户组列表。

https://{endpoint}/v1/{project_id}/iam/groups

响应示例

状态码:200

OK

{
  "count" : 1,
  "groups" : [ {
    "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488",
    "name" : "group1"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档