managerRoot

URI

http://<server>:<port>/{iserver}/manager[.<format>]

Used to manage the service root resources, all the managed items will be listed. The {iserver} value is iserver or iportal，that is, the URI address in iPortal management services is iportal.

iServer supports all the management service resources; the management service resources supported by iPortal include: securityManager , logs , logsOperation, logsHar resources and its sub-resources.

 All the resources under portalManager directory are the portal management resources, only supported by iPortal.

Supported methods

GET, HEAD

Child resources

workspaces, tileService, tileStorages, tileVersions, fileManager, serverStatus , securityManager , instances , logs , logsOperation, logsHar , clusterOverview , clusterConfig , clusterMembers , clusterReporterConfig, dataflow, streaming

Introduction

The managerRoot resource is the root node for SuperMap iServer to manage services and it is also the entrance to access management service REST API. Users can get the child resource information through the GET request on the managerRoot resource. These child resources can be used to manage current GIS services. Items that can be managed include service component sets, service provider sets, service components, service providers, service interfaces, service instances.

For managed resources, authentication information needs to be carried while accessing resource in the REST method. For example, Cookie information generated while logging in HTTP Form-based Authentication can be carried in the HTTP request head, or you can Access Protected REST Service Resources based on Token. Cookie information can be acquired whiling logging and Token can acquired through the token resource.

Supported Methods:

• GET: Gets the representation of the managerRoot resource, hat is, the entrance to all manageable items of the current GIS service.
• HEAD: Checks whether the managerRoot resource exists or whether there are permission to access the providers resource.

Supported output formats: rjson, json, html, xml.

Resource hierarchy

HTTP request methods

Implement the HTTP request on the following URI, where localhost is the server name, with rjson being the output format.

http://localhost:8090/iserver/manager.rjson

GET request

Gets the representation of the managerRoot resource, hat is, the entrance to all manageable items of the current GIS service.

Response structure

Suppose we implement the GET request on the managerRoot resource to get resource information list in the current application, information list of service component (set), service interface, service provider (set), etc. for example. The returned representation of a single resource is as follows:  

Response example

