GetAggregatedDesktops - 获取云电脑相关的聚合统计信息-无影云电脑企业版-阿里云帮助中心

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:GetAggregatedDesktops

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-shanghai
SearchRegionId	string	否	搜索地域 ID。用于过滤出指定地域的桌面信息。	cn-shanghai
AggregationFactor	string	否	聚合因子。枚举值： directory_id : 办公网络 ID region : 地域 policy_group_id : 云电脑策略 ID status : 云电脑状态	STATUS

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Aggregations	object	聚合字段信息列表。重要当您使用聚合查询时，仅返回聚合结果，不再返回匹配到的元信息列表。
DesktopAggregation	array<object>	聚合结果。
	object	聚合结果。
	string	聚合属性。	cn-hangzhou
RequestId	string	Id of the request	3147E094-C1F7-5001-8F04-C8CEE75D6552

AggregationFactor=REGION 时返回信息：

{
	"RequestId": "01A080DC-1350-51B6-8CE4-14245E15****",
	"Aggregations": {
		"DesktopAggregation": [{
			"cn-hangzhou": "1"
		}]
	}
}

示例

正常返回示例

JSON格式

{
  "Aggregations": {
    "DesktopAggregation": [
      {
        "key": "cn-hangzhou"
      }
    ]
  },
  "RequestId": "3147E094-C1F7-5001-8F04-C8CEE75D6552"
}

错误码

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

变更历史

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