文档首页/ 云备份 CBR/ API参考/ API/ 文件应用备份/ 新增备份路径 - AddAgentPath
更新时间：2026-10-20 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新增备份路径 - AddAgentPath

功能介绍

对客户端新增备份路径，新增的路径不会校验是否存在。

授权信息

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

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

URI

POST /v3/{project_id}/agents/{agent_id}/add-path

表1 路径参数

参数

是否必选

参数类型

描述

agent_id

是

String

参数解释：

客户端ID，用于标识备份客户端的唯一标识符，获取方法请参见查询客户端列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

add_path

是

Array of strings

参数解释：

要添加的文件备份路径列表，即 agent 需要备份哪些目录。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

exclude_path

否

Array of ExcludePath objects

参数解释：

排除路径映射列表，指定哪些备份路径下的子目录在备份时需要排除（不备份）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

说明：
该特性目前处于公测阶段，部分Region可能无法使用。
表4 ExcludePath

参数

是否必选

参数类型

描述

path_name

否

String

参数解释：

备份路径名，即要设置排除规则的备份目录。

约束限制：

必须存在于 add_path 列表中。

取值范围：

不涉及

默认取值：

不涉及

exclude_path_name

否

Array of strings

参数解释：

排除路径名列表，即在 path_name 指定的备份目录下，哪些子目录/文件路径在备份时需要排除。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

added

Array of strings

参数解释：

列表中的参数代表新添加成功的路径

existed

Array of strings

参数解释：

列表中的参数代表已经存在的路径

请求示例

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

{
  "add_path" : [ "/home/hcp", "/opt/workspace/" ],
  "exclude_path" : [ {
    "path_name" : "/home/hcp",
    "exclude_path_name" : [ "/home/hcp/1", "/home/hcp/2" ]
  }, {
    "path_name" : "/opt/workspace/",
    "exclude_path_name" : [ "/opt/workspace/1", "/opt/workspace/2" ]
  } ]
}

响应示例

状态码：200

{
  "added" : [ "/opt/backup", "/var/log" ],
  "existed" : [ "/tmp/backup" ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 文件应用备份

相关文档