Help Center/ ModelArts/ API Reference/ DevServer Management/ Synchronizing the Status of All DevServer Instances of a User in Real Time

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

View PDF

Synchronizing the Status of All DevServer Instances of a User in Real Time

Function

This API is used to synchronize the status of all DevServer instances of a user in real time.

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

PUT /v1/{project_id}/dev-servers/sync

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: 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
owner	No	String	Definition: User ID of the instance Constraints: Optional Range: This value contains 1 to 64 characters. Lowercase letters, digits, and hyphens (-) are allowed. This parameter is valid only when the account is a big account or has the admin permission. Generally, the value is the ID of the current login user. Default Value: N/A
sort_dir	No	String	Definition: Sorting mode Constraints: Optional Range: ASC: ascending order DESC: descending order Default Value: ASC
sort_key	No	String	Definition: Sorting field Constraints: Optional Range: Separate multiple fields with commas (,). Default Value: createTime
offset	No	Integer	Definition: Start offset of the records on each page Constraints: Optional Range: 0 to 2147483647 Default Value: 0
limit	No	Integer	Definition: Number of records on each page Constraints: Optional Range: 0 to 1024 Default Value: 10

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
current	Integer	Definition: Current page number. Value range: 1 to 2097152
data	Array of ServerResponse objects	Definition: DevServer instance list.
pages	Integer	Definition: Total number of pages. Value range: 1 to 2097152
size	Integer	Definition: Number of records on each page. Maximum number of instances returned on each page. The value of this parameter directly affects the amount of returned data. You can adjust the value to optimize the query performance or increase the information volume of a single request. Range: 1 to 1024
total	Long	Definition: Total number of records. Total number of instances that meet the search criteria. This field is used to learn the overall data scale. Range: 1 to 2147483647

**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.
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}$

Example Requests

PUT https://{endpoint}/v1/{project_id}/dev-servers/sync

Example Responses

Status code: 200

{
  "current" : 0,
  "data" : [ {
    "charging_mode" : "POST_PAID",
    "cloud_server" : {
      "id" : "eb8b4e32-afc9-4f71-8372-1f55f3d7ab28",
      "type" : "ECS"
    },
    "create_at" : 1699352013484,
    "endpoints" : [ {
      "service" : "SSH",
      "uri" : "192.168.0.23"
    } ],
    "flavor" : "Si2.large.4",
    "id" : "c65c4f27-f791-452b-9098-a2726fa2e922",
    "image" : {
      "arch" : "X86",
      "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7",
      "name" : "Ubuntu18.04_x86_64_CPU",
      "server_type" : "ECS"
    },
    "name" : "EI-evs-01",
    "status" : "RUNNING",
    "update_at" : 1699352058465,
    "vpc_id" : "05982b48-a70f-43a1-a2b0-1fe36a236172"
  }, {
    "charging_mode" : "POST_PAID",
    "cloud_server" : {
      "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" : "EI-evs-1107",
    "status" : "CREATING",
    "update_at" : 1699348285077
  } ],
  "pages" : 1,
  "size" : 2,
  "total" : 2
}