注册客户端 - RegisterAgent

功能介绍

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

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	客户端类型：有native和cloud两种 native：本地客户端，客户端安装在本地。 cloud：云上客户端，客户端安装在云端。

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
agent	Agent object	客户端详情

表6 Agent
参数	参数类型	描述
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	客户端的备份路径

表7 Path
参数	参数类型	描述
id	String	路径ID
status	String	路径状态，有available和remove两种状态 available：可用状态，表示文件备份路径状态正常，可以使用。 remove：移除状态，表示文件备份路径状态已被移除，无法使用。
agent_id	String	该路径所属于的客户端ID
dir_path	String	路径详情
exclude_paths	String	排除目录列表，多个路径之间以英文逗号分隔。说明：该特性目前处于公测阶段,部分region可能无法使用。

请求示例

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

{
  "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"
  }
}