首页 无影云桌面 API参考(云桌面管控) API目录 工作区 ListOfficeSiteOverview - 查询工作区的概览

ListOfficeSiteOverview - 查询工作区的概览

查询工作区的概览信息。

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。可以调用DescribeRegions获取无影云桌面支持的地域列表。

cn-hangzhou
ForceRefreshboolean

是否刷新缓存。

false
MaxResultsinteger

分页查询时,每页最大行数。

  • 最大值:100。
  • 默认值:10。
10
NextTokenstring

下一次查询的令牌(Token)。第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次API调用返回的NextToken值。

caeba0bbb2be03f84eb48b699f0a4883
OfficeSiteIdarray

工作区ID。可指定1~100个。

string

工作区ID。

cn-hangzhou+dir-363353****
QueryRangeinteger

查询范围。默认值=1

说明桌面组功能处于邀测中,如需体验,请提交工单。
1

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

下一个查询开始的Token,NextToken为空表示没有下一个。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
OfficeSiteOverviewResultsarray

工作区信息集合。

object

工作区信息。

OfficeSiteStatusstring

工作区状态。

REGISTERED
TotalEdsCountinteger

工作区下云桌面的总数。

1
TotalEdsCountForGroupinteger

桌面组下云桌面的总数。

1
WillExpiredEdsCountinteger

工作区下快过期的云桌面数量。

0
WillExpiredEdsCountForGroupinteger

桌面组下快过期的云桌面数量。

0
OfficeSiteIdstring

工作区ID。

cn-hangzhou+dir-363353****
RunningEdsCountinteger

工作区下正在运行中的云桌面数量。

1
RunningEdsCountForGroupinteger

桌面组下正在运行的云桌面数量。

1
OfficeSiteNamestring

工作区名称。

test
VpcTypestring

工作区VPC网络类型。

standard
HasExpiredEdsCountinteger

工作区下已过期的云桌面数量。

0
HasExpiredEdsCountForGroupinteger

桌面组下已过期的云桌面数量。

0
RegionIdstring

工作区所属的地域ID。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "OfficeSiteOverviewResults": [
    {
      "OfficeSiteStatus": "REGISTERED",
      "TotalEdsCount": 1,
      "TotalEdsCountForGroup": 1,
      "WillExpiredEdsCount": 0,
      "WillExpiredEdsCountForGroup": 0,
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "RunningEdsCount": 1,
      "RunningEdsCountForGroup": 1,
      "OfficeSiteName": "test",
      "VpcType": "standard",
      "HasExpiredEdsCount": 0,
      "HasExpiredEdsCountForGroup": 0,
      "RegionId": "cn-hangzhou"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-12-09OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 无影云桌面 相关技术圈