Synchronizing the Status of All Lite Server Instances of a User in Real Time

Function

This API is used to obtain and synchronize the status of a Lite Server instance in real time. It is used when you need to monitor the status of a Lite Server instance in real time to ensure that the instance is running properly or detect and handle exceptions in a timely manner. Before using this API, ensure that you have logged in to the system and have the required permission, and the Lite Server instance has been created and is running. After this API is called, the latest status of the Lite Server instance is returned, including the instance ID, status, and resource usage. If you do not have the required permission or the Lite Server instance does not exist, 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, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

modelarts:devserver:sync

Write

devserver *

-

-

-

-

g:EnterpriseProjectId

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
modelarts:devserver:sync	Write	devserver *	-	-	-
-	g:EnterpriseProjectId

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
id	No	String	Definition: Instance ID. Constraints: Optional. Range: The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A
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. Options: createTime: sorting by creation time (default value) updateTime: sorting by update time. 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: Lite Server instance list. Each element in the list is a ServerResponse object, which contains detailed information about the instance.
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, 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 5** 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 6** 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 7** 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 8** 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 9** 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 10** 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 (.).

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
}