Help Center/ ModelArts/ API Reference/ DevServer Management/ Obtaining the Hyper Cluster Details List

Updated on 2025-11-19 GMT+08:00

View PDF

Obtaining the Hyper Cluster Details List

Function

This API is used to obtain the hyper cluster details list.

Constraints

No constraints.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v1/{project_id}/dev-servers/hyper-clusters

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: User project ID. Constraints: Mandatory. Range: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Definition: Hyper cluster type. Constraints: Optional. Range HPS: Default value, which is used to query the hyper cluster of the HPS model. ECS: Query the hyper cluster of the ECS model. Default Value: HPS

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
hyper_clusters	Array of HyperCluster objects	Definition: Hyper cluster list.

**Table 4** HyperCluster
Parameter	Type	Description
id	String	Definition: ID of the hyper cluster. Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
name	String	Definition: Name of the hyper cluster. Range: ^[-_.a-zA-Z0-9]{1,64}$
network_info	Array of network_info objects	Network information.

**Table 5** network_info
Parameter	Type	Description
hyper_cluster_subnet_id	String	Definition: Subnet name of the hyper cluster. Range: ^[-_.a-zA-Z0-9]{1,64}$
is_default	Boolean	Definition: Indicates whether the network is default. Constraints: N/A Range true: default network false: non-default network

Example Requests

GET https://{endpoint}/v1/{project_id}/dev-servers/hyper-clusters

Example Responses

Status code: 200

{
  "hyper_clusters" : [ {
    "id" : "e05f463f-b8d0-4377-bb48-a72c67432590",
    "name" : "kat3ned-8-752t.80xlarge.8.matrix-6e35",
    "network_info" : [ {
      "hyper_cluster_subnet_id" : "a7f3607c-4d7d-4bd0-b922-5a8f1e3a4f48",
      "is_default" : true
    } ]
  }, {
    "id" : "c9292bec-40eb-4cac-94ea-d7ce0b7941a5",
    "name" : "test-kat3ne-8.48xlarge.8.800t.matrix",
    "network_info" : [ {
      "hyper_cluster_subnet_id" : "730a875a-2f98-4d4f-b93e-11ae072173d7",
      "is_default" : true
    } ]
  } ]
}