查询边缘资源池列表
功能介绍
查询边缘资源池列表
URI
GET /v2/{project_id}/edge-pools
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
用户项目ID，获取方法参见获取项目ID和名称 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_paged |
否 |
Boolean |
是否分页 缺省值：false |
|
page_size |
否 |
Integer |
第几页 最小值：1 最大值：1000 缺省值：100 |
|
page_num |
否 |
Integer |
页大小 最小值：1 最大值：10000 缺省值：1 |
|
name_like |
否 |
String |
模糊查询名称，满足正则表达式^[a-z0-9-]{1,30}$ |
|
order_by |
否 |
String |
排序方式，根据传入的sort_name的值进行正序或倒序地排序。asc为正序，desc为倒序。 枚举值：
缺省值：desc |
|
sort_name |
否 |
String |
排序字段。枚举值：
缺省值：created_at |
|
state |
否 |
String |
状态筛选，单选。枚举值：
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token，获取方法参见认证鉴权 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
边缘资源池总量 |
|
edge_pools |
Array of EdgePoolListItemDto objects |
边缘资源池列表响应体 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
边缘池ID |
|
name |
String |
边缘池名称 |
|
state |
String |
边缘池状态 |
|
project_id |
String |
用户项目ID |
|
workspace_id |
String |
工作空间ID |
|
created_at |
Long |
创建时间 |
|
updated_at |
Long |
更新时间 |
|
description |
String |
描述信息 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息描述 |
|
detail |
String |
错误详情 |
|
params |
Array of strings |
错误参数列举 数组长度：0 - 1 |
|
reason |
String |
错误原因 |
|
advice |
String |
建议 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
内部错误 |
错误码
请参见错误码。
