Help Center/ ModelArts/ API Reference/ DevServer Management/ Querying Hyper Cluster Instance Details

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

Online Debugging

CLI Examples

View PDF

Querying Hyper Cluster Instance Details

Function

This API is used to query details about a hyper cluster instance.

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. Obtain its CLI example hcloud ModelArts ShowHyperCluster.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Description: Hyper cluster ID. Constraints: Mandatory. Range: 1 to 64 characters. Default Value: N/A
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
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 4** 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/{id}

Example Responses

Status code: 200

{
  "id" : "74437437-6810-43b8-ba20-8f8e5bc034da",
  "name" : "test-hps--1107",
  "network_info" : [ {
    "hyper_cluster_subnet_id" : "47be1c96-b00c-4cc9-83cb-089893a632b6",
    "is_default" : true
  } ]
}