获取计算节点列表
功能介绍
功能描述：用户可以使用该接口获取可信节点信息列表。支持节点名称与空间名称的模糊查询。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/agents
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目id，最大32位，字母和数字组成 最小长度：0 最大长度：32 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limit |
是 |
Integer |
每页记录数，取值0-100 最小值：0 最大值：100 缺省值：10 |
offset |
是 |
Integer |
记录数偏移量 最小值：0 最大值：2147483647 缺省值：0 |
agent_name |
否 |
String |
可信节点名称 |
league_name |
否 |
String |
空间名称 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户凭证 |
Content-Type |
是 |
String |
消息体的类型（格式） 缺省值：application/json |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
lists |
Array of AgentListVo objects |
实例集合 |
total |
Long |
总记录数 |
参数 |
参数类型 |
描述 |
|---|---|---|
agent_id |
String |
可信节点id |
agent_name |
String |
可信节点名称 |
create_time |
String |
创建时间 |
creator_domain_id |
String |
创建者租户id |
creator_user_name |
String |
创建者名称 |
deploy_status |
String |
部署状态：ABNORMAL正常，RESTARTING重启中，RESTART_FAILED重启失败，ROLLBACKING回滚中，STARTING启动中，DEPLOYING创建中，DEPLOY_FAILED创建失败，DEPLOY_SUCCESS创建成功，RUNNING运行中，DELETING删除中，DELETE_FAILED删除失败，DELETE_SUCCESS删除成功，UPGRADING升级中，UPGRADE_FAILED升级失败，ROLLBACK回退中，ROLLBACK_FAILED回退失败，SUCCESS成功，FAILED失败，TO_START待开始，IN_PROGRESS进行中 枚举值：
|
deploy_type |
String |
部署类型。CCE，IEF，EXTERNAL 枚举值：
|
deployment_event_information |
String |
部署事件状态 |
enable_delete |
Boolean |
是否可删除 |
enable_upgrade |
Boolean |
是否可升级 |
image_version |
String |
节点镜像版本 |
is_high_avail |
Boolean |
节点是否高可用 |
league_id |
String |
空间ID |
league_name |
String |
空间名称 |
league_version |
String |
空间版本 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
获取节点列表信息
get /v1/{project_id}/agents?offset=0&limit=10
响应示例
状态码： 200
查询节点列表成功
{
"total" : 1,
"lists" : [ {
"highAvail" : false,
"agent_id" : "22a38e92ef7e4284b666b2a14bc29462",
"agent_name" : "agent_7819",
"league_name" : "test",
"image_version" : "1.15.1",
"league_version" : "1.15.1",
"league_id" : "ef73b252a0ad4b5db21a12c40a413b2f",
"creator_user_name" : "user01",
"creator_domain_id" : "098593b06a80d2a30f5fc004c28f6da0",
"is_high_avail" : false,
"deploy_type" : "CCE",
"deploy_status" : "RUNNING",
"create_time" : "2022-10-08T08:54:26.000+00:00",
"enable_upgrade" : false,
"deployment_event_information" : "Closing agent container",
"enable_delete" : false
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
查询节点列表成功 |
500 |
查询节点列表失败 |
