查询客户端列表ListAgent
功能介绍
查询客户端列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v3/{project_id}/agents
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
agent_id |
否 |
String |
客户端ID |
|
limit |
否 |
String |
每页显示条目数，正整数 最小长度：1 最大长度：1000 |
|
offset |
否 |
Integer |
偏移值,正整数 |
|
status |
否 |
String |
状态 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
agents |
客户端实例列表 |
|
|
count |
Integer |
客户端个数 |
|
limit |
Integer |
每页显示的条目数量 |
|
offset |
Integer |
偏移量，表示从此偏移量开始查询 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
created_at |
String |
客户端创建时间 |
|
updated_at |
String |
客户端更新时间 |
|
agent_id |
String |
客户端ID |
|
agent_version |
String |
客户端版本号 |
|
agent_type |
String |
客户端类型 |
|
host_name |
String |
客户端所在的主机名 |
|
host_nickname |
String |
客户端所在的主机昵称 |
|
host_ip |
String |
客户端所在主机的IP |
|
host_os |
String |
客户端主机所在的操作系统 |
|
status |
String |
客户端状态 |
|
last_active_time |
String |
客户端上次激活时间 |
|
paths |
客户端的备份路径 |
请求示例
GET https://{endpoint}/v3/{project_id}/agents
响应示例
状态码： 200
OK
{
"count" : 2,
"limit" : 1000,
"offset" : 0,
"agents" : [ {
"created_at" : "2022-01-30T09:28:09.334153",
"updated_at" : null,
"agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114",
"host_name" : "eBackup",
"host_ip" : "18.9.158.36",
"status" : "normal",
"last_active_time" : "2022-01-30T09:28:08.959908",
"paths" : null
}, {
"created_at" : "2022-01-14T06:47:17.524133",
"updated_at" : "2022-01-28T05:01:32.738510",
"agent_id" : "fb711278-e872-4224-b442-8dafc36a543d",
"host_name" : "ecs-00001",
"host_ip" : "10.10.0.1",
"status" : "normal",
"last_active_time" : "2022-01-28T05:01:32.000000",
"paths" : [ {
"id" : "6c3d1ed6-b7d7-4e27-94ee-321431e84c5c",
"dir_path" : "/home/hcp",
"status" : "available",
"agent_id" : "fb711278-e872-4224-b442-8dafc36a543d"
}, {
"id" : "e2af0fdd-9644-4db8-986e-5a6a2395c390",
"dir_path" : "/opt/workspace",
"status" : "available",
"agent_id" : "fb711278-e872-4224-b442-8dafc36a543d"
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
