Updated on 2025-12-30 GMT+08:00

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}

Table 1 Path Parameters

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

partition_name

Yes

String

Definition

Partition name

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

kind

String

Definition

API type

Constraints

The value cannot be changed.

Range

N/A

Default Value

Partition

apiVersion

String

Definition

API version

Constraints

The value cannot be changed.

Range

N/A

Default Value

v3

metadata

metadata object

Definition

Partition metadata

Constraints

N/A

spec

spec object

Definition

Partition configurations

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 metadata

Parameter

Type

Description

name

String

Definition

Partition name

Constraints

N/A

Range

N/A

Default Value

N/A

creationTimestamp

String

Definition

Creation time

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 spec

Parameter

Type

Description

hostNetwork

hostNetwork object

Definition

Partition subnet

Constraints

N/A

Range

N/A

Default Value

N/A

containerNetwork

Array of containerNetwork objects

Definition

Container subnet in a partition

Constraints

N/A

Range

N/A

Default Value

N/A

publicBorderGroup

String

Definition

Group. In the CloudPond scenario, the value is the AZ ID. In the central region, the value is center.

Constraints

N/A

Range

N/A

Default Value

N/A

category

String

Definition

AZ type.

Constraints

N/A

Range

  • Default: central AZ

  • IES: dedicated cloud AZ

  • HomeZone: intelligent edge cloud AZ

Default Value

N/A

Table 5 hostNetwork

Parameter

Type

Description

subnetID

String

Definition

Subnet ID

Constraints

N/A

Range

N/A

Default Value

N/A

Table 6 containerNetwork

Parameter

Type

Description

subnetID

String

Definition

Subnet ID

Constraints

N/A

Range

N/A

Default Value

N/A

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.