AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

ListOfficeSiteOverview - 查询办公网络的概览信息

更新时间：
复制为 MD 格式
产品详情
我的收藏

查询办公网络（原工作区）的概览信息，包括状态、云电脑数量、VPC网络类型等。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:ListOfficeSiteOverview

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

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

cn-hangzhou
ForceRefresh

boolean

否

是否刷新缓存。

枚举值：

  • true :

    跳过缓存获取最新数据。

  • false :

    获取缓存中的数据，可以提升接口性能。

false
MaxResults

integer

否

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

  • 最大值：100。

  • 默认值：10。

10
NextToken

string

否

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

caeba0bbb2be03f84eb48b699f0a4883
OfficeSiteId

array

否

办公网络 ID。可指定 1~100 个。

cn-hangzhou+dir-363353****

string

否

办公网络 ID。

cn-hangzhou+dir-363353****
QueryRange

integer

否

查询范围。池化云电脑是指云电脑池（原桌面组）中的云电脑。

枚举值：

  • 1 :

    查询办公网络内的非池化云电脑 [默认值]

  • 2 :

    查询办公网络内的池化云电脑

  • 3 :

    查询办公网络下所有云电脑

1

返回参数

名称

类型

描述

示例值

object

返回信息集合。

NextToken

string

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

caeba0bbb2be03f84eb48b699f0a4883
RequestId

string

请求 ID。

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

array<object>

办公网络信息集合。

object

办公网络信息。

OfficeSiteStatus

string

办公网络状态。

枚举值：

  • CONFIGUSERFAILED :

    配置用户失败

  • REGISTERING :

    注册中

  • REGISTERED :

    已注册

  • NEEDCONFIGTRUST :

    请配置信任关系

  • CONFIGUSERING :

    正在配置用户

  • CONFIGTRUSTFAILED :

    配置信任失败

  • ERROR :

    错误

  • CONFIGTRUSTING :

    正在配置信任关系

  • NEEDCONFIGUSER :

    请配置用户

REGISTERED
TotalEdsCount

integer

办公网络内云电脑的总数。

1
TotalEdsCountForGroup

integer

云电脑池中的云电脑的总数。

1
WillExpiredEdsCount

integer

办公网络内即将过期的云电脑数量。

0
WillExpiredEdsCountForGroup

integer

云电脑池中即将过期的云电脑数量。

0
OfficeSiteId

string

办公网络 ID。

cn-hangzhou+dir-363353****
RunningEdsCount

integer

办公网络内正在运行中的云电脑数量。

1
RunningEdsCountForGroup

integer

云电脑池中正在运行的云电脑数量。

1
OfficeSiteName

string

办公网络名称。

test
VpcType

string

办公网络 VPC 网络类型。

枚举值：

  • standard :

    标准型办公网络，独占 VPC。 [默认值]

  • customized :

    定制型办公网络，用户侧 VPC。

  • basic :

    基础型办公网络，共享 VPC。

standard
HasExpiredEdsCount

integer

办公网络内已过期的云电脑数量。

0
HasExpiredEdsCountForGroup

integer

云电脑池中已过期的云电脑数量。

0
RegionId

string

办公网络所属的地域 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"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：办公网络通用下一篇：DescribeOfficeSites - 查询办公网络的详细信息