Upgrading the Kernel Version of a DB Instance
Function
This API is used to upgrade kernel version of a DB instance. There are three upgrade types: in-place upgrade, gray upgrade, and hot patch update.
- In-place upgrade
Services are interrupted for about 30 minutes during the in-place upgrade. All nodes in a DB instance are upgraded at a time and you need to stop all services during the upgrade.
- Gray upgrade
Services are interrupted for 10s during the upgrade of each primary DN or CN. The management plane is upgraded first, and then the data plane from the standby nodes to the primary nodes. You can select auto-commit after the upgrade or perform a rolling upgrade.
- Auto-commit: All nodes are upgraded at the same time. Services are interrupted for about 10s during the upgrade.
- Rolling upgrade: You can observe service status before committing the upgrade. There are upgrade and commit phases.
- In the upgrade phase, DB instances can be upgraded by shard or AZ based on the deployment model.
- Distributed instances are upgraded by shard.
- Centralized instances are upgraded by AZ.
- In the commit phase, you can test services on your instance after the upgrade is complete, and then either commit or roll back the upgrade based on test results.
- Commit: After the upgrade is complete and services are normal, commit the upgrade.
- Rollback: When the upgrade is complete and enters the commit phase, you can roll back the instance to the source version as required.
- In the upgrade phase, DB instances can be upgraded by shard or AZ based on the deployment model.
- Hot patch update
- Auto-commit: Hot patches are automatically updated and committed without downtime.
- Rollback: Services are not interrupted when the hot patches are rolled back.
- Learn how to authenticate this API.
- Obtain the required region and endpoint.
URI
PUT /v3.1/{project_id}/instances/{instance_id}/db-upgrade
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A |
instance_id |
Yes |
String |
Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
upgrade_type |
Yes |
String |
Definition Instance upgrade type. The value is case-sensitive. Constraints N/A Range
Default Value N/A |
upgrade_action |
No |
String |
Definition Instance upgrade action. The value is case-sensitive. For the in-place upgrade, this parameter is optional. For the gray upgrade, this parameter can be set to upgradeAutoCommit, upgrade, commit, or rollback. For the hot patch update, this parameter can be set to upgradeAutoCommit or rollback. Constraints N/A Range
Default Value N/A |
target_version |
No |
String |
Definition Target version that the instance will be upgraded to. Constraints
Range N/A Default Value N/A |
upgrade_shard_num |
No |
Integer |
Definition Number of shards to be upgraded in a gray upgrade for a distributed instance. This parameter is mandatory when upgrade action is set to upgrade (rolling upgrade). The value cannot be greater than the number of shards that have not been upgraded. Constraints N/A Range N/A Default Value N/A |
upgrade_az |
No |
String |
Definition AZ to be upgraded in a gray upgrade. This parameter is mandatory when upgrade action is set to upgrade (rolling upgrade). Multiple AZs can be upgraded at the same time. Use commas (,) to separate AZs. You cannot enter an AZ that does not belong to the instance. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Definition Job ID. For pay-per-use instances, only the task ID is returned. Range N/A |
order_id |
String |
Definition Order ID. This parameter is returned only when your instance is billed at a yearly/monthly basis. Range N/A |
Example Request
- In-place upgrade
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "inplace", "target_version": "xxx" }
- Hot patch update
- Updating hot patches
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "hotfix", "target_version" : "xxxx,xxxx,xxxx", "upgrade_action" : "upgradeAutoCommit" }
- Rolling back hot patches
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type": "hotfix", "target_version": "xxxx,xxxx,xxxx", "upgrade_action": "rollback" }
- Updating hot patches
- Gray upgrade
- Setting upgrade_action to upgradeAutoCommit
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "upgradeAutoCommit" }
- Setting upgrade_action to upgrade
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "upgrade", "upgrade_shard_num" : 1, }
- Rolling back the upgrade when the instance is in the rolling upgrade phase (All upgraded shards will be rolled back. After the instance becomes available, the rollback is successful.)
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "rollback" }
- Committing the upgrade when the instance is in the rolling upgrade phase (After all upgraded shards are upgraded, you can commit the upgrade.) (After the instance is available, the upgrade is complete.)
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "commit" }
- Setting upgrade_action to upgradeAutoCommit
- Upgrading a centralized instance in the gray method (upgrade action is rolling upgrade)
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "upgrade_action" : "upgrade", "target_version": "xxx", "upgrade_az" : "az1,az2" }
Example Response
{ "job_id" : "2b414788a6004883a02390e2eb0ea227" }
Status Codes
- Normal
- Abnormal
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot