查询大版本检查状态或升级状态（PostgreSQL）

功能介绍

查询大版本检查状态或升级状态。

• 调用接口前，您需要了解API 认证鉴权。

接口约束

该接口仅支持PostgreSQL引擎。

URI

• URI格式

  GET /v3/{project_id}/instances/{instance_id}/major-version/status?action={current_action}

• 参数说明

  表1 参数说明

  名称	参数类型	是否必选	说明
  project_id	String	是	租户在某一Region下的项目ID。 获取方法请参见获取项目ID。
  instance_id	String	是	实例ID。
  action	String	是	要查询的状态。 check：查询升级预检查的状态。 upgrade：查询大板本升级的状态。

请求消息

• 请求参数

  无。

• URI样例

  https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/3aa441c4c98a4b36b100a7e3e87d17cein03/major-version/status?action=upgrade

响应消息

• 正常响应要素说明

  表2 参数说明

  名称	参数类型	说明
  status	String	实例大版本升级状态 running：预检查或大版本升级进行中。 success：预检查或大版本升级成功。 failed：预检查或大版本升级失败。
  target_version	String	目标版本。
  start_time	String	开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。
  check_expiration_time	String	检查成功时，报告到期时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。
  detail	String	预检查或升级报告信息。

• 正常响应样例

  { 
       "status": "success", 
       "target_version": "14.4.1", 
       "start_time": "2023-03-06T02:33:49+0800",  
       "check_expiration_time": "2023-03-13T02:33:49+0800",
       "detail": "2023-03-06 18:33:26 --- pg_upgrade check task                                       begin\n2023-03-06 18:34:40 --- pg_upgrade check on master:                            [user_check_report]User check success " 
   }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。