查询用户组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecd:DescribeGroups | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GroupId | string | 否 | 用户组 ID。 | ug-16nf7xxh4o9gc**** |
BizType | string | 否 | 说明
该参数暂不对外开放使用。
| ENTERPRISE |
SolutionId | string | 否 | 说明
该参数暂不对外开放使用。
| co-0esnf80jab*** |
GroupName | string | 否 | 用户组名称。 | TestGroup |
PageSize | integer | 否 | 分页查询时设置的每页行数。最大值:100。默认值:10。 | 10 |
PageNumber | integer | 否 | 分页查询时的页码。 | 1 |
TransferFileNeedApproval | boolean | 否 | 是否已开启文件审批。 | false |
LoginPolicyId | string | 否 | 指定关联的登录策略筛选。 | |
ExcludeAttachedLoginPolicyGroups | boolean | 否 | 是否排除已关联登录策略的用户组。 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"Groups": [
{
"GroupName": "TestGroup",
"GroupId": "ug-2412ojkwtybd****",
"Description": "A test group.",
"CreateTime": "2025-08-07T13:40:40+08:00",
"UserCount": 20,
"TransferFileNeedApproval": false,
"AuthedResources": {
"key": "DesktopGroup"
},
"AttachedLoginPolicy": {
"PolicyId": "",
"Name": ""
}
}
],
"Count": 1
}
错误码
访问错误中心查看更多错误码。