Upgrading a Cluster Kernel¶
Function¶
This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.
URI¶
POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/image/upgrade
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. |
cluster_id | Yes | String | ID of the cluster to be upgraded. |
inst_type | Yes | String | Type of the node to be upgraded. Currently, its value can only be all. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
target_image_id | Yes | String | ID of the target image version. |
upgrade_type | Yes | String | Upgrade type.
|
indices_backup_check | Yes | Boolean | Whether to perform backup verification.
|
agency | Yes | String | Agency name. You can create an agency to allow CSS to call other cloud services. |
cluster_load_check | No | Boolean | Indicates whether to verify the load. The default value is true.
|
Response Parameters¶
None
Example Requests¶
Update a cluster version.
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/inst-type/all/image/upgrade
{
"target_image_id" : "{target_image_id}",
"upgrade_type" : "same",
"indices_backup_check" : true,
"agency" : "css-test-agency",
"cluster_load_check" : true
}
Example Responses¶
None
Status Codes¶
Status Code | Description |
|---|---|
200 | Request succeeded. |
400 | Invalid request. The client should not repeat the request without modifications. |
409 | The request cannot be processed due to a conflict. This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict. |
412 | The server did not meet one of the preconditions contained in the request. |
Error Codes¶
See Error Codes.