查询共享型云电脑所有授权用户的详情,包括用户名、邮箱地址、手机号、获得授权的云电脑ID等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecd:DescribeUsersInGroup | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
DesktopGroupId | string | 是 | 共享型云电脑 ID。 | dg-8ttn55ujj8nj8**** |
MaxResults | integer | 否 | 分页查询时每页行数。
| 10 |
NextToken | string | 否 | 下一个查询开始的 Token,NextToken 为空表示没有下一个。 | caeba0bbb2be03f84eb48b699f0a4883 |
EndUserId | string | 否 | 授权用户 ID。 | alice |
ConnectState | integer | 否 | 用户连接状态。 枚举值:
| 1 |
QueryUserDetail | boolean | 否 | 是否查询用户详情。 枚举值:
| true |
Filter | string | 否 | 模糊查询字符串。包含该字符串的结果都将被匹配出来。 | alice |
OrgId | string | 否 | 用户所属的组织 ID。 | org-d0fua2oyukw8j**** |
EndUserIds | array | 否 | 授权用户 ID 列表。 | |
string | 否 | 授权用户 ID。只支持精确匹配。 | alice |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"UsersCount": 1,
"OnlineUsersCount": 0,
"EndUsers": [
{
"EndUserId": "alice",
"EndUserEmail": "alice@example.com",
"DesktopName": "testName",
"ConnectionStatus": "1",
"DesktopId": "ecd-gx2x1dhsmucyy****",
"EndUserType": "SIMPLE",
"EndUserPhone": "1381111****",
"EndUserName": "alice",
"ExternalInfo": {
"ExternalName": "nameDemo",
"JobNumber": "123"
},
"UserSetPropertiesModels": [
{
"UserId": 123,
"UserName": "nameDemo",
"PropertyId": 123,
"PropertyKey": "key",
"PropertyType": 1,
"PropertyValues": [
{
"PropertyValueId": 123,
"PropertyValue": "value"
}
]
}
],
"UserDesktopId": "ud-i896ze8hazpvl****",
"EndUserRemark": "Note",
"DisplayName": "alice"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-04-13 | OpenAPI 入参发生变更 | 查看变更详情 |