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

componentName/interfaceName

\n

URI

\n

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

\n

Supported Method

\n

GET

\n

Parent Resource

\n

instance

\n

Introduction

\n

Get service instance information 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. {componentName} is the component name of service instance, {interfaceName} is the interface name of service instance, replace them by the service instance name.

\n

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

\n

GET Request

\n

Get the information of service instance.

\n

The Format of Headers

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

Response Structure

\n

Returned the details 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\n\n\n\n\n
FieldTypeExplanation
componentNameStringThe name of service component
interfaceNameStringThe name of service interface
componentTypeStringThe type of service component
addressStringThe address of service instance
dataSourceInfotypeStringThe type of datasource
nameThe name of datasource
\n

Response Case

\n

Execute GET request for http://192.168.17.145:31803/manager/web/api/service/instances/map-ml_R_4c19b918-e6b5-45d8-bd9a-73f151cfbb61-zst8abnai9/rest to get the detial information of map-mlR4c19b918-e6b5-45d8-bd9a-73f151cfbb61-zst8abnai9/rest. The returned response in json format:

\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 Cloud Suite","next":null,"prev":null},"fields":{"path":"content/microservices/interfaceName.en.md","slug":"/en/microservices/interfaceName/","langKey":"en"}}},"pageContext":{"slug":"/en/microservices/interfaceName/"}}}