Help Center/ ModelArts/ API Reference/ Lite Server Management/ Scaling in Lite Server Supernodes
Updated on 2026-01-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Scaling in Lite Server Supernodes

Function

This API is used to reduce the resource capacity of a Lite Server supernode. It is used when you need to reduce resource usage of Lite Server supernodes to reduce costs or optimize resource allocation. Before using this API, ensure that you have logged in to the system and have the permission to reduce the supernode capacity, and the specified supernode exists and is running. After the scale-in, the resource capacity of the supernode is adjusted based on the specified specifications. You can use the reduced resources immediately. If you do not have the required permission to perform the operation, the specified supernode does not exist, the supernode has reached the minimum capacity, or the specified scale-in specifications are invalid, the API returns an error message.

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

POST /v1/{project_id}/dev-servers/hyperinstance/{id}/live-scale-down

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition: Lite Server supernode ID.

Constraints: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Range: N/A

Default Value: N/A

project_id

Yes

String

Definition: Project ID. For details, see Obtaining a Project ID and Name.

Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed.

Range: N/A

Default Value: N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

id

No

String

Supernode ID.

flavor

No

String

Flavor information.

server_ids

No

Array of strings

ID of the node to be deleted.

resource_flavor

No

String

Resource flavor.

Response Parameters

Status code: 200

Table 3 Response body parameters

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 4 ServerResponse

Parameter

Type

Description

create_at

Long

Definition: Creation time.

Range: N/A

update_at

Long

Definition: Update time.

Range: N/A

charging_mode

String

Definition: Billing mode.

Range:

  • COMMON: both yearly/monthly and pay-per-use

  • 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.

flavor

String

Definition: Instance flavor name.

Range: ^.{1,128}$

id

String

Definition: Instance ID.

Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

key_pair_name

String

Definition: Key pair name.

Range: ^[-_.a-zA-Z0-9]{1,64}$

name

String

Definition: Instance name.

Range: ^[-_.a-zA-Z0-9]{1,64}$

order_id

String

Definition: Order ID.

Range: ^[a-zA-Z0-9]{1,64}$

server_image_response

ServerImageResponse object

Definition: Instance image information.

Range: N/A

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: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

endpoints

Array of EndpointsRes objects

Definition: Private IP address of the server.

volumes

Array of ServerVolume objects

Definition: Information about the mounted hard disk.

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

Parameter description: ID of the subnet where the instance is located.

** Value range: **:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
Table 5 CloudServer

Parameter

Type

Description

id

String

Definition: Server resource ID or supernode's child node ID.

Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

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: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

hps_ecs_id

String

Definition: Server resource ID of the supernode's child node.

Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
Table 6 Endpoints

Parameter

Type

Description

allowed_access_ips

Array of strings

Definition: Whitelisted public IP addresses that are allowed to access notebook instances through SSH. By default, all IP addresses can access the notebook instances. If IP addresses are specified, only the clients with the specified IP addresses can access the notebook instances.

Constraints: N/A

Range: 0 to 1,024 IP addresses

Default Value: N/A

dev_service

String

Definition: Supported services.

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.

Constraints: N/A

Range: N/A

Default Value: N/A

ssh_keys

Array of strings

Definition: List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time.

Constraints: N/A

Range: 0 to 1,024 key pairs

Default Value: N/A
Table 7 EndpointsRes

Parameter

Type

Description

allowed_access_ips

Array of strings

Definition: Whitelisted public IP addresses that are allowed to access notebook instances through SSH. By default, all public IP addresses can access the notebook instances. If IP addresses are specified, only the clients with the specified IP addresses can access the notebook instances.

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.

ssh_keys

Array of strings

Definition: List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time.

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.

uri

String

Definition: Private IP address of the instance.

Range: N/A
Table 8 ServerVolume

Parameter

Type

Description

size

Integer

Definition: EVS disk size, which is the storage space allocated to the system disk.

Constraints: N/A

Range: 100 to 1,024 GB

Default Value: N/A

type

String

Definition: Storage type, which can be a system disk or data disk.

Constraints: N/A

Range

  • ROOT: system disk

  • DATA: data disk

Default Value: N/A

evs_type

String

Definition: EVS disk type. Storage type of the EVS disk.

Constraints: N/A

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

Default Value: N/A

evs_id

String

Definition: ID of the EVS disk.

Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
Table 9 ServerImageResponse

Parameter

Type

Description

arch

String

Definition: Architecture type of a server image.

Range:

  • ARM

  • X86

image_id

String

Definition: Server image ID.

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: Server image name.

Constraints: N/A

Range: 1 to 256 characters

Default Value: N/A

server_type

String

Definition: Server type.

Range:

  • BMS: BMS

  • ECS: ECS

  • HPS: supernode server

status

String

Definition: Server image status.

Range:

  • ACTIVE

  • INACTIVE
Table 10 ServerHpsInfo

Parameter

Type

Description

id

String

Definition: Lite Server supernode instance ID.

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: Lite Server supernode name.

Range: ^[-_.a-zA-Z0-9]{1,64}$

Example Requests

POST https://{endpoint}/v1/{project_id}/dev-servers/hyperinstance/{id}/live-scale-down

{
  "flavor" : "kat3ne-8.48xlarge.8.800t.matrix-kf",
  "server_ids" : [ "9099cc0b-1dcc-46d3-b5b4-8c1c4cf51de8", "7d93ab97-1b52-4b52-8b4d-9d692512ee81", "00e91787-0989-4c99-9321-ea37784ed949" ]
}

Example Responses

Status code: 200

The scale-in order is successful.

{
  "order_id" : "CS12345678912345",
  "servers" : [ ]
}

Status Codes

Status Code

Description

200

The scale-in order is successful.

Error Codes

See Error Codes.

Parent topic: Lite Server Management