instances

URI

<managerRoot_uri>/instances[.<format>]

Supported methods

GET, HEAD

Parent resource

managerRoot

Child resources

instance, authorize

Introduction

The service instance list. Information of all service instances and configuration can be acquired through the instances service.

Supported Methods:

GET: Gets all current service instances and the corresponding configuration information.
HEAD: Checks whether the instances resource exists or whether it has permission to access the resource.

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

Resource hierarchy

HTTP request methods

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

http://supermapiserver:8090/iserver/manager/instances.rjson

GET request

Gets all current service instances and the corresponding configuration information.

Response structure

A provider list will be returned by implementing the GET request on the instances resource. The representation structure of a single component will be as follows:

Field	Type	Description
authorizeSetting	AuthorizeSetting	The authorization setting.
componentName	String	Name of the consumed service component.
componentSetName	String	Name of the consumed service component set.
componentType	String	Name of the consumed service component.
enabled	boolean	Whether the current service instance is usable. The default is true, indicating usable.
id	String	ID of the service instance.
interfaceName	String	Name of the consumed service interface.
interfaceType	String	Type of the consumed service interface.
name	String	Name of the current service instance.
Status	String	The service status information, the value can be INITIALIZING, OK or FAILED, indicating service is being initialized, service has been started successfully, or service failed to start respectively. While the value of enabled is false, the value of state is DISABLED.

Response example

The returned representation after implementing the GET request on sample instances resource http://localhost:8090/iserver/manager/instances.rjson is as follows:

[ { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": null, "componentSetName": "components-handler", "componentType": "componentSet", "enabled": true, "id": null, "interfaceName": "handler", "interfaceType": "com.supermap.services.handler.HandlerServlet", "name": "components-handler/handler", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [ "usercommon" ], "permittedRoles": [], "type": "AUTHENTICATED" }, "componentName": null, "componentSetName": "components-rest", "componentType": "componentSet", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "components-rest/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [ "usercommon" ], "permittedRoles": [], "type": "AUTHENTICATED" }, "componentName": "data-ChinaProvinces", "componentSetName": null, "componentType": "com.supermap.services.components.impl.DataImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "data-ChinaProvinces/rest", "status": "FAILED" }, { "authorizeSetting": { "deniedRoles": [ "usercommon" ], "permittedRoles": [ "USER" ], "type": "AUTHENTICATED" }, "componentName": "data-changchun", "componentSetName": null, "componentType": "com.supermap.services.components.impl.DataImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "data-changchun/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "data-jingjin", "componentSetName": null, "componentType": "com.supermap.services.components.impl.DataImpl", "enabled": true, "id": null, "interfaceName": "wcs111", "interfaceType": "com.supermap.services.wcs.WCSServlet", "name": "data-jingjin/wcs111", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "data-jingjin", "componentSetName": null, "componentType": "com.supermap.services.components.impl.DataImpl", "enabled": true, "id": null, "interfaceName": "wcs112", "interfaceType": "com.supermap.services.wcs.WCSServlet", "name": "data-jingjin/wcs112", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "data-3D", "componentSetName": null, "componentType": "com.supermap.services.components.impl.DataImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "data-3D/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "data-rest-jingjin", "componentSetName": null, "componentType": "com.supermap.services.components.impl.DataImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "data-rest-jingjin/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "data-rest-jingjin", "componentSetName": null, "componentType": "com.supermap.services.components.impl.DataImpl", "enabled": true, "id": null, "interfaceName": "wfs100", "interfaceType": "com.supermap.services.wfs.WFSServlet", "name": "data-rest-jingjin/wfs100", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "data-world", "componentSetName": null, "componentType": "com.supermap.services.components.impl.DataImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "data-world/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "data-world", "componentSetName": null, "componentType": "com.supermap.services.components.impl.DataImpl", "enabled": true, "id": null, "interfaceName": "wfs100", "interfaceType": "com.supermap.services.wfs.WFSServlet", "name": "data-world/wfs100", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "facilityAnalyst3D-Pipe3D", "componentSetName": null, "componentType": "com.supermap.services.components.impl.FacilityAnalyst3DImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "facilityAnalyst3D-Pipe3D/rest", "status": "FAILED" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-ChinaProvinces", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "map-ChinaProvinces/rest", "status": "FAILED" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-changchun", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "map-changchun/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-china400", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "map-china400/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-china400", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "wms111", "interfaceType": "com.supermap.services.wms.WMSServlet", "name": "map-china400/wms111", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-china400", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "wms130", "interfaceType": "com.supermap.services.wms.WMSServlet", "name": "map-china400/wms130", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-china400", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "wmts-china", "interfaceType": "com.supermap.services.wmts.WMTSServlet", "name": "map-china400/wmts-china", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-jingjin", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "map-jingjin/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-temperature", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "map-temperature/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-world", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "map-world/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-world", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "wms130", "interfaceType": "com.supermap.services.wms.WMSServlet", "name": "map-world/wms130", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-world", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "wmts-china", "interfaceType": "com.supermap.services.wmts.WMTSServlet", "name": "map-world/wmts-china", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "map-world", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "wmts100", "interfaceType": "com.supermap.services.wmts.WMTSServlet", "name": "map-world/wmts100", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "maps", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "wms111", "interfaceType": "com.supermap.services.wms.WMSServlet", "name": "maps/wms111", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "maps", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "wms130", "interfaceType": "com.supermap.services.wms.WMSServlet", "name": "maps/wms130", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "maps", "componentSetName": null, "componentType": "com.supermap.services.components.impl.MapImpl", "enabled": true, "id": null, "interfaceName": "wmts100", "interfaceType": "com.supermap.services.wmts.WMTSServlet", "name": "maps/wmts100", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "3D-ChinaProvinces", "componentSetName": null, "componentType": "com.supermap.services.components.impl.RealspaceImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "3D-ChinaProvinces/rest", "status": "FAILED" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "3D-Pipe3D", "componentSetName": null, "componentType": "com.supermap.services.components.impl.RealspaceImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "3D-Pipe3D/rest", "status": "FAILED" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "3D-sample", "componentSetName": null, "componentType": "com.supermap.services.components.impl.RealspaceImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "3D-sample/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "spatialanalyst-changchun", "componentSetName": null, "componentType": "com.supermap.services.components.impl.SpatialAnalystImpl", "enabled": true, "id": null, "interfaceName": "restjsr", "interfaceType": "com.supermap.services.rest.JaxrsServletForJersey", "name": "spatialanalyst-changchun/restjsr", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "spatialanalyst-changchun", "componentSetName": null, "componentType": "com.supermap.services.components.impl.SpatialAnalystImpl", "enabled": true, "id": null, "interfaceName": "wps100", "interfaceType": "com.supermap.services.wps.WPSServlet", "name": "spatialanalyst-changchun/wps100", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "spatialanalyst-sample", "componentSetName": null, "componentType": "com.supermap.services.components.impl.SpatialAnalystImpl", "enabled": true, "id": null, "interfaceName": "restjsr", "interfaceType": "com.supermap.services.rest.JaxrsServletForJersey", "name": "spatialanalyst-sample/restjsr", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "traffictransferanalyst-sample", "componentSetName": null, "componentType": "com.supermap.services.components.impl.TrafficTransferAnalystImpl", "enabled": true, "id": null, "interfaceName": "restjsr", "interfaceType": "com.supermap.services.rest.JaxrsServletForJersey", "name": "traffictransferanalyst-sample/restjsr", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "traffictransferanalyst-sample", "componentSetName": null, "componentType": "com.supermap.services.components.impl.TrafficTransferAnalystImpl", "enabled": true, "id": null, "interfaceName": "wps100", "interfaceType": "com.supermap.services.wps.WPSServlet", "name": "traffictransferanalyst-sample/wps100", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "transportationanalyst-sample", "componentSetName": null, "componentType": "com.supermap.services.components.impl.TransportationAnalystImpl", "enabled": true, "id": null, "interfaceName": "rest", "interfaceType": "com.supermap.services.rest.RestServlet", "name": "transportationanalyst-sample/rest", "status": "OK" }, { "authorizeSetting": { "deniedRoles": [], "permittedRoles": [], "type": "PUBLIC" }, "componentName": "transportationanalyst-sample", "componentSetName": null, "componentType": "com.supermap.services.components.impl.TransportationAnalystImpl", "enabled": true, "id": null, "interfaceName": "wps100", "interfaceType": "com.supermap.services.wps.WPSServlet", "name": "transportationanalyst-sample/wps100", "status": "OK" } ]

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 instances resource exists, or if the instance resources can be accessed by clients. It can also determine if the instances resource supports an output format <format> if performed on a URI with .<format> included.