Obtaining the Partition List

Updated on 2024-03-22 GMT+08:00

View PDF

Function

This API is used to obtain the partition list.

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/partitions

**Table 1** Path Parameters
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.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
kind	String	Resource type
apiVersion	String	API version
items	Array of Partition objects	Cluster partition information

**Table 3** Partition
Parameter	Type	Description
kind	String	Resource type
apiVersion	String	API version
metadata	metadata object	Metadata of partitions
spec	spec object	Partition configurations

**Table 4** metadata
Parameter	Type	Description
name	String	Partition name
creationTimestamp	String	Creation time

**Table 5** spec
Parameter	Type	Description
hostNetwork	hostNetwork object	Partition subnet
containerNetwork	Array of containerNetwork objects	Container subnet in the partition
publicBorderGroup	String	Group
category	String	Category

**Table 6** hostNetwork
Parameter	Type	Description
subnetID	String	Subnet ID

**Table 7** containerNetwork
Parameter	Type	Description
subnetID	String	Subnet ID

Example Requests

None

Example Responses

Status code: 200

{
  "kind" : "List",
  "apiVersion" : "v3",
  "items" : [ {
    "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"
    }
  } ]
}