移除备份路径 - RemoveAgentPath
功能介绍
移除已添加的文件备份路径。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v3/{project_id}/agents/{agent_id}/remove-path
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| agent_id | 是 | String | 参数解释: 客户端ID,用于标识备份客户端的唯一标识符,获取方法请参见查询客户端列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| remove_path | 是 | Array of strings | 参数解释: 需要移除的备份路径列表,每个元素为待移除的备份路径字符串 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| removed | Array of strings | 参数解释: 成功移除的备份路径列表,每个元素为已移除的备份路径字符串 |
| not_existed | Array of strings | 参数解释: 请求移除但不存在的备份路径列表,每个元素为不存在的路径字符串 |
请求示例
移除备份路径
POST https://{endpoint}/v3/{project_id}/agents/{agent_id}/remove-path
{
"remove_path" : [ "/tmp", "/home" ]
} 响应示例
状态码:200
{
"removed" : [ "/tmp" ],
"not_existed" : [ "/home" ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。