更新时间:2022-08-09 GMT+08:00

升级图

功能介绍

升级图。图引擎服务会定期升级版本,用户可根据需要升级图。

URI

POST /v1.0/{project_id}/graphs/{graph_id}/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目编号,用于资源隔离。请参考获取项目ID

graph_id

String

图ID。

表2 Query参数

参数

是否必选

参数类型

描述

action_id

String

图actionId

枚举值:

  • upgrade

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表4 请求Body参数

参数

是否必选

参数类型

描述

upgradeVersion

String

升级到的版本,必须大于当前图版本。

forceUpgrade

Boolean

是否强制升级。取值为true或false,默认为false。

  • true:强制升级,会中断升级时已经在处理的任务,比如运行算法长任务,可能会造成少量请求失败。
  • false:非强制升级,会等待已经运行的业务,升级过程可能较慢。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

errorMessage

String

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

errorCode

String

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

jobId

String

执行该异步任务的jobId。

说明:

可以查询jobId查看任务执行状态、获取返回结果,详情参考Job管理API

请求示例

POST http://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=upgrade

{
  "upgradeVersion" : "1.1.8",
  "forceUpgrade" : false
}

响应示例

状态码: 200

OK

{
  "jobId" : "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
}

状态码: 400

Bad Request

{
  "errorMessage" : "graph [demo] is not found",
  "errorCode" : "GES.8011"
}

状态码

状态码

描述

200

OK

400

Bad Request