SuperMap iManager K8S
简体中文

GIS Cloud Suite

componentName/interfaceName

URI

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

Supported Method

GET

Parent Resource

instance

Introduction

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

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

GET Request

Get the information of service instance.

The Format of Headers

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

Response Structure

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

Field Type Explanation
componentName String The name of service component
interfaceName String The name of service interface
componentType String The type of service component
address String The address of service instance
dataSourceInfo type String The type of datasource
name The name of datasource

Response Case

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:

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