API
stopped
URI
http://<server>:<port>/imanager/cloud/web/nodes/stopped[.<format>]
Supported Methods
POST
Introduction
Stops node resources, where nodes include GIS servers, GIS desktops, GIS portals, general platforms, and load balancers.
Supported methods:
- POST: Stops nodes.
Supported representation format: JSON.
HTTP Request Method
An HTTP request is performed on the following URI. Here we take JSON output format for illustration, where supermapimanager
is the server name.
http://supermapimanager:8390/imanager/cloud/web/nodes/stopped.json
POST Request
Send the request for stopping ndoes. The request body contains the following parameters:
Name | Type | Definition |
---|---|---|
id | String[] | [Required] Environment id. |
Response Structure
Field | Type | Description |
---|---|---|
failures | List |
Failed operations. |
isSucceed | boolean | Whether the operation is successful. |
msg | String | The error information. |
success | List |
Successful operations. |
OperationResult indicates the operations results, which include the following fields:
Field | Type | Description |
---|---|---|
id | String | The id of the entity operated. |
name | String | The name of the entity operated. |
msg | String | The message. |
Response Example
Stops nodes in batch, that is, performing the POST request on http://localhost:8390/imanager/cloud/web/nodes/stopped.json
. The json format request body is as follows:
["18","99"]
The returned json format response is as follows:
{
"failures": [
{
"id": "18",
"msg": "Current environment status cannot be stopped",
"name": "sm_iserver-22"
},
{
"id": "99",
"msg": "No permission or environment does not exist"
}
],
"isSucceed": true,
"msg": "",
"success": []
}