# 查询版本升级路径 - QueryingVersionUpgradePaths
#### 功能介绍
查询当前版本到目标版本的所有升级路径。
- 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。
- 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListUpgradePaths)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_189.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                             | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                                | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdb:instance:listUpgradePaths | list | instance    | -   | gaussdb:instance:listUpgradePaths | -     |
     
  
 
#### URI
GET /v3/{project_id}/instances/upgrade-paths
表1参数说明 
| 参数           | 是否必选 | 参数类型      | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| project_id | 是     | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 |
   
表2Query参数 
| **参数**         | **是否必选** | **参数类型** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| source_version | 是         | String    | **参数解释**： 源实例的引擎版本号，如8.210.0。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 |
| target_version | 否         | String  | **参数解释**： 目标实例的引擎版本号，如8.218.0。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。   |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| X-Auth-Token   | 是     | String   | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 |
| X-Language | 否     | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围** **：** - **zh-cn：**中文  - **en-us** **：**英文   **默认取值** **：** **en-us**                 |
   
#### 响应参数
表4响应参数 
| **参数**        | **参数类型**                                                                                             | **描述**                                                                                                |
|:---|:---|:---|
| version_infos | Array of [表5] objects | **参数解释** **：** 版本信息详情。   |
| version_edges | Array of [表6] objects | **参数解释** **：** 支持的升级路径列表。 |
   
 表5VersionInfosResult 
| **参数**          | **参数类型** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|
| version       | String  | **参数解释** **：** 服务引擎版本号，如8.210.0。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                        |
| kernel_version | String   | **参数解释** **：** 内核引擎版本号，如505.2.1。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                    |
| recommend      | Boolean  | **参数解释** **：** 是否为推荐版本。 **取值范围** **：** - true：推荐版本。  - false：非推荐版本。   |
   
 表6UpgradePathsResult 
| **参数**        | **参数类型**  | **描述**                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|
| start_version | String  | **参数解释** **：** 源引擎版本号，如：3.226.0。 **取值范围** **：** 不涉及。    |
| end_version    | String | **参数解释** **：** 目标引擎版本号，如：8.218.0。 **取值范围** **：** 不涉及。 |
   
#### 请求示例
查询版本升级路径。
```
GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/upgrade-paths?source_version=8.218
```
#### 响应示例
```
{ 
  "version_infos" : [ { 
    "version" : "3.226.0", 
    "kernel_version" : "503.1.0.SPC2300", 
    "recommended" : true 
  }, { 
    "version" : "8.218.0", 
    "kernel_version" : "505.2.1.SPC0800", 
    "recommended" : true 
  } ], 
  "version_edges" : [ { 
    "start_version" : "3.226.0", 
    "end_version" : "8.218.0" 
  } ] 
}
```
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。
