Modifying Cluster Specifications¶
Function¶
This API is used to modify the specifications of a cluster.
Note
The URL for cluster management is in the format of https://Endpoint/uri, in which uri indicates the resource path, that is, the path for API access.
URI¶
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/resize
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A |
cluster_id | Yes | String | Details: Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Cluster IDs Default value: N/A |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
Content-Type | Yes | String | Details: The request body type or format Constraints: The GET method is not verified. Options:
Default value: N/A |
X-Auth-Token | Yes | String | Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines. Constraints: None Options: N/A Default value: N/A |
Parameter | Mandatory | Type | Description |
---|---|---|---|
flavorResize | Yes | String | The target flavor to be changed. You can only adjust the maximum number of worker nodes in a cluster. The number of master nodes is fixed and cannot be altered, and the cluster flavors cannot be downgraded. Suppose the original cluster flavor is cce.s2.medium. In that case, you can only upgrade it to cce.s2.large or higher, but you cannot downgrade it to cce.s2.small or cce.s1.medium.
Note The fields in the parameters are described as follows:
|
extendParam | No | extendParam object | Extended field for changing cluster specifications |
Parameter | Mandatory | Type | Description |
---|---|---|---|
decMasterFlavor | No | String | Specifications of the master node in the dedicated hybrid cluster |
Response Parameters¶
Status code: 201
Parameter | Type | Description |
---|---|---|
jobID | String | Job ID |
Example Requests¶
Modifying the specifications of the pay-per-use cluster
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/resize { "flavorResize" : "cce.s1.medium" }
Example Responses¶
Status code: 201
The job for modifying the specifications of the pay-per-use cluster is delivered.
{
"jobID" : "13b8d958-8fcf-11ed-aef3-0255ac1001bd"
}
Status Codes¶
Status Code | Description |
---|---|
201 | The job for modifying the specifications of the pay-per-use cluster is delivered. |
Error Codes¶
See Error Codes.