文档首页/ 云备份 CBR/ API参考/ API/ 文件应用备份/ 修改客户端
更新时间：2025-09-18 GMT+08:00
编辑
查看PDF
分享

修改客户端

功能介绍

修改客户端状态

URI

PUT /v3/{project_id}/agents/{agent_id}

表1 路径参数

参数

是否必选

参数类型

描述

agent_id

是

String

客户端ID

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

agent

是

AgentUpdate object

待更新的agent参数
表4 AgentUpdate

参数

是否必选

参数类型

描述

status

是

String

客户端状态，目前仅有uninstall一种状态

  • uninstall：当前只支持卸载，由客户端被卸载时自动触发，表示更新正在进行。

响应参数

状态码：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可能无法使用。

请求示例

更新客户端状态为卸载

PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents/79bd9daa-884f-4f84-b8fe-235d58cd927d

{
  "agent" : {
    "status" : "uninstall"
  }
}

响应示例

状态码：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" : "uninstall",
    "last_active_time" : "2022-01-30T09:28:08.960+00:00",
    "paths" : [ {
      "id" : "5684b0fb-44c8-4c70-bb59-b03ec2738360",
      "agent_id" : "0cba3ff9-f836-4178-9ce8-91dc8026321c",
      "dir_path" : "/opt/huaweicloud/cbragent/lib",
      "status" : "available",
      "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test"
    }, {
      "id" : "1ad949d5-c955-4995-8c28-60fc8b110a21",
      "agent_id" : "0cba3ff9-f836-4178-9ce8-91dc8026321c",
      "dir_path" : "/opt/backup",
      "status" : "available",
      "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test"
    } ]
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 文件应用备份

相关文档