Updated on 2024-05-20 GMT+08:00

Importing a Backup (2.3.16)

Function

This API is used to import a GES graph instance backup from OBS.

URI

POST /v2/{project_id}/graphs/{graph_id}/backups/import

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

graph_id

Yes

String

Graph ID

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token.

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

import_path

Yes

String

OBS path the backup is to be imported from

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

ID of the asynchronous job

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

System prompt code

  • If the execution succeeds, this parameter may be left blank.
  • If the execution fails, this parameter is used to display the error code.

error_msg

String

System prompt

  • If the execution succeeds, this parameter may be left blank.
  • If the execution fails, this parameter is used to display the error message.

Example Request

Import a backup.

POST https://Endpoint/v2/{project_id}/graphs/{graph_id}/backups/import
{
  "import_path" : "{obs_path}"
}

Example Response

Status code: 200

Example response for a successful request

{
  "job_id" : "ff8080815f9a3c84015f9a438ff70001"
}

Status code: 400

Example response for a failed request

{
  "error_msg" : "Parameter error!",
  "error_code" : "GES.0001"
}

Status Codes

Return Value

Description

400 Bad Request

Request error.

401 Unauthorized

Authorization failed.

403 Forbidden

No operation permissions.

404 Not Found

No resources found.

500 Internal Server Error

Internal server error.

503 Service Unavailable

Service unavailable.