Domain name for API request: postgres.tencentcloudapi.com.
This API is used to upgrade the kernel version of an instance.
A maximum of 100 requests can be initiated per second for this API.
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: UpgradeDBInstanceKernelVersion. |
| 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, which can be obtained in the AvailableUpgradeTarget field in the returned value of the DescribeDBVersions API. |
| SwitchTag | No | Integer | Switch time after the kernel version upgrade for the specified instance. Valid values:0: Switch now.1: Switch at the specified time.2: Switch in the maintenance time.Default value: 0. |
| SwitchStartTime | No | String | Switch start time in the format of HH:MM:SS, such as 01:00:00. When SwitchTag is 0 or 2, this parameter is invalid. |
| SwitchEndTime | No | String | Switch end time in the format of HH:MM:SS, such as 01:30:00. When SwitchTag is 0 or 2, this parameter is invalid. The difference between SwitchStartTime and SwitchEndTime cannot be less than 30 minutes. |
| DryRun | No | Boolean | Whether to perform a pre-check on the current operation of upgrading the instance kernel version. Valid values: u200c true: Performs a pre-check without upgrading the kernel version. Check items include request parameters, kernel version compatibility, and instance parameters.u200cu200c false: Sends a normal request and upgrades the kernel version directly after the check is passed.Default value: false. |
| 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. |
u200cu200cThis example shows you how to upgrade the kernel version of an instance.
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDBInstanceKernelVersion
<Common request parameters>
{
"DBInstanceId": "pgro-g7w4itfg",
"TargetDBKernelVersion": "v12.7_r1.5",
"DryRun": "true"
}
{
"Response": {
"RequestId": "2b376d28-d5fd-40b0-9bdc-d992f8fed15d"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.CamSigAndAuthError | Authentication failed. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.DatabaseAccessError | Failed to access database management service. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.DatabaseAffectedError | Data operation failed. Please contact customer service. |
| FailedOperation.FailedOperationError | Operation failed. Please try again later. |
| FailedOperation.PreCheckError | Pre-check failed |
| InvalidParameter.ParameterCheckError | Failed to check the parameter. |
| InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
| OperationDenied.CamDeniedError | This operation cannot be performed. |
| OperationDenied.InstanceStatusLimitOpError | This operation cannot be performed on an instance in this status. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
フィードバック