按付费类型查询云电脑池包含的云电脑列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecd:DescribeDesktopsInGroup | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
DesktopGroupId | string | 是 | 云电脑池 ID。 | dg-2i8qxpv6t1a03**** |
PayType | string | 否 | 付费类型。 枚举值:
| PrePaid |
MaxResults | integer | 否 | 分页查询时每页行数。 最大值:100。 默认值:10。 | 10 |
NextToken | string | 否 | 下一个查询开始的 Token,NextToken 为空表示没有下一个。 | caeba0bbb2be03f84eb48b699f0a4883 |
IgnoreDeleted | boolean | 否 | 是否忽略删除标志位。 枚举值:
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"PostPaidDesktopsCount": 10,
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"PaidDesktopsCount": 10,
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"PostPaidDesktopsTotalAmount": 10000,
"PaidDesktops": [
{
"EndUserId": "alice",
"DesktopStatus": "Running",
"DesktopName": "DemoComputer",
"ConnectionStatus": "Connected",
"DesktopId": "ud-7ftf5b6yu77b0****",
"EndUserName": "alice",
"ManagementFlag": "NoFlag",
"EndUserIds": [
"alice"
],
"EndUserNames": [
"alice"
],
"ResetTime": "2021-03-03 08:48:08",
"ImageId": "m-hn5v2mmk0****",
"ImageName": "Win10_ZC",
"SystemDiskSize": 80,
"OsType": "Windows",
"GpuDriverVersion": "1.0",
"DiskType": "SYSTEM",
"ManagementFlags": [
"NoFlag"
],
"MemberEniIp": "192.168.XX.XX",
"PrimaryEniIp": "192.168.XX.XX",
"ProtocolType": "ASP",
"FotaVersion": "0.1.0-R-20220914.17****"
}
],
"PostPaidDesktops": [
{
"CreateDuration": "4153958447",
"EndUserId": "alice",
"DesktopStatus": "Stopped",
"CreateTime": "2022-01-21T06:34:57Z",
"ReleaseTime": "2022-01-21T16:34:57Z",
"DesktopName": "DemoComputer",
"ConnectionStatus": "Connected",
"DesktopId": "ud-2i8qxpv6t1a07****",
"EndUserName": "alice",
"ManagementFlag": "NoFlag",
"EndUserIds": [
"alice"
],
"EndUserNames": [
"alice"
],
"ResetTime": "2021-03-03 08:48:08",
"ImageId": "m-hn5v2mmk0****",
"ImageName": "Win10_ZC",
"SystemDiskSize": 80,
"OsType": "Windows",
"GpuDriverVersion": "1.0",
"DiskType": "SYSTEM",
"ManagementFlags": [
"NoFlag"
],
"MemberEniIp": "192.168.XX.XX",
"PrimaryEniIp": "192.168.XX.XX",
"ProtocolType": "HDX",
"FotaVersion": "0.1.0-R-20220914.17****"
}
],
"OnlinePrePaidDesktopsCount": 100,
"RunningPrePaidDesktopsCount": 100,
"StopedPrePaidDesktopsCount": 100,
"StoppedPrePaidDesktopsCount": 100
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-06-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-10-14 | API 内部配置变更,不影响调用 | 查看变更详情 |