云数据库 PostgreSQL
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云数据库 PostgreSQL > API 文档 > 实例相关接口 > 升级实例内核大版本

升级实例内核大版本

最近更新时间：2024-03-12 01:44:08

我的收藏

本页目录：

1. 接口描述

接口请求域名： postgres.tencentcloudapi.com 。

本接口（UpgradeDBInstanceMajorVersion）用于升级实例内核大版本，例如从PostgreSQL 12升级到PostgreSQL 15。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：UpgradeDBInstanceMajorVersion。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
DBInstanceId 是 String 实例ID。
示例值：postgres-klj12ina
TargetDBKernelVersion 是 String 目标内核版本号，可以通过API DescribeDBVersions获取可以升级的目标内核版本号。
UpgradeCheck 否 Boolean 是否为校验模式，若UpgradeCheck为True，表示仅进行内核版本兼容性检查，不会进行实质性的升级操作，对原实例无影响。检查结果可以通过升级日志查看。
BackupBeforeUpgrade 否 Boolean 升级前备份选项。True，表示升级前需要创建全量备份，False，表示升级前不需要创建全量备份。当实例已有备份集可以恢复到升级前的状态时，可选择False，否则需要指定为True。UpgradeCheck为True时，此参数无效。
StatisticsRefreshOption 否 Integer 统计信息收集选项，对主例运行 ANALYZE 以在升级后更新系统统计信息。可选值包括，
0：不需要收集统计信息；
1：实例恢复写之前收集统计信息；
3：实例恢复写之后收集统计信息。
UpgradeCheck为True时，此参数无效。
ExtensionUpgradeOption 否 Integer 插件升级选项，pg_upgrade不会升级任何插件，需要在升级完成后在创建过插件的库上执行"ALTER EXTENSION UPDATE"。发起升级实例大版本时可以指定在实例恢复写前/后是否需要升级任务自动升级插件版本。可选值包括：
0：不需要自动升级插件；
1：恢复写之前升级插件；
2：恢复写之后升级插件。
UpgradeCheck为True时，此参数无效。
UpgradeTimeOption 否 Integer 升级时间选项，升级过程中会有一段时间实例只读，并会有一次秒级闪断，发起升级时需要选择这段影响的时间窗。可选值包括：
0：自动执行，不需要指定时间窗；
1：指定本次升级任务的时间窗，通过参数UpgradeTimeBegin和UpgradeTimeEnd设置；
2：在实例运维时间窗内执行。
UpgradeCheck为True时，此参数无效。
UpgradeTimeBegin 否 String 升级时间窗开始时间，时间格式：HH:MM:SS，例如：01:00:00。当UpgradeTimeOption为1时，该参数有效。
UpgradeCheck为True时，此参数无效。
UpgradeTimeEnd 否 String 升级时间窗截止时间，时间格式：HH:MM:SS，例如：02:00:00。当UpgradeTimeOption为1时，该参数有效。
UpgradeCheck为True时，此参数无效。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 升级实例内核大版本

实例当前大版本号为10，需要使用PostgreSQL 15的相关特性，则可以通过大版本升级功能将实例的内核版本从10升级到15，并在指定时间窗内执行升级。

输入示例

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDBInstanceMajorVersion
<公共请求参数>

{
    "DBInstanceId": "postgres-qwe12k98",
    "TargetDBKernelVersion": "v15.1_r1.6",
    "UpgradeCheck": false,
    "BackupBeforeUpgrade": true,
    "StatisticsRefreshOption": 0,
    "ExtensionUpgradeOption": 0,
    "UpgradeTimeOption": 1,
    "UpgradeTimeBegin": "01:00:00",
    "UpgradeTimeEnd": "02:00:00"
}

输出示例

{
    "Response": {
        "RequestId": "93b86d2d-0d4e-4c83-9322-70f45b039012"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.FailedOperationError 操作失败，请稍后重试。
InvalidParameterValue.InvalidParameterValueError 参数值有误。
OperationDenied.CamDeniedError 当前操作被限制。
ResourceNotFound.InstanceNotFoundError 实例不存在。
中国站