DescribeGroups API的参数与示例-无影云电脑企业版-阿里云

查询用户组。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
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	否	是否排除已关联登录策略的用户组。

返回参数

名称	类型	描述	示例值
	object	返回数据结构。
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Groups	array<object>	用户组列表。
group	object	用户组信息。
GroupName	string	用户组名称。	TestGroup
GroupId	string	用户组 ID。	ug-2412ojkwtybd****
Description	string	用户组的描述。	A test group.
CreateTime	string	创建时间。	2025-08-07T13:40:40+08:00
UserCount	integer	用户组内的成员数量。	20
TransferFileNeedApproval	boolean	是否已开启文件审批。	false
AuthedResources	object	已分配的资源列表。
	string	已分配的资源。枚举值： DesktopGroup：共享型云电脑。	DesktopGroup
Count	integer	查询结果的数量。	1

示例

正常返回示例

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,
      "AttachedLoginPolicy": {
        "PolicyId": "",
        "Name": ""
      },
      "AuthedResources": {
        "key": "DesktopGroup"
      }
    }
  ],
  "Count": 1
}

错误码

访问错误中心查看更多错误码。