注册客户端 - RegisterAgent

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

agent

是

AgentRegister object

参数解释：

客户端注册参数，用于传递客户端注册所需的全部参数信息，包括客户端标识、主机信息等

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

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：云上客户端，客户端安装在云端。

默认取值：

不涉及

agent

Agent object

参数解释：

客户端详情，返回客户端的完整信息，包括客户端标识、主机信息、状态等

取值范围：

不涉及

created_at

String

参数解释：

客户端创建时间，格式为YYYY-MM-DDTHH:MM:SS.ffffff

取值范围：

不涉及

updated_at

String

参数解释：

客户端更新时间，格式为YYYY-MM-DDTHH:MM:SS.ffffff

取值范围：

不涉及

agent_id

String

参数解释：

客户端ID，用于标识备份客户端的唯一标识符

取值范围：

不涉及

agent_version

String

参数解释：

客户端版本号

取值范围：

不涉及

agent_type

String

参数解释：

客户端类型

取值范围：

native：本地客户端，客户端安装在本地。

cloud：云上客户端，客户端安装在云端。

host_name

String

参数解释：

客户端所在的主机名

取值范围：

不涉及

host_nickname

String

参数解释：

客户端所在的主机昵称

取值范围：

不涉及

host_ip

String

参数解释：

客户端所在主机的IP

取值范围：

不涉及

host_os

String

参数解释：

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

取值范围：

不涉及

status

String

参数解释：

客户端状态

取值范围：

normal:正常状态，表示客户端可以正常使用。

abnormal：异常状态，表示系统监测出系统有异常需要修复，此时部分功能可能受阻。

uninstall：卸载状态，表示客户端已被卸载或客户端正在升级过程中。

last_active_time

String

参数解释：

客户端上次激活时间，格式为YYYY-MM-DDTHH:MM:SS.ffffff

取值范围：

不涉及

paths

Array of Path objects

参数解释：

客户端的备份路径，包含路径ID、路径状态、目录详情等属性

取值范围：

不涉及

id

String

参数解释：

路径ID

取值范围：

不涉及

status

String

参数解释：

路径状态

取值范围：

available：可用状态，表示文件备份路径状态正常，可以使用。

remove：移除状态，表示文件备份路径状态已被移除，无法使用。

agent_id

String

参数解释：

该路径所属于的客户端ID

取值范围：

不涉及

dir_path

String

参数解释：

路径详情

取值范围：

不涉及

exclude_paths

String

参数解释：

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

取值范围：

不涉及

200

OK