Updating a Partition
Function
This API is used to update a partition.
URI
PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/partitions/{partition_name}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. |
|
cluster_id |
Yes |
String |
Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. |
|
partition_name |
Yes |
String |
Partition name |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
kind |
No |
String |
Resource type |
|
apiVersion |
No |
String |
API version |
|
metadata |
No |
metadata object |
Metadata of partitions |
|
spec |
No |
spec object |
Partition configurations |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
hostNetwork |
No |
hostNetwork object |
Partition subnet |
|
containerNetwork |
No |
Array of containerNetwork objects |
Container subnet in the partition |
|
publicBorderGroup |
No |
String |
Group |
|
category |
No |
String |
Category |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
kind |
String |
Resource type |
|
apiVersion |
String |
API version |
|
metadata |
metadata object |
Metadata of partitions |
|
spec |
spec object |
Partition configurations |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Partition name |
|
creationTimestamp |
String |
Creation time |
|
Parameter |
Type |
Description |
|---|---|---|
|
hostNetwork |
hostNetwork object |
Partition subnet |
|
containerNetwork |
Array of containerNetwork objects |
Container subnet in the partition |
|
publicBorderGroup |
String |
Group |
|
category |
String |
Category |
Example Requests
PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/partitions/{partition_name}
{
"kind" : "Partition",
"apiVersion" : "v3",
"metadata" : {
"name" : "partitionName"
},
"spec" : {
"hostNetwork" : {
"subnetID" : "subnetID"
},
"containerNetwork" : [ {
"subnetID" : "subnetID"
} ],
"publicBorderGroup" : "publicBorderGroup",
"category" : "category"
}
}
Example Responses
Status code: 200
OK
{
"kind" : "Partition",
"apiVersion" : "v3",
"metadata" : {
"name" : "partitionName",
"creationTimestamp" : "2000-1-1 00:00:35.451967 +0000 UTC"
},
"spec" : {
"hostNetwork" : {
"subnetID" : "subnetID"
},
"containerNetwork" : [ {
"subnetID" : "subnetID"
} ],
"publicBorderGroup" : "publicBorderGroup",
"category" : "category"
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.