更新时间:2024-07-26 GMT+08:00

获取备份下载链接(2.4.3)

功能介绍

通过该API,您可以获取备份文件下载链接,在有效期(3600秒)之内,您可以通过URL直接下载备份文件。

URI

GET /v2/{project_id}/graphs/{graph_id}/backup-files?backup_id={backup_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

graph_id

String

图ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

backup_id

String

备份ID。获取方法请参考查看某个图的备份列表

X-Auth-Token

String

用户Token。

用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

bucket

String

文件所在的桶名。

files

Array of objects

备份包含的文件列表。详情请参见表 files字段数据结构说明

表4 files字段数据结构说明

参数

参数类型

描述

name

String

文件名。

size

Long

文件大小,单位:KB。

download_link

String

文件下载链接。

说明:

备份文件类型不同,浏览器打开该链接的方式不同。

例如:文本文件可直接通过浏览器打开浏览,而二进制文件会在浏览器打开时,自动下载到本地。如果需要完整的下载所有备份文件,建议通过某种编程语言的的HTTP库下载,比如Java的HttpClient、Python的requests等。

link_expired_time

String

下载链接过期时间,格式为“yyyy-mm-ddThh:mm:ss”。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误码。

error_msg

String

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误信息。

请求示例

获取备份下载链接。

GET https:/Endpoint/v2/{project_id}/graphs/{graph_id}/backup-files?backup_id=22aa0177-b20b-4f3a-8556-8147d6658ed8

响应示例

状态码: 200

成功响应示例

{
  "bucket": "string",
  "files": [
    {
      "name": "43e4feaab48f11e89039fa163ebaa7e4br01.xxx",
      "size": 2803,
      "download_link": "https://obs.domainname.com/rdsbucket.username.1/xxxxxx",
      "link_expired_time": "2018-08-016T10:15:14+0800"
    }
  ]
}

状态码: 400

失败响应示例

{
  "error_code": "GES.7006",
  "error_msg": "The underlying graph engine has internal error."
}

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码