GIS Cloud Suite

list

URI

http://{server}:{port}/manager/web/api/service/instances/list

Supported Method

GET

Parent Resource

instances

Introduction

Get the service instance list by API.

Supported Interchange Format: JSON

HTTP Request Method

Execute HTTP request to the URI below. In the URI below, {server} is the server of gateway, replace it by the actual gateway IP. {port} is the port of gateway, replace it by the actual gateway port.

http://{server}:{port}/manager/web/api/service/instances/list

You can add the following parameters in URI to filter the service instances:

Name	Introduce	Explanation
serviceType	The type of service	Filter the service instances by the service type, please refer to the table in API > service to see the name of service types
pageSize	Service instances per page	Set the number of service instances list on each page
nodeType	The type of node	Filter the service instances by the node type, please refer to the table in API > service to see the name of node types

For example, getting the service instances, the service type is REST-Map, and the node type is mapping, list 5 instances on each page. The URI should be: http://{server}:{port}/manager/web/api/service/instances/list?serviceType=map-rest&pageSize=5&nodeType=mapping.

GET Request

Get the service instance list.

The Format of Headers

content-type: application/json
authorization: Bearer {access_token}

Response Structure

Returned the list information of service instance, made up by the following fields:

Field	Type	Explanation
componentName	String	The component name of service instance
interfaceName	String	The interface name of service instance
name	String	The name of service instance
alias	String	The alias of service instance
replicas	String	The number of service instance replicas
status	String	The status of service instance
createTime	String	The creation time of service instance
authorization	Boolean	Whether allowed anonymous users to visit service instance. True is allowed, false is not allowed.
address	Boolean	Whether returned the address of service instance. True is returned, false is not returned.
dataSource	Boolean	Whether returned the datasource of service instance. True is returned, false is not returned.
serviceType	Boolean	Whether returned the service type of service instance. True is returned, false is not returned.

Response Case

Execute GET request for http://192.168.17.139:32507/manager/web/api/service/instances/list to get the service instance list. The returned response in json format:

{
    "total": 1,
    "list": [
        {
            "address": "",
            "componentName": "map-Changchun-yzu4pdnuec",
            "interfaceName": "rest",
            "name": "map-Changchun-yzu4pdnuec/rest",
            "alias": "Instance-map-Changchun-yzu4pdnuec-rest",
            "replicas": "1",
            "status": "normal",        
            "createTime": 1593762025232,
            "authorization": true,
            "dataSource": true,
            "serviceType": true
        }
    ]
}