批量查询当前阿里云账号下所有用户组的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| csas:ListUserGroups | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CurrentPage | integer | 是 | 分页查询时显示的当前页的页码。取值：1~10000。 | 1 |
| PageSize | integer | 是 | 分页查询时设置的每页数量。取值：1~1000。 | 10 |
| UserGroupIds | array | 否 | 用户组 ID 集合。最多可输入 100 个用户组 ID。 | |
| string | 否 | 用户组 ID。取值来源：
| usergroup-6f1ef2fc56b6**** | |
| Name | string | 否 | 用户组名称。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。 | user_group_name |
| AttributeValue | string | 否 | 用户组属性的值。长度为 1~128 个字符。 | username |
| PAPolicyId | string | 否 | 内网访问策略 ID。取值来源：
| pa-policy-54a7838a48bf**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "4AB972E2-D702-5464-B132-B1911498B8BF",
"TotalNum": 1,
"UserGroups": [
{
"UserGroupId": "usergroup-6f1ef2fc56b6****",
"Name": "user_group_name",
"Description": "这是一条用户组",
"Attributes": [
{
"UserGroupType": "department",
"Relation": "Equal",
"Value": "OU=部门1,OU=SASE钉钉",
"IdpId": 12
}
],
"CreateTime": "2022-10-10 11:39:22"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-04-12 | API 内部配置变更，不影响调用 | 查看变更详情 |