GIS云套件

PUT

URI

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

支持的方法

PUT

父资源

service

介绍

通过API编辑更新服务配置。

支持的表述格式:JSON

HTTP 请求方法

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

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

PUT 请求

编辑更新服务配置。

请求头格式

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

请求参数

编辑服务配置需要的参数:

名称 类型 含义
componentName String 服务组件名称
interfaceName String 服务接口名称
serviceXml String 编辑服务配置的具体内容

响应结构

返回服务配置是否编辑成功,如果失败会给出错误信息:

字段 类型 说明
isSucceed Boolean 是否执行成功,成功为true,失败为false
msg String 如果执行失败,会显示错误信息;执行成功则为空

响应示例

在管理员登录的状态下,对http://192.168.17.139:32507/manager/web/api/service/instances执行PUT请求,将服务配置改为允许编辑,传入相关参数编辑服务配置,如下所示:

{
"componentName":"map-China400-d3awywrtby",
"interfaceName":"rest",
"serviceXml":"
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<application>
    <providers>
        <provider class="com.supermap.services.providers.UGCDataProvider" enabled="true" name="Provider-data-China400-nrsvxwjyun">
            <config class="com.supermap.services.providers.UGCDataProviderSetting">
                <datasourceInfos></datasourceInfos>
                <workspacePath>/data/China400.smwu</workspacePath>
                <datasourceNames></datasourceNames>
            </config>
        </provider>
    </providers>
    <components>
        <component class="com.supermap.services.components.impl.DataImpl" enabled="true" interfaceNames="rest" name="data-China400-nrsvxwjyun" providers="Provider-data-China400-nrsvxwjyun">
            <config class="com.supermap.services.components.DataConfig">
                    //允许编辑服务配置
                <editable>true</editable>
            </config>
        </component>
    </components>
    <interfaces>
        <interface class="com.supermap.services.rest.RestServlet" name="rest">
            <config class="com.supermap.services.rest.RestConfig">
                <relationInfos></relationInfos>
                <systemEncoderBeanNames></systemEncoderBeanNames>
                <systemDecoderBeanNames></systemDecoderBeanNames>
                <extensionResourceFinderBeanNames></extensionResourceFinderBeanNames>
                <isDebug>false</isDebug>
                <securityControlEnable>false</securityControlEnable>
                <accessControlAllowOrigin>*</accessControlAllowOrigin>
                <defaultHoldTime>0.0</defaultHoldTime>
            </config>
        </interface>
    </interfaces>
</application>"
}

则返回的json格式的响应结果如下:

{
    "isSucceed": true,
    "msg": "
}