tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpgradeDBInstanceMajorVersion

Last updated: 2024-06-17 14:26:13

1. API Description

Domain name for API request: postgres.tencentcloudapi.com.

This API is used to upgrade the major kernel version of an instance, for example, from PostgreSQL 12 to PostgreSQL 15.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: UpgradeDBInstanceMajorVersion.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
DBInstanceId Yes String Instance ID.
TargetDBKernelVersion Yes String Target kernel version number, where upgradeable target kernel version numbers can be acquired through API DescribeDBVersions.
UpgradeCheck No Boolean Whether it is verification mode: if UpgradeCheck is True, it means only kernel version compatibility check will be conducted, without actual upgrade operations, and there will be no affect on the original instance. The check results can be viewed through the upgrade logs.
BackupBeforeUpgrade No Boolean Pre-upgrade backup option: True means a full backup is required before upgrade, and False means a full backup is not required before upgrade. If there is an existing backup set that can restore the instance to its pre-upgrade state, False can be selected; otherwise, True should be specified. This parameter is invalid when UpgradeCheck is True.
StatisticsRefreshOption No Integer Statistics collection option, which is used to run ANALYZE on the primary instance to update system statistics after the upgrade. Valid values include:
0: No statistics collection required;
1: Collect statistics before instance recovery write;
3: Collect statistics after instance recovery write.
This parameter is invalid when UpgradeCheck is True.
ExtensionUpgradeOption No Integer Plugin upgrade option. pg_upgrade does not upgrade any plugins, and "ALTER EXTENSION UPDATE" needs to be executed on the database where the plugins were created after the upgrade. When initiating a major version upgrade of an instance, you can specify whether the upgrade task automatically upgrades the plugin version before/after the instance recovery write. Valid values include:
0: No automatic plugin upgrade required;
1: Upgrade plugins before recovery write;
2: Upgrade plugins after recovery write.
This parameter is invalid when UpgradeCheck is True.
UpgradeTimeOption No Integer Upgrade time option. During the upgrade process, there will be a period when the instance is read-only, and there will be a second-level flash disconnection. When initiating an upgrade, you need to choose the time window for this impact. Valid values include:
0: Execute automatically, no specific time window required;
1: Specify the time window for this upgrade task, which is set via UpgradeTimeBegin and UpgradeTimeEnd parameters;
2: Execute during the instance operation and maintenance time window.
This parameter is invalid when UpgradeCheck is True.
UpgradeTimeBegin No String Upgrade window start time, and the time format is HH:MM:SS, for example: 01:00:00. This parameter is valid when UpgradeTimeOption is set to 1.
This parameter is invalid when UpgradeCheck is True.
UpgradeTimeEnd No String Upgrade window end time, and the time format is HH:MM:SS, for example: 2:00:00 AM. This parameter is valid when UpgradeTimeOption is set to 1.
This parameter is invalid when UpgradeCheck is True.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Upgrading the Kernel Major Version of an Instance

The current major version number of the instance is 10. If you need to use features related to PostgreSQL 15, you can upgrade the kernel version of the instance from 10 to 15 through the major version upgrade feature, and perform the upgrade within a specified time window.

Input Example

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDBInstanceMajorVersion
<Common request parameters>

{
    "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"
}

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.FailedOperationError Operation failed. Please try again later.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
OperationDenied.CamDeniedError This operation cannot be performed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy