更新时间:2022-02-22 GMT+08:00

快速入门

本节通过调用云服务器备份的API为某台云服务器创建一次备份。

  • 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。

涉及API

当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。

  • IAM获取token的API
  • CSBS创建资源备份的API

具体步骤

  1. Token认证,具体操作请参考构造请求
  2. 获取项目ID,具体操作请参考获取项目ID
  3. 发送POST请求,请求地址为:"https://CSBS的Endpoint//v1/{project_id}/providers/fc4d5750-22e7-4798-8a46-f48f62c4c1da/resources/{resource_id}/action”,其中project_id替换为步骤2中获取到的项目ID,resource_id替换为是云服务器的ID。
  4. 在请求消息头中增加“X-Auth-Token”,值为步骤1中获取到的Token。
  5. 在请求响应体中传入如下的参数:
    {
        "protect" : {
            "backup_name" : "database_backup", //备份名称(非必填字符串)
            "description" : "backup for database version 2.2.1 before upgrade."  //备份描述(非必填字符串)
      }
    }

    请求响应成功后,会返回备份记录id(checkpoint_id),即请求响应体中checkpoint的id。

    若请求失败,则会返回错误码及对应的错误信息说明,详细错误码信息请参考错误码

  6. 通过checkpoint_id作为过滤参数查询备份结果,具体接口请参考查询所有备份,如果备份状态变为可用,代表备份成功。

    请求异常返回值说明请参考状态码

  7. 可以从步骤6的请求响应体中获取到备份id,备份完成后,通过备份记录id和备份id可以执行恢复云服务器、删除备份的操作。