Obtaining Details About All Supernode Instances of a User

Function

This API is used to obtain details about all Lite Server supernode instances of a user. It is used when you need to view the configuration, status, and usage of all supernode instances. Before using this API, ensure that you have logged in to the system and have the permission to query supernode instances. After the query, the API returns details about all supernode instances, including the instance ID, OS, status, and resource usage. If you do not have the required permission or the system does not have supernode instances, the API returns an error message.

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.

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/hyperinstance

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID Constraints: For details, see Obtaining a Project ID and Name. Range: N/A Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
sort_dir	No	String	Definition: Sorting mode Constraints: N/A Range: Enums: - ASC: ascending order - DESC: descending order Default Value: N/A
sort_key	No	String	Definition: Sorting field Constraints: N/A Range: Enums: - createTime: sorting by creation time (default value) - updateTime: sorting by update time Default Value: N/A
limit	No	Integer	Definition: Number of records on each page Constraints: N/A Range: [1, 1024] Default Value: 10
offset	No	Integer	Definition: Start offset of the records on each page Constraints: N/A Range: [0, 2147483647] Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Link trace ID.

**Table 4** Response body parameters
Parameter	Type	Description
current	Integer	Definition: Current page number. Constraints: N/A Range: N/A Default Value: N/A
data	Array of ServerHyperinstanceResponse objects	Definition: Lite Server supernode instance list. Constraints: N/A. Range: N/A. Default Value: N/A.
pages	Integer	Definition: Total number of pages. Constraints: N/A Range: N/A Default Value: N/A
size	Integer	Definition: Number of records on each page. Constraints: N/A Range: N/A Default Value: N/A
total	Long	Definition: Total number of records. Constraints: N/A Range: N/A Default Value: N/A

**Table 5** ServerHyperinstanceResponse
Parameter	Type	Description
create_at	Long	Definition: Creation time. Constraints: N/A Range: N/A Default Value: N/A
hps_cluster_id	String	Definition: Network ID of the supernode cluster. Constraints: N/A Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Default Value: N/A
hps_id	String	Definition: Supernode ID. Constraints: N/A Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Default Value: N/A
id	String	Definition: Lite Server supernode ID. Constraints: N/A. Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Default Value: N/A.
name	String	Definition: Instance name. Constraints: N/A Range: ^[-_.a-zA-Z0-9]{1,64}$ Default Value: N/A
order_id	String	Definition: Order ID. Constraints: N/A Range: ^[a-zA-Z0-9]{1,64}$ Default Value: N/A
status	String	Definition: Supernode instance status. Constraints: N/A Range: PROVISIONING: The request for creating a supernode has been accepted, but the supernode is still being created. ACTIVE: The supernode is active and its resources can be used. ERROR: The supernode fails to be created. REIMAGING: The OS of the supernode is being changed. TERMINATING: Resources are being released. TERMINATED: The supernode resources have been released and are no longer available. Default Value: N/A
servers	Array of ServerResponse objects	Definition: List of supernode subnode instances. Constraints: N/A Range: N/A Default Value: N/A
update_at	Long	Definition: Creation time. Constraints: N/A Range: N/A Default Value: N/A

**Table 6** ServerResponse
Parameter	Type	Description
create_at	Long	Definition: Creation time, which is a Unix timestamp in milliseconds. Range: N/A
update_at	Long	Definition: Update time, which is a Unix timestamp in milliseconds. Range: N/A
charging_mode	String	Definition: Billing mode. Range COMMON: Both yearly/monthly and pay-per-use billing modes are supported. POST_PAID: pay-per-use PRE_PAID: yearly/monthly
cloud_server	CloudServer object	Definition: Cloud service information.
endpoints_response	Array of Endpoints objects	Definition: Private IP address of the instance. Each element in the list is an Endpoints object, containing information such as the supported service type and access method.
flavor	String	Definition: Instance flavor name. Range: 1 to 128 characters
id	String	Definition: Instance ID. Range: a UUID in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is a hexadecimal number.
key_pair_name	String	Definition: Key pair name. Range: The value is a string of 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).
name	String	Definition: Instance name. Range: The value is a string of 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).
order_id	String	Definition: Order ID. Range: The value is a string of 1 to 64 characters, including letters and digits.
status	String	Definition: Instance status. Current running status of the instance, which is used to monitor the lifecycle and health status of the instance. Range: CREATE_FAILED: Creating the instance failed. CREATING: The instance is being created. DELETED: The instance has been deleted. DELETE_FAILED: Deleting the instance failed. DELETING: The instance is being deleted. ERROR: An error occurred. RUNNING: The instance is running. STARTING: The instance is being started. START_FAILED: Starting the instance failed. STOPPED: The instance has been stopped. STOPPING: The instance is being stopped. STOP_FAILED: Stopping the instance failed. REBOOTING: The instance is being restarted. REBOOT_FAILED: Restarting the instance failed. CHANGINGOS: The OS is being changed. CHANGINGOS_FAILED: Changing the OS failed. REINSTALLINGOS: The OS is being reinstalled. REINSTALLINGOS_FAILED: Reinstalling the OS failed.
vpc_id	String	Definition: ID of the VPC where the instance is located. Range: a UUID in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is a hexadecimal number.
endpoints	Array of EndpointsRes objects	Definition: Private IP address of the server. Each element in the list is an EndpointsRes object, containing information such as the access method and private IP address.
volumes	Array of ServerVolume objects	Definition: Information about the attached disk. Each element in the list is a ServerVolume object, containing information such as the disk size, type, and EVS disk information.
image	ServerImageResponse object	Definition: Server image information.
category	String	Definition: Server type. Range: HPS: supernode server SPOD: full-cabinet server SERVER: single server
server_hps	ServerHpsInfo object	Definition: Information about the supernode to which the server belongs.
subnet_id	String	Description: ID of the subnet where the instance is located. Range: a UUID in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is a hexadecimal number.

