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:

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:

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": [
        {
            "componentName": "map-Changchun-yzu4pdnuec",
            "interfaceName": "rest",
            "alias": "Instance-map-Changchun-yzu4pdnuec-rest",
            "createTime": 1593762025232,
            "everyone": true
        }
    ]
}