更新时间:2023-08-16 GMT+08:00

启动图(1.0.0)

功能介绍

启动一个图。暂时不用的图可以先关闭,需要使用时再启动。

URI

POST /v2/{project_id}/graphs/{graph_id}/start

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

graph_id

String

图ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

graph_backup_id

String

启动图时关联的备份ID,设置此参数时,表示从备份进行启动;如果为空,表示从上次关闭图时的状态启动。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

启动图任务ID。请求失败时字段为空。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

系统提示信息。

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

error_msg

String

系统提示信息。

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

请求示例

启动一个图,关联的备份ID为08a898ae-3ff8-40e8-a7ed-03afe05aedbb。

POST https://Endpoint/v2/{project_id}/graphs/{graph_id}/start

{
  "graph_backup_id" : "08a898ae-3ff8-40e8-a7ed-03afe05aedbb"
}

响应示例

状态码: 200

成功响应示例

{
  "job_id" : "ff8080816025a0a1016025a5a2700007"
}

状态码: 400

失败响应示例

{
  "error_code" : "GES.7006",
  "error_msg" : "An internal error occurs in the underlying service of the graph engine."
}

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码