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

componentName/interfaceName

\n

URI

\n

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

\n

支持的方法

\n

GET

\n

父资源

\n

instances

\n

介绍

\n

通过API获取服务实例。

\n

支持的表述格式：JSON

\n

HTTP 请求方法

\n

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

\n

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

\n

GET 请求

\n

获取服务实例信息。

\n

请求头格式

\n
content-type: application/json\nauthorization: Bearer {access_token}
\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\n\n\n\n\n\n\n
字段类型说明
componentNameString服务组件名称
interfaceNameString服务接口名称
componentTypeString服务组件类型
addressString服务实例的地址
dataSourceInfotypeString数据源类型
name数据源名称
\n

响应示例

\n

在管理员登录的状态下，对http://192.168.17.145:31803/manager/web/api/service/instances/map-ml_R_4c19b918-e6b5-45d8-bd9a-73f151cfbb61-zst8abnai9/rest执行GET请求，获取服务实例map-mlR4c19b918-e6b5-45d8-bd9a-73f151cfbb61-zst8abnai9/rest的信息，返回的json格式的响应结果如下：

\n
{\n​    "componentName": "map-ml_R_4c19b918-e6b5-45d8-bd9a-73f151cfbb61-zst8abnai9",\n​    "interfaceName": "rest",\n​    "alias": "Instance-map-ml_R_4c19b918-e6b5-45d8-bd9a-73f151cfbb61-zst8abnai9-rest",\n​    "createTime": 1608125335790,\n​    "componentType": "Map",\n​    "address": "http://192.168.17.145:31803/iserver/services/map-ml_R_4c19b918-e6b5-45d8-bd9a-73f151cfbb61-zst8abnai9/rest",\n​    "dataSourceInfo": {\n​        "type": "workspace",\n​        "name": "文件型工作空间"\n​    },\n​    "items": [\n​        {\n​            "location": "providers:provider:config:workspacePath",\n​            "required": true,\n​            "defaultValue": null,\n​            "basic": true,\n​            "serviceName": false,\n​            "option": null,\n​            "children": [],\n​            "cascadeItems": null,\n​            "columns": null,\n​            "disableArrayOperation": false,\n​            "hideDetail": false,\n​            "pageSize": 0,\n​            "placeholder": null,\n​            "subtitle": null,\n​            "tipMessage": null,\n​            "validation": [\n​                {\n​                    "regex": ".+\\\\.(sxwu|smwu|sxw|smw)$",\n​                    "message": "请选择工作空间类型文件(.sxwu, .smwu, .sxw, .smw)"\n​                }\n​            ],\n​            "type": "file",\n​            "description": "工作空间路径",\n​            "display": true,\n​            "readonly": false,\n​            "name": "workspacePath",\n​            "value": "/opt/MachineLearningResult/ml_R_4c19b918-e6b5-45d8-bd9a-73f151cfbb61.smwu"\n​        },\n​        {\n​            "location": null,\n​            "required": false,\n​            "defaultValue": null,\n​            "basic": true,\n​            "serviceName": false,\n​            "option": null,\n​            "children": [],\n​            "cascadeItems": null,\n​            "columns": null,\n​            "disableArrayOperation": false,\n​            "hideDetail": false,\n​            "pageSize": 0,\n​            "placeholder": null,\n​            "subtitle": null,\n​            "tipMessage": null,\n​            "validation": null,\n​            "type": "password",\n​            "description": "工作空间密码",\n​            "display": true,\n​            "readonly": false,\n​            "name": "password",\n​            "value": null\n​        }\n​    ]\n}
","frontmatter":{"title":"GIS云套件","next":null,"prev":null},"fields":{"path":"content/microservices/interfaceName.zh.md","slug":"/zh/microservices/interfaceName/","langKey":"zh"}}},"pageContext":{"slug":"/zh/microservices/interfaceName/"}}}