注册客户端
功能介绍
注册客户端，安装时候由Agent调用，无需手动注册。
URI
POST /v3/{project_id}/agents
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
agent |
是 |
AgentRegister object |
客户端注册参数 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
agent |
Agent object |
客户端详情 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
created_at |
String |
客户端创建时间 |
|
updated_at |
String |
客户端更新时间 |
|
agent_id |
String |
客户端ID |
|
agent_version |
String |
客户端版本号 |
|
agent_type |
String |
客户端类型：有native和cloud两种 native：本地客户端，客户端安装在本地。 cloud：云上客户端，客户端安装在云端。 |
|
host_name |
String |
客户端所在的主机名 |
|
host_nickname |
String |
客户端所在的主机昵称 |
|
host_ip |
String |
客户端所在主机的IP |
|
host_os |
String |
客户端主机所在的操作系统 |
|
status |
String |
客户端状态，有normal，abnormal和uninstall三种状态 normal:正常状态，表示客户端可以正常使用。 abnormal：异常状态，表示系统监测出系统有异常需要修复，此时部分功能可能受阻。 uninstall：卸载状态，表示客户端已被卸载或客户端正在升级过程中。 |
|
last_active_time |
String |
客户端上次激活时间 |
|
paths |
Array of Path objects |
客户端的备份路径 |
请求示例
注册客户端由agent安装时自动触发，无需客户手动调用。
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents
{
"agent" : {
"agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114",
"host_name" : "ecs-00002",
"host_ip" : "10.10.0.2",
"host_os" : "linux",
"agent_version" : "1.0.0",
"agent_type" : "native"
}
}
响应示例
状态码：200
OK
{
"agent" : {
"created_at" : "2022-01-30T09:28:09.334+00:00",
"updated_at" : "2022-01-30T09:28:09.334+00:00",
"agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114",
"agent_version" : "1.0.0",
"agent_type" : "native",
"host_name" : "ecs-0001",
"host_nickname" : "",
"host_ip" : "192.168.10.144",
"host_os" : "linux",
"status" : "normal",
"last_active_time" : "2022-01-30T09:28:08.960+00:00"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
