Updating a Cluster
Function
This API is used to update a cluster. Currently, only the countries and cities of an attached cluster and an on-premises cluster can be updated.
URI
PUT /v1/clusters/{clusterid}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
clusterid |
Yes |
String |
Cluster ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Identity authentication information |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
kind |
Yes |
String |
API type. The value is fixed at Cluster and cannot be changed. |
apiVersion |
Yes |
String |
API version. The value is fixed at v1 and cannot be changed. |
metadata |
No |
ObjectMeta object |
Basic information about the cluster. Metadata is a collection of attributes. |
spec |
No |
UpdateClusterSpec object |
Details about the cluster. UCS creates or updates the cluster based on spec. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
uid |
No |
String |
Cluster ID |
name |
No |
String |
Cluster name |
labels |
No |
Map<String,String> |
Labels |
creationTimestamp |
No |
String |
Creation time. It is a UTC time in the RFC 3339 format. |
updateTimestamp |
No |
String |
Update timestamp |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
country |
No |
String |
Country where the cluster is located |
city |
No |
String |
City where the cluster is located |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
replicas |
No |
Integer |
The number of nodes |
strategy |
No |
NodeUpgradeStrategy object |
Node update policy |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
- |
String |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
- |
String |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
- |
String |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
- |
String |
Example Request
Updating the country and city of a cluster
PUT https://ucs.myhuaweicloud.com/v1/clusters/{clusterid} { "kind" : "Cluster", "apiVersion" : "v1", "metadata" : { "annotations" : { "kubeconfig" : "{\"kind\":\"Config\",\"apiVersion\":\"v1\",\"preferences\":{},\"clusters\":[{\"name\":\"internalCluster\",\"cluster\":{\"server\":\"https://100.94.13.93:5443\",\"insecure-skip-tls-verify\":true}}],\"users\":[{\"name\":\"user\",\"user\":{\"client-certificate-data\":\"\",\"client-key-data\":\"\"}}],\"contexts\":[{\"name\":\"internal\",\"context\":{\"cluster\":\"internalCluster\",\"user\":\"user\"}}],\"current-context\":\"internal\"}" } }, "spec" : { "country" : "AL", "city" : "AL" } }
Example Response
None
Status Codes
Status Code |
Description |
---|---|
200 |
Information information updated. |
400 |
Client request error. The server could not execute the request. |
403 |
The server refused the request. |
500 |
Internal server error. |
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