更新时间:2024-04-28 GMT+08:00
分享

升级图(1.0.5)

功能介绍

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

调试

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

URI

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

表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参数

参数

是否必选

参数类型

描述

upgrade_version

String

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

force_upgrade

Boolean

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

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

执行该异步任务的jobId。

说明:

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

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

系统提示信息。

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

error_msg

String

系统提示信息。

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

请求示例

升级图,升级到的版本为1.1.8,不进行强制升级。

POST http://Endpoint/v2/{project_id}/graphs{graph_id}/upgrade

{
  "upgrade_version" : "1.1.8",
  "force_upgrade" : false
}

响应示例

状态码: 200

响应成功示例

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

状态码: 400

响应失败示例

{
  "error_msg" : "graph [demo] is not found",
  "error_code" : "GES.8011"
}

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码

相关文档