SuperMap iManager
简体中文10.1.1

API

node

URI

http://<server>:<port>/imanager/cloud/web/nodes/{id}[.<format>]

Supported Methods

GET

Introduction

Gets specified GIS environment details.

Supported methods:

  • GET: Gets specified GIS environment details.

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. 1 is the ID of the GIS environment.

http://supermapimanager:8390/imanager/cloud/web/nodes/1.json

GET Request

Gets details of the GIS environment.

Request Parameters

Name Type Definition
id String [Required] GIS environment id.

Response Structure

The detailed information of the GIS server is composed of the following fields:

Field Type Description
availabelTime long Available time for the environment
clusterSource ClusterSource Cluster source, where ClusterSource has two values: CREATED indicates it is created by the system, BUILDED indicates the cluster
cpu int CPU kernel number occupied by the virtual machine
createTime long Creation time
description String Description
disk int Disk size (GB) occupied by the virtual machine
hireDays int The number of days for the rent. The default value is 0, indicating unlimited.
hostName String Host of the environment
id int ID of the environment
ip String IP of the environment
memory int Memory size occupied by the virtual machine (GB)
nodeCount int Number of environments or cluster nodes
nodeName String Node name. If not specified, the default value is the name of the VM. such as: sm_iserver-123
nodeSource NodeSource Environment source, where NodeSource has two values: CREATED indicates it is created by the system, and IMPORTED indicates it is imported from the exernal
nodeSpec String Node specification, corresponding to template specification name
nodeStatus NodeStatus Environment status, including CREATING (being created), STARTING (being started), STOPPING (being stopped), REBOOTING (being restarted), RUNNING (running), DELETING (being deleted), STOPPED (Stopped), PAUSED (paused), CREATE_FAILED (failed to create), NOT_FOUND (not present), UNKNOWN (unknown), MOVING (moving), RESIZING (under adjustment), RESIZED (being resized)
operatingSystem OperatingSystem Environment operating system types, including Windows, LINUX, UNKNOWN
parentId int Parent Node ID. For Cluster worker nodes
password String Environment password
productInfos List Information of the application deployed in the environment
productPath String Location of the application deployed in the environment
resourceType String Resource type, corresponding to the template type name
thresholdEntity ThresholdEntity Environment threshold configuration information
updateTime long Update time
userName String Users of the environment
uuid String Environment uuid, unique identification of the corresponding virtual platform

Where ProductInfo represents the details of the application deployed in the environment, which is composed of the following fields:

Field Type Description
id int Application id
nodeId int ID of the environment
name String Application name
address String Application address
productStatus ProductStatus Application status, including CREATING (being created), STARTING (being started), STOPPING (being stopped), REBOOTING (being restarted), RUNNING (running), DELETING (being deleted), STOPPED (Stopped), CREATE_FAILED (failed to create), NOT_FOUND (not present), UNKNOWN (unknown), DEPLOYING (environment in configuration)

Where ThresholdEntity represents the details of the threshold entity, which is composed of the following fields:

Field Type Description
id int Threshold value id
maxCreateCount int Maximum number of added nodes
maxUsage float Maximum threshold
minUsage float Minimum threshold
metricType MetricType Performance monitoring type, including CPU, RAM, NETWORK (network I/O), INSTANCE
thresholdStatus ThresholdStatus Dynamic scaling state, including ENABLED (dynamic scaling on), DISABLED (dynamic scaling off), CONFLICT (dynamic scaling conflicts)

Response Example

If the user already has a GIS server environment, you can obtain a specific ID by performing a GET request on the server resource, such as the ID 545. Afterwards, you can get the specific information of the GIS environment directly from the node resource.

http://supermapimanager:8390/imanager/cloud/web/nodes/545.json

The returned json format response is as follows:

{
  "availabelTime": 0,
  "clusterSource": "CREATED",
  "cpu": 4,
  "createTime": 1481680185354,
  "description": "",
  "disk": 30,
  "hireDays": 0,
  "hostName": "iserver-77",
  "id": 545,
  "ip": "192.168.22.77",
  "memory": 4,
  "nodeCount": 1,
  "nodeName": "iserver",
  "nodeSource": "CREATED",
  "nodeSpec": "MEDIUM",
  "nodeStatus": "CREATING",
  "operatingSystem": "LINUX",
  "parentId": -1,
  "password": "qeYasKBs",
  "productInfos": [
    {
      "address": "http://192.168.22.77:8090/iserver",
      "id": 581,
      "name": "iServer",
      "nodeId": 545,
      "productStatus": "CREATING",
      "webApp": true
    }
  ],
  "productPath": "/etc/icloud/SuperMapiServer",
  "resourceType": "SERVER",
  "thresholdEntity": {
    "id": 708,
    "maxCreateCount": 0,
    "maxUsage": 80,
    "metricType": "CPU",
    "minUsage": 20,
    "thresholdStatus": "DISABLED"
  },
  "thresholdId": 708,
  "updateTime": 1481680185354,
  "userName": "admin",
  "uuid": "VirtualMachine:vm-1542"
}