Stopping DevServer Instances
Function
This API is used to stop DevServer instances.
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/{id}/stop
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
None
Response Parameters
Status code: 200
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:
|
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:
|
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:
|
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}$. |
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:
|
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}$ |
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:
|
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 |
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:
|
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:
|
uri |
String |
Definition: Private IP address of the instance. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
arch |
String |
Definition: Architecture type of a server image. Range:
|
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:
|
status |
String |
Definition: Server image status. Range:
|
Example Requests
PUT https://{endpoint}/v1/{project_id}/dev-servers/{id}/stop
Example Responses
Status code: 200
OK
{ "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" : "STOPPING", "update_at" : 1699348285077 }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot