检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
云商店开放接口指南 接口使用方法 公共参数 接口列表 公共错误码 APIGW网关错误码 开放接口示例代码 父主题: 联营License客户端软件对接指南
API概览 云备份所提供的接口均为CBR接口,您可以通过这些接口完整的使用云备份的所有功能。 表1 接口说明 类型 说明 任务 可以查询任务列表和单个任务的情况。 可保护性 可以查询所在区域的复制能力,本区域是否支持复制备份和存储库。 存储库 可以实现创建存储库、存储库查询、为存储库绑定策略等操作。
API 运营 文件应用备份 任务 存储库 项目 策略 备份 可保护性 备份共享 组织策略 标签 还原点 计量
如何调用API 构造请求 认证鉴权 返回结果
对外API规范 API规范示例 为了对外API在调用时有用户信息,API调用时需要在header中传递Modifier、Creator字段。 值格式为:用户名+空格+用户id,如图1所示。
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数
拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
项目 查询租户的项目信息 查询租户项目列表 查询租户信息 租户迁移 查询迁移 父主题: API
任务 查询单个任务 查询任务列表 父主题: API
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 checkpoint 是
查询存储库资源实例 批量添加删除存储库资源标签 添加存储库资源标签 删除存储库资源标签 查询存储库资源标签 查询存储库项目标签 父主题: API
完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头,其中“X-Subject-To
示例1:创建弹性云服务器备份 场景描述 本章节指导用户通过API创建云服务器备份。API的调用方法请参见如何调用API 。 创建备份时,支持云服务器或磁盘等资源备份。本节以云服务器为例,介绍如何创建云服务器备份。 约束限制 该接口以创建按需计费的存储库为例。 涉及接口 创建云服务器备份时,需要进行创建备
策略 创建策略 查询单个策略 查询策略列表 修改策略 删除策略 父主题: API
计量 查询容量统计 父主题: API
运营 变更(废弃) 变更 父主题: API
组织策略 创建组织策略 查询组织策略列表 更新组织策略 删除组织策略 查询组织策略部署状态列表 查询指定组织策略 父主题: API
备份 同步备份 查询指定备份 查询所有备份 删除备份 复制备份 备份恢复 查询备份元数据 更新备份 父主题: API
变更(废弃) 功能介绍 订单更新,创建cbc订单后,调用该接口更新包周期产品订单信息。该接口已废弃。 URI PUT /v3/{project_id}/orders/{order_id} 表1 路径参数 参数 是否必选 参数类型 描述 order_id 是 String 订单ID
备份共享 添加备份成员 更新备份成员状态 获取备份成员详情 获取备份成员列表 删除指定备份成员 父主题: API
变更 功能介绍 订单更新,调用该接口更新包周期产品订单信息,返回待支付订单信息。 该接口目前属于公测阶段,部分region暂时无法使用。 URI POST /v3/{project_id}/orders/change 表1 路径参数 参数 是否必选 参数类型 描述 project_id
设置存储库策略 解除存储库策略 查询其他区域存储库列表 迁移资源 批量修改存储库 设置存储库资源 创建包周期存储库 存储库容量总览 父主题: API