ListHives - 查询集群信息-视图计算(VECS)-阿里云帮助中心

接口说明

请求说明

该 API 用于查询用户创建的所有集群信息。
支持通过 HiveId 和 Name 参数进行过滤查询。
分页参数 PageNumber 和 PageSize 可以控制返回结果的数量和页码，默认每页显示 10 条记录，最大支持 100 条。
StartTime 和 EndTime 参数可用于指定时间范围内的集群信息查询，但非必填项。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

vs:ListHives

none

*Crs

acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}

无

请求参数

名称	类型	必填	描述	示例值
HiveId	string	否	云应用服务组 ID	g-xxxx
Name	string	否	名称	test001
PageNumber	integer	否	查询列表的页码。起始值为 1。默认值：1。	1
PageSize	integer	否	分页查询时设置的每页行数，最大值为 100 行。默认值：10。	20
StartTime	string	否	创建时间	2025-05-14T15:20:37+08:00
EndTime	string	否	时间区间筛选参数。按照 ISO8601 标准表示，并需要使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2025-05-14T15:20:37+08:00

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	xxxx-xxx-xxx
Hives	array<object>	集群列表
	object
HiveId	string	集群 ID	hive-3b506f0868a7451ba15e0e890706033a
Name	string	名称	yy-test2
Description	string	描述	基础型S1
CreationTime	string	创建时间	2025-05-14T15:20:37+08:00
TotalCount	integer	总量	100

示例

正常返回示例

JSON格式

{
  "RequestId": "xxxx-xxx-xxx",
  "Hives": [
    {
      "HiveId": "hive-3b506f0868a7451ba15e0e890706033a",
      "Name": "yy-test2",
      "Description": "基础型S1",
      "CreationTime": "2025-05-14T15:20:37+08:00"
    }
  ],
  "TotalCount": 100
}

错误码

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

变更历史

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