The rjson format response result after implementing the GET request on the managerRoot resource (http://localhost:8090/iserver/manager/instances/restart.rjson) is as follows:

[ { "name": "backup", "path": "http://localhost:8090/iserver/manager/backup", "resourceConfigID": "backup", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "clientInfo", "path": "http://localhost:8090/iserver/manager/clientInfo", "resourceConfigID": "clientInfo", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "cluster", "path": "http://localhost:8090/iserver/manager/cluster", "resourceConfigID": "clusterConfig", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "clusterFilters", "path": "http://localhost:8090/iserver/manager/clusterFilters", "resourceConfigID": "clusterFilters", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "clusterMembers", "path": "http://localhost:8090/iserver/manager/clusterMembers", "resourceConfigID": "clusterMembers", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "clusterReporter", "path": "http://localhost:8090/iserver/manager/clusterReporter", "resourceConfigID": "clusterReporterConfig", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "clusterService", "path": "http://localhost:8090/iserver/manager/clusterService", "resourceConfigID": "clusterService", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "componentSets", "path": "http://localhost:8090/iserver/manager/componentSets", "resourceConfigID": "componentSets", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "components", "path": "http://localhost:8090/iserver/manager/components", "resourceConfigID": "components", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "datasetsInfo", "path": "http://localhost:8090/iserver/manager/datasetsInfo", "resourceConfigID": "datasetsInfo", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "distributedcache", "path": "http://localhost:8090/iserver/manager/distributedcache", "resourceConfigID": "distributedCache", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "filechooser", "path": "http://localhost:8090/iserver/manager/filechooser", "resourceConfigID": "filechooser", "resourceType": "StaticResource", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "filemanageUploadProgress", "path": "http://localhost:8090/iserver/manager/filemanageUploadProgress", "resourceConfigID": "filemanagerUploadProgress", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "filemanager", "path": "http://localhost:8090/iserver/manager/filemanager", "resourceConfigID": "filemanagerConnector", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "httpCache", "path": "http://localhost:8090/iserver/manager/httpCache", "resourceConfigID": "httpCacheConfig", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "includeJs", "path": "http://localhost:8090/iserver/manager/includeJs", "resourceConfigID": "includeJs", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "instances", "path": "http://localhost:8090/iserver/manager/instances", "resourceConfigID": "instances", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "interfaces", "path": "http://localhost:8090/iserver/manager/interfaces", "resourceConfigID": "interfaces", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "kmlStyles", "path": "http://localhost:8090/iserver/manager/kmlStyles", "resourceConfigID": "kmlStyles", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "license", "path": "http://localhost:8090/iserver/manager/license", "resourceConfigID": "license", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "licenseInfo", "path": "http://localhost:8090/iserver/manager/licenseInfo", "resourceConfigID": "licenseInfo", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "logConfig", "path": "http://localhost:8090/iserver/manager/logConfig", "resourceConfigID": "logConfig", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "login", "path": "http://localhost:8090/iserver/manager/login", "resourceConfigID": "login", "resourceType": "StaticResource", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "logs", "path": "http://localhost:8090/iserver/manager/logs", "resourceConfigID": "logs", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "logsOperation", "path": "http://localhost:8090/iserver/manager/logsOperation", "resourceConfigID": "logsOperation", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "metaInfo", "path": "http://localhost:8090/iserver/manager/metaInfo", "resourceConfigID": "metaInfo", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "passwordSetting", "path": "http://localhost:8090/iserver/manager/passwordSetting", "resourceConfigID": "passwordSetting", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "precache", "path": "http://localhost:8090/iserver/manager/precache", "resourceConfigID": "precache", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "precacheNew", "path": "http://localhost:8090/iserver/manager/precacheNew", "resourceConfigID": "precacheNew", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "precacheScheme", "path": "http://localhost:8090/iserver/manager/precacheScheme", "resourceConfigID": "precacheScheme", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "properties", "path": "http://localhost:8090/iserver/manager/properties", "resourceConfigID": "properties", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "providerSets", "path": "http://localhost:8090/iserver/manager/providerSets", "resourceConfigID": "providerSets", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "providers", "path": "http://localhost:8090/iserver/manager/providers", "resourceConfigID": "providers", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "proxy", "path": "http://localhost:8090/iserver/manager/proxy", "resourceConfigID": "proxy", "resourceType": "StaticResource", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "restore", "path": "http://localhost:8090/iserver/manager/restore", "resourceConfigID": "restore", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "restoredefault", "path": "http://localhost:8090/iserver/manager/restoredefault", "resourceConfigID": "restoredefault", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "scsAndscsets", "path": "http://localhost:8090/iserver/manager/scsAndscsets", "resourceConfigID": "scsAndscsets", "resourceType": "StaticResource", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "security", "path": "http://localhost:8090/iserver/manager/security", "resourceConfigID": "securityManager", "resourceType": "ArithmeticResource", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "serverChart", "path": "http://localhost:8090/iserver/manager/serverChart", "resourceConfigID": "serverChart", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "serviceConfigIndex", "path": "http://localhost:8090/iserver/manager/serviceConfigIndex", "resourceConfigID": "serviceConfigIndex", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "setupAdmin", "path": "http://localhost:8090/iserver/manager/setupAdmin", "resourceConfigID": "setupAdmin", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "spsAndspsets", "path": "http://localhost:8090/iserver/manager/spsAndspsets", "resourceConfigID": "spsAndspsets", "resourceType": "StaticResource", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "validation", "path": "http://localhost:8090/iserver/manager/validation", "resourceConfigID": "validation", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "workspace", "path": "http://localhost:8090/iserver/manager/workspace", "resourceConfigID": "workspace", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] }, { "name": "workspaceTool", "path": "http://localhost:8090/iserver/manager/workspaceTool", "resourceConfigID": "workspaceTool", "resourceType": "CatalogList", "supportedMediaTypes": [ "application/xml", "text/xml", "application/json", "application/rjson", "application/jsonp", "text/html", "application/x-javascript" ] } ]

HEAD request

Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.

HEAD request can be used to check if the managerRoot resource exists, or if the managerRoot resource can be accessed by clients. It can also determine if the managerRoot resource supports an output format <format> if performed on a URI with .<format> included.

See

• workspaces, tileService, tileStorages, tileVersions, fileManager, serverStatus , securityManager , instances , logs , logsOperation, logsHar , clusterOverview , clusterConfig , clusterMembers , clusterReporterConfig
• Constructing REST Requests
• Status Codes
• Output Formats
• Resource Hierarchy