检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 云备份所提供的接口均为CBR接口,您可以通过这些接口完整的使用云备份的所有功能。 表1 接口说明 类型 说明 任务 可以查询任务列表和单个任务的情况。 可保护性 可以查询所在区域的复制能力,本区域是否支持复制备份和存储库。 存储库 可以实现创建存储库、存储库查询、为存储库绑定策略等操作。
如何调用API 构造请求 认证鉴权 返回结果
API 运营 文件应用备份 任务 存储库 项目 策略 备份 可保护性 备份共享 组织策略 标签 还原点 计量
查询租户信息 功能介绍 由控制台调用的内部接口,用于仅在查询共享备份时获取源project_id的域名信息,目前仅能查询当前账号下的项目信息。 URI GET /v3/domain/{source_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 source_project_id
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数
云服务器备份和云硬盘备份有什么区别? 两者的主要差异如表1所示。 表1 云服务器备份和云硬盘备份的区别 对比维度 云服务器备份 云硬盘备份 备份/恢复对象 服务器中的全部(系统盘和数据盘)或部分云硬盘 指定的单个或多个磁盘(系统盘或数据盘) 推荐场景 需要对整个云服务器进行保护
参数类型 描述 dest_project_id 否 String 接受备份共享的项目id image_id 否 String 接受的共享备份副本注册的镜像id limit 否 Integer 每页显示的条目数量,正整数 marker 否 String 上一次查询最后一条的id,仅支持uuid
查询存储库资源实例 批量添加删除存储库资源标签 添加存储库资源标签 删除存储库资源标签 查询存储库资源标签 查询存储库项目标签 父主题: API
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 restore 是 BackupRestore
对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头,其中“X-Subject-Token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
文件应用备份 新增备份路径 查询指定客户端 修改客户端 注册客户端 移除客户端 移除备份路径 查询客户端列表 父主题: API
拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 member
项目 查询租户的项目信息 查询租户项目列表 查询租户信息 租户迁移 查询迁移 父主题: API
权限和授权项 权限及授权项说明 CBR授权项分类
权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 变更存储库 PUT /v3/{project_id}/orders/{order_id} cbr:vaults:updateOrder √ √ 父主题: 权限和授权项
更新备份成员状态 功能介绍 更新备份共享成员的状态,需要接收方执行此API。 URI PUT /v3/{project_id}/backups/{backup_id}/members/{member_id} 表1 路径参数 参数 是否必选 参数类型 描述 backup_id 是 String
目前TMS调用时,key下面只包含一个value,0表示默认企业项目。 sys_tags和租户标签过滤条件(tags、tags_any、not_tags、not_tags_any)不能同时使用。 无sys_tags时按照tag接口处理,无tag过滤条件时返回全量数据。 sys_tags不能为空列表 limit
账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要
X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 无 请求示例 解除注册客户端 DELETE https://{endpoint}/v3/f841e01fd2b1