GIS云套件

list

URI

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

支持的方法

GET

父资源

instances

介绍

通过API获取服务实例列表信息。

支持的表述格式：JSON

HTTP 请求方法

对如下 URI 执行 HTTP 请求，其中，{server} 是服务网关的服务器名，需用实际网关IP进行替换；{port}是网关端口，需用实际网关端口替换。

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

在URI中可以加入如下参数对服务实例进行筛选：

名称	解释	说明
serviceType	服务类型	通过服务类型筛选服务实例，服务类型名称请参见API->service中的服务类型名称表
pageSize	每页显示实例数量	设置每页显示服务实例的个数
nodeType	节点类型	通过服务节点类型筛选服务实例，服务节点类型名称请参见API->service中的节点类型名称表

例如，获取地图节点上，服务类型为REST-地图服务的服务实例，每页显示5个，则URI应为：http://{server}:{port}/manager/web/api/service/instances/list?serviceType=map-rest&pageSize=5&nodeType=mapping。

GET 请求

获取服务实例列表信息。

请求头格式

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

响应结构

返回服务实例列表信息，由以下字段组成：

字段	类型	说明
componentName	String	服务实例的组件名称
interfaceName	String	服务实例的接口名称
name	String	服务实例名称
alias	String	服务实例别名
replicas	String	服务实例副本数
status	String	服务实例的状态
createTime	String	服务实例创建时间
authorization	Boolean	是否允许匿名用户访问服务实例，true为允许，false为不允许
address	Boolean	是否返回服务实例地址，true为返回，false为不返回
dataSource	Boolean	是否返回服务实例的数据源（类型），true为返回，false为不返回
serviceType	Boolean	是否返回服务实例的服务类型，true为返回，false为不返回

响应示例

在管理员登录的状态下，对http://192.168.17.139:32507/manager/web/api/service/instances/list执行GET请求，获取服务实例列表，返回的json格式的响应结果如下：

{
    "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
        }
    ]
}