文档首页/ 视频智能分析服务 VIAS/ API参考/ 平台API/ 运维中心/ 查询边缘资源池列表 - ListEdgePools
更新时间：2025-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询边缘资源池列表 - ListEdgePools

功能介绍

查询边缘资源池列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/edge-pools

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

用户项目ID，获取方法参见获取项目ID和名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

指定每一页返回的最大条目数。

约束限制：

不涉及。

取值范围：

1-10000

默认取值：

1000

offset

否

Integer

参数解释：

分页列表的起始页。

约束限制：

不涉及。

取值范围：

0-10000

默认取值：

0

name_like

否

String

参数解释：

模糊查询名称。

约束限制：

不涉及。

取值范围：

满足正则表达式^[a-z0-9-]{1,30}$。

默认取值：

不涉及。

order_by

否

String

参数解释：

排序方式，根据传入的sort_name的值进行排序。

约束限制：

不涉及。

取值范围：

  • desc（倒序）

  • asc（正序）

默认取值：

desc

sort_name

否

String

参数解释：

排序字段。

约束限制：

不涉及。

取值范围：

  • created_at

  • updated_at

默认取值：

created_at

state

否

String

参数解释：

状态。

约束限制：

不涉及。

取值范围：

  • Running

  • Abnormal

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，获取方法参见认证鉴权。

约束限制：

不涉及。

取值范围：

字符串长度[0, 32768]。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释：

边缘资源池总量。

取值范围：

不涉及。

edge_pools

Array of EdgePoolListItemDto objects

参数解释：

边缘资源池列表响应体。

取值范围：

不涉及。
表5 EdgePoolListItemDto

参数

参数类型

描述

id

String

参数解释：

边缘池ID。

取值范围：

不涉及。

name

String

参数解释：

边缘池名称。

取值范围：

不涉及。

state

String

参数解释：

边缘池状态。

取值范围：

不涉及。

project_id

String

参数解释：

用户项目ID。

取值范围：

不涉及。

workspace_id

String

参数解释：

工作空间ID。

取值范围：

不涉及。

created_at

Long

参数解释：

创建时间。

取值范围：

不涉及。

updated_at

Long

参数解释：

更新时间。

取值范围：

不涉及。

description

String

参数解释：

描述信息。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

请求示例

查询边缘资源池列表，查询结果支持分页，且页数为1，每页10条数据

GET https://{endpoint}/v2/{project_id}/edge-pools?is_paged=true&page_size=10&page_num=1

响应示例

状态码：200

获取边缘资源池列表响应体。

{
  "count" : 2,
  "edge_pools" : [ {
    "id" : "xxx",
    "name" : "test1",
    "state" : "Running",
    "project_id" : "xxx",
    "workspace_id" : "0",
    "created_at" : 1685611513591,
    "updated_at" : 1685611513591
  }, {
    "id" : "xxx",
    "name" : "test2",
    "state" : "Running",
    "project_id" : "xxx",
    "workspace_id" : "0",
    "created_at" : 1683344661036,
    "updated_at" : 1683344661036
  } ]
}

状态码

状态码

描述

200

获取边缘资源池列表响应体。

400

请求错误。

500

内部错误。
父主题： 运维中心

相关文档