{"componentChunkName":"component---src-templates-microservices-js","path":"/en/microservices/instancelist/","result":{"data":{"markdownRemark":{"html":"

list

\n

URI

\n

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

\n

Supported Method

\n

GET

\n

Parent Resource

\n

instances

\n

Introduction

\n

Get the service instance list by API.

\n

Supported Interchange Format: JSON

\n

HTTP Request Method

\n

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.

\n

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

\n

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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameIntroduceExplanation
serviceTypeThe type of serviceFilter the service instances by the service type, please refer to the table in API > service to see the name of service types
pageSizeService instances per pageSet the number of service instances list on each page
nodeTypeThe type of nodeFilter the service instances by the node type, please refer to the table in API > service to see the name of node types
\n

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.

\n

GET Request

\n

Get the service instance list.

\n

The Format of Headers

\n
content-type: application/json\nauthorization: Bearer {access_token}
\n

Response Structure

\n

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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeExplanation
componentNameStringThe component name of service instance
interfaceNameStringThe interface name of service instance
aliasStringThe alias of service instance
createTimeStringThe creation time of service instance
everyoneBooleanWhether allowed anonymous users to visit service instance. True is allowed, false is not allowed.
\n

Response Case

\n

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:

\n
{\n    "total": 1,\n    "list": [\n        {\n            "componentName": "map-Changchun-yzu4pdnuec",\n            "interfaceName": "rest",\n            "alias": "Instance-map-Changchun-yzu4pdnuec-rest",\n            "createTime": 1593762025232,\n            "everyone": true\n        }\n    ]\n}
","frontmatter":{"title":"GIS Cloud Suite","next":null,"prev":null},"fields":{"path":"content/microservices/instancelist.en.md","slug":"/en/microservices/instancelist/","langKey":"en"}}},"pageContext":{"slug":"/en/microservices/instancelist/"}}}