**Table 7** CloudServer
Parameter	Type	Description
id	String	Definition: Server resource ID or supernode's child node ID. Range: a UUID in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is a hexadecimal number.
type	String	Definition: Lite Server server type. Range: BMS: Bare Metal Server ECS: Elastic Cloud Server HPS: Supernode server
hps_id	String	Definition: Server resource ID of the supernode's child node. Range: a UUID in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is a hexadecimal number.
hps_ecs_id	String	Definition: Server resource ID of the supernode's child node. Range: a UUID in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is a hexadecimal number.

**Table 8** Endpoints
Parameter	Type	Description
dev_service	String	Definition: Supported services. The difference between dev_service here and dev_service in EndpointsRes is as follows: dev_service here is used to specify the service type in the request, and dev_service in EndpointsRes is used to identify the access mode in the response. Range NOTEBOOK: You can access notebook instances using HTTPS. SSH: You can remotely access notebook instances through SSH.
extensions	Map<String,String>	Definition: App-specific URL for accessing the remote development mode of the app. It includes extended configurations of the application. key indicates the name of the extended configuration, and value indicates the value of the extended configuration.
ssh_keys	Array of strings	Definition: List of SSH key pair names. A maximum of 1,024 key pairs are supported. You can set multiple key pairs to access an SSH instance at the same time.

**Table 9** EndpointsRes
Parameter	Type	Description
dev_service	String	Definition: Method for accessing the notebook instance. Range: NOTEBOOK: You can access notebook instances using HTTPS. SSH: You can remotely access notebook instances through SSH.
service	String	Definition: Method for accessing the notebook instance. The difference between service and dev_service is that service is used to identify the access mode in the response, while dev_service is used to specify the service type in the request. Range NOTEBOOK: You can access notebook instances using HTTPS. SSH: You can remotely access notebook instances through SSH.
uri	String	Definition: URI for accessing the instance. The format is private IP address. Range: N/A
key_pair_names	Array of strings	Definition: List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time. Range: N/A

**Table 10** ServerVolume
Parameter	Type	Description
size	Integer	Definition: Size of the EVS disk, in GB. It specifies the storage space allocated to the system disk. Range: 100 to 1024
type	String	Definition: Storage type, which can be a system disk or data disk. Range ROOT: System disk DATA: Data disk
evs_type	String	Definition: EVS disk type. Storage type of the EVS disk. Range ESSD: Extreme SSD GPSSD: General-purpose SSD SAS: High I/O EVS disk SATA: Common I/O EVS disk SSD: Ultra-high I/O EVS disk
evs_id	String	Definition: ID of the EVS disk. Range: a UUID in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is a hexadecimal number.

**Table 11** ServerImageResponse
Parameter	Type	Description
arch	String	Definition: Architecture type of a server image. Range ARM: Arm architecture, which is applicable to mobile and embedded scenarios. X86: x86 architecture, which is applicable to general computing scenarios.
image_id	String	Definition: Server image ID. Range: a UUID in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is a hexadecimal number.
name	String	Definition: Server image name. Range: 1 to 256 characters
server_type	String	Definition: Server type. Range: BMS: BMS ECS: ECS HPS: supernode server
status	String	Definition: Server image status. Range ACTIVE: The image is available. INACTIVE: The image is unavailable.

**Table 12** ServerHpsInfo
Parameter	Type	Description
id	String	Definition: Lite Server supernode instance ID. Range: a UUID in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is a hexadecimal number.
name	String	Definition: Lite Server supernode name. Range: The value is a string of 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

Status code: 400

**Table 13** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Link trace ID.

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Status code: 401

**Table 15** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Link trace ID.

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Status code: 403

**Table 17** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Link trace ID.

**Table 18** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Status code: 500

**Table 19** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Link trace ID.

**Table 20** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Example Requests

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

Example Responses

Status code: 200

{
  "current" : 0,
  "data" : [ {
    "create_at" : 1731055875839,
    "hps_cluster_id" : "42669b79-da2f-4482-ad40-22f50442c9e7",
    "hps_id" : "33806b62-1c7b-4781-8d2c-411a042b86b8",
    "id" : "b4beacb6-4380-448c-a218-daa82cf03f5d",
    "name" : "lite server-hps",
    "order_id" : "CS2411081650G9B6Z",
    "servers" : [ {
      "charging_mode" : "PRE_PAID",
      "cloud_server" : {
        "hps_id" : "33806b62-1c7b-4781-8d2c-411a042b86b8",
        "id" : "50208d41-749e-4bce-95a9-47a850925d4e",
        "type" : "HPS"
      },
      "create_at" : 1731055875840,
      "endpoints" : [ {
        "service" : "SSH",
        "uri" : "10.1.0.98"
      } ],
      "flavor" : "kat3ne-8.48xlarge.8.800t.matrix",
      "id" : "278d70a9-2049-450a-bf6d-db02fe9f6634",
      "image" : {
        "image_id" : "86496e41-87c4-4779-9007-4f8f5c2a208f"
      },
      "key_pair_name" : "KeyPair-hps",
      "name" : "lite server-hps-1",
      "order_id" : "CS2411081650G9B6Z",
      "server_hps" : {
        "id" : "b4beacb6-4380-448c-a218-daa82cf03f5d",
        "name" : "lite server-hps"
      },
      "status" : "RUNNING",
      "update_at" : 1731209918651,
      "vpc_id" : "7980ccf4-44d0-42cc-a844-42e035379a38"
    } ],
    "status" : "ACTIVE",
    "update_at" : 1731209918651
  } ],
  "pages" : 1,
  "size" : 10,
  "total" : 1
}