功能介绍

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

URI

• URI 格式

  POST  /v1.0/{projectId}/graphs/{graphId}/action?action_id=upgrade

• 参数说明

  表1 URI参数说明

  参数	是否必选	类型	说明
  projectId	是	String	项目编号，用于资源隔离。请参考获取项目ID。
  graphId	是	String	图ID。

请求

• 请求样例

  POST http://Endpoint/v1.0/{projectId}/graphs{graphId}/action?action_id=upgrade
  {
    "upgradeVersion":"1.1.8",
    "forceUpgrade":false
  }

• 参数说明

  表2 Body参数说明

  参数	是否必选	类型	说明
  upgradeVersion	是	String	升级到的版本，必须大于当前图版本。
  forceUpgrade	否	Boolean	是否强制升级。取值为true或false，默认为false。 true：强制升级，会中断升级时已经在处理的任务，比如运行算法长任务，可能会造成少量请求失败。 false：非强制升级，会等待已经运行的业务，升级过程可能较慢。

响应

• 要素说明

  表3 要素说明

  参数	是否必选	类型	说明
  errorMessage	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。
  errorCode	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。
  jobId	否	String	执行该异步任务的jobId。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考Job管理API。

• 请求成功样例

  Http Status Code: 200
  {
    "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
  }

• 请求失败样例

  Http Status Code: 400
  {
    "errorCode": "GES.7001",
    "errorMessage": "The graph is not running."
  }

返回值

• 正常

  200

• 异常

  表4 异常返回值说明

  返回值	说明
  400 Bad Request	请求错误。
  401 Unauthorized	鉴权失败。
  403 Forbidden	没有操作权限。
  404 Not Found	找不到资源。
  500 Internal Server Error	服务内部错误。
  503 Service Unavailable	服务不可用。