文档首页/ 图引擎服务 GES/ API参考/ 管理面API（V2）/ 备份管理API/ 查看所有备份列表(1.0.0)
更新时间：2024-04-28 GMT+08:00
查看PDF
分享

查看所有备份列表(1.0.0)

功能介绍

查询备份列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/graphs/backups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页资源数量的最大值，默认为10。

offset

否

Integer

本次请求的起始位置，默认为0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

backup_count

Integer

备份总个数。请求失败时，字段为空。

backup_list

Array of backup_list objects

当前Project ID下的所有图的备份列表。请求失败时，字段为空。
表5 backup_list

参数

参数类型

描述

id

String

备份ID。

name

String

备份名称。

backup_method

String

备份方法，取值为auto，manual或者import。

graph_id

String

备份关联的图ID。

graph_name

String

备份关联的图Name。

graph_status

String

备份关联的图状态。

graph_size_type_index

String

备份关联的图规格。

data_store_version

String

备份关联的图版本。

arch

String

备份关联的图CPU架构。

status

String

备份状态。

  • backing_up：备份中
  • success：备份成功
  • failed：备份失败

start_timestamp

Long

备份开始时间戳。

start_time

String

备份开始时间。

end_timestamp

Long

备份结束时间戳。

end_time

String

备份结束时间。

size

Long

备份文件大小，单位为MB。

duration

Long

备份时间，单位为秒。

encrypted

Boolean

是否加密。默认值为"false"，不加密。

  • true：表示加密。
  • false：表示不加密。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

系统提示信息。

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

error_msg

String

系统提示信息。

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

请求示例

查询备份列表。

GET https://Endpoint/v2/{project_id}/graphs/backups?offset=0&limit=3

响应示例

状态码： 200

成功响应示例

{
  "backup_count" : 3,
  "backup_list" : [ {
    "id" : "ada3e720-ab87-48cb-bff7-3ec5ae1a9652",
    "name" : "ges060803_nodelete-20210608135513",
    "backup_method" : "manual",
    "graph_id" : "4c5f882d-a813-4d78-a8e3-6d3212ddd121",
    "graph_name" : "ges060803_nodelete",
    "graph_status" : "200",
    "graph_size_type_index" : "1",
    "data_store_version" : "2.2.21",
    "arch" : "x86_64",
    "status" : "success",
    "start_timestamp" : 1623160513000,
    "start_time" : "2021-06-08T13:55:13",
    "end_timestamp" : 1623160568000,
    "end_time" : "2021-06-08T13:56:08",
    "size" : 1,
    "duration" : 54,
    "encrypted" : false
  }, {
    "id" : "7ed3f51d-816d-4651-9129-fe21b64b5c91",
    "name" : "ges060803_nodelete_20210609203323_auto",
    "backup_method" : "auto",
    "graph_id" : "4c5f882d-a813-4d78-a8e3-6d3212ddd121",
    "graph_name" : "ges060803_nodelete",
    "graph_status" : "200",
    "graph_size_type_index" : "1",
    "data_store_version" : "2.2.21",
    "arch" : "x86_64",
    "status" : "success",
    "start_timestamp" : 1623242004000,
    "start_time" : "2021-06-09T12:33:24",
    "end_timestamp" : 1623242004000,
    "end_time" : "2021-06-09T12:33:24",
    "size" : 1,
    "duration" : 0,
    "encrypted" : false
  }, {
    "id" : "604bfb46-04dd-45fc-a9ae-df24a0705b9d",
    "name" : "ges060802_nodelete-20210608135523",
    "backup_method" : "manual",
    "graph_id" : "9b9a05c2-0cdb-41ac-b55f-93caffb0519a",
    "graph_name" : "ges060802_nodelete",
    "graph_status" : "400",
    "graph_size_type_index" : "0",
    "data_store_version" : "2.2.23",
    "arch" : "x86_64",
    "status" : "success",
    "start_timestamp" : 1623160524000,
    "start_time" : "2021-06-08T13:55:24",
    "end_timestamp" : 1623160577000,
    "end_time" : "2021-06-08T13:56:17",
    "size" : 1,
    "duration" : 53,
    "encrypted" : false
  } ]
}

状态码： 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

服务不可用

错误码

请参见错误码。

父主题： 备份管理API

相关文档