Help Center/ ModelArts/ API Reference/ DevServer Management/ Changing the OS Image of the DevServer Server

Updated on 2025-08-20 GMT+08:00

View PDF

Changing the OS Image of the DevServer Server

Function

This API is used to change the OS image of the DevServer server.

Debugging

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

URI

POST /v1/{project_id}/dev-servers/{id}/changeos

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Definition: DevServer instance 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 Constraints: For details, see Obtaining a Project ID and Name. Range: N/A Default Value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
admin_pass	No	String	Definition: Password used for logging in to the server. Note that either admin_pass or key_pair_name must be specified for ECSs and BMSs and supernodes support only key_pair_name. Constraints: The password must: Contain 8 to 26 characters. Contain at least three of the following types: uppercase letters, lowercase letters, digits, and special characters (!@%-_=+[{}]:,./?). Cannot be the username or the username spelled backwards. Cannot contain root, administrator, or their reverse. Range: N/A Default value: N/A
key_pair_name	No	String	Name of the key pair for logging in to the server. Note that either admin_pass or key_pair_name must be specified. This parameter is supported only when ECSs or BMSs are reset or their OSs are changed. Supernodes do not support this parameter.
image_id	No	String	Definition: Image ID. This parameter is mandatory when the OS is changed. Constraints: N/A Range: N/A Default value: N/A
user_data	No	String	Definition: Data defined by users during server creation. Constraints: N/A Range: N/A Default value: N/A

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
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.
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: DevServer server type. Range: BMS: BMS ECS: ECS 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** 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 9** ServerHpsInfo
Parameter	Type	Description
id	String	Definition: ID of the DevServer supernode instance. 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 DevServer supernode. Range: ^[-_.a-zA-Z0-9]{1,64}$

Status code: 400

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

**Table 11** 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 12** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Link trace ID.

**Table 13** 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 14** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Link trace ID.

**Table 15** 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 16** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Link trace ID.

**Table 17** 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

POST https://{endpoint}/v1/{project_id}/dev-servers/{id}/changeos

{
  "admin_pass" : "@Admin_pass",
  "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7"
}

Example Responses

Status code: 200

{
  "charging_mode" : "PRE_PAID",
  "cloud_server" : {
    "id" : "2c5261a0-b55b-4677-9c92-6927dd3e000d",
    "type" : "ECS"
  },
  "create_at" : 1699348284990,
  "flavor" : "Si2.large.4",
  "id" : "62383738-e52a-450a-9f84-f9e705402be8",
  "image" : {
    "arch" : "X86",
    "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7",
    "name" : "Ubuntu18.04_x86_64_CPU",
    "server_type" : "ECS"
  },
  "name" : "devserver-name",
  "status" : "CHANGINGOS",
  "update_at" : 1699348285077
}