Obtaining Partition Details
Function
This API is used to obtain partition details.
URI
GET /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
None
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
None
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.
