文档首页/ 云备份 CBR/ API参考/ API/ 文件应用备份/ 注册客户端
更新时间：2024-11-25 GMT+08:00
编辑
查看PDF
分享

注册客户端

功能介绍

注册客户端，安装时候由Agent调用，无需手动注册。

exclude_paths字段属于排除路径，该字段目前属于公测阶段。

URI

POST /v3/{project_id}/agents

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用。
表3 请求Body参数

参数

是否必选

参数类型

描述

agent

是

AgentRegister object

客户端注册参数
表4 AgentRegister

参数

是否必选

参数类型

描述

agent_id

是

String

客户端ID

host_name

是

String

客户端所在的主机名

host_ip

是

String

客户端所在主机的IP

host_os

是

String

客户端所在主机的操作系统

host_nickname

否

String

客户端所在主机的主机别名

agent_version

否

String

客户端版本

agent_type

否

String

客户端类型，分本地客户端和云上客户端(cloud/native)

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

agent

Agent object

客户端详情
表6 Agent

参数

参数类型

描述

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

Array of Path objects

客户端的备份路径
表7 Path

参数

参数类型

描述

id

String

路径ID

status

String

路径状态，有available和remove两种状态

agent_id

String

该路径所属于的客户端ID

dir_path

String

路径详情

exclude_paths

String

排除目录列表，多个路径之间以英文逗号分隔

请求示例

注册客户端由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

错误码

请参见错误码。

父主题： 文件应用备份

相关文档