TCAGIS 18-2025 地理分析模型 服务接口

ICS07.040CCSA75团体标准T/CAGIS18-2025地理分析模型服务接口Geographicanalysismodel—Service2025-05-15发布2025-06-30实施中国地理信息产业协会目次目次...............................................................................................................................................I前言.............................................................................................................................................III引言.............................................................................................................................................IV12345范围..........................................................................................................................................1规范性引用文件......................................................................................................................1术语和定义..............................................................................................................................1缩略语......................................................................................................................................2基本要求..................................................................................................................................25.1接口分类..........................................................................................................................25.2数据交换方式..................................................................................................................45.3数据交换消息要求..........................................................................................................45.4URL要求................................................................................................................45.5请求消息参数要求..........................................................................................................45.6响应消息参数要求..........................................................................................................4管理接口..................................................................................................................................56.1上传服务..........................................................................................................................56.2查询服务..........................................................................................................................66.3删除服务..........................................................................................................................66.4服务列表..........................................................................................................................76.5查询运行记录..................................................................................................................76.6运行记录列表..................................................................................................................8描述接口..................................................................................................................................97.1添加属性..........................................................................................................................97.2修改属性........................................................................................................................107.3查询属性........................................................................................................................107.4删除属性........................................................................................................................部署接口................................................................................................................................8.1部署包完整性检测........................................................................................................8.2运行环境检测................................................................................................................128.3部署服务........................................................................................................................128.4运行测试........................................................................................................................13集成接口................................................................................................................................139.1创建集成工作流............................................................................................................13I67899.2修改集成工作流............................................................................................................159.3查询集成工作流............................................................................................................159.4删除集成工作流............................................................................................................169.5集成工作流列表............................................................................................................1610数据接口................................................................................................................................1710.1输入数据......................................................................................................................1710.2输出数据......................................................................................................................1710.3数据可视化..................................................................................................................18调用接口................................................................................................................................19在线服务检测..............................................................................................................19任务初始化..................................................................................................................19开始运行......................................................................................................................20暂停运行......................................................................................................................20中止运行......................................................................................................................21运行状态......................................................................................................................21参考文献.........................................................................................................................................23II前言本文件按照GB/T1.1—2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由中国地理信息产业协会提出并归口。宁师范大学。宁。III引言领域具有广泛应用价值。在新时代以及开放科学时代的大趋势、大发展背景下，服务化共享资源与技术的重集成提供统一框架，进而促进地理建模与模拟领域的健康发展。到全面应用。IV地理分析模型服务接口1范围成接口、数据接口、调用接口的功能要求。本文件适用于地理分析模型服务接口的设计、构建与互操作。2规范性引用文件所有的修改单）适用于本文件。T/CAGIS—2025地理分析模型元数据3术语和定义下列术语和定义适用于本文件。3.1模型model现实的某些方面的抽象。[来源：19109:2015，4.15]3.2地理分析模型geographicanalysismodel的分析、模拟和预测。3.3模型服务部署包modelservicedeploymentpackage用于模型服务部署的压缩包。注：部署包包含模型文件、封装代码、模型描述文件、测试数据、授权文件等。3.4服务service由实体通过接口提供的功能的可区分部分。1[来源：GB/T255302010，4.1]3.5接口interface描述实体行为特征的命名操作集合。[来源：GB/T255302010，4.2]3.6服务基地址servicebaseaddress服务接口的起始地址。[来源：T/CAGIS—，3.6]3.7工作流workflow化实现的业务过程。[来源：GB/T255302010，4.6]4缩略语下列缩略语适用于本文件。API：应用编程接口（ApplicationProgrammingInterface）HTTPS：超文本传输安全协议（ProtocolSecure）JSON：JavaScript对象表示法（JavaScriptObjectNotation）REST：表述性状态转移（RepresentationalState）URL：统一资源定位符（UniformResourceLocator）UTFUnicode转换格式（UnicodeTransformation）5基本要求5.1接口分类地理分析模型服务接口按服务性质划分为管理接口、描述接口、部署接口、集成接口、数据接口和调用接口。服务接口类目见表1。2表1模型服务接口类目表序号1一级类目一级类目代码二级类目二级类目代码请求方式上传服务查询服务modelInfomodelInfomodelInfomodelInfospropertypropertypropertypropertyPOSTGET23管理接口删除服务DELETEGETmodelManager4服务列表5查询运行记录运行记录列表添加属性GET6GET7POSTPUT8描述接口修改属性modelDescriptionmodelDeployment9查询属性删除属性GET10111213141516171819202122232425262728DELETEGET部署包完整性检测运行环境检测部署服务部署接口GETdeployPOSTGET运行测试创建集成工作流修改集成工作流查询集成工作流删除集成工作流集成工作流列表输入数据workflowworkflowworkflowworkflowworkflowsinputPOSTPUT集成接口modelIntegrationmodelDataGETDELETEGETPOSTGET数据接口输出数据output数据可视化在线服务检测任务初始化开始运行visualizationtaskInitGETGETPOSTPOSTPOSTPOSTGET调用接口startmodelInvocation暂停运行pause中止运行stop运行状态status35.2数据交换方式本文件涉及的接口应以RESTAPIHTTPS协议进行同步通信。5.3数据交换消息要求本文件涉及的接口消息应采用key-value装。消息请求及响应参数的英文名为键值对的键名（keyUTF-8。5.4请求URL本文件涉及的每个接口应对应一个唯一的URL:http://服务基地址一级类目代码二级类目代码，通过该URL对接口进行访问。接口遵循REST风格要求，各级代码所使用单词的词性均为名词。若无特别说明，一级类目代码和二级类目代码，应符合表2的要求。示例:查询服务信息API调用地址::8081/modelManager/modelInfo，请求方式为GET。5.5请求消息参数要求本文件涉及的请求消息应符合如下要求:1)需要提交请求参数：请求接口的参数，具体的值应符合第6章的要求，所有参数组合应为JSON，加载到请求体（body2)不需要提交请求参数：直接通过请求5.6响应消息参数要求本文件涉及的响应消息格式应为JSON返回数据集。响应消息参数说明见表2。表2响应消息参数说明序号参数参数名称类型参数说明1code状态码int接口响应后返回的状态码0200400500（服务器端异常）4序号参数msgdata参数名称状态信息描述返回数据集类型stringobject参数说明23返回情况描述信息返回的数据结果集，采用JSON字符串表示，具体值应符合第7章中各接口请求响应结构中的要求6管理接口6.1上传服务6.1.1基本描述用于上传地理分析模型服务概要信息。接口形式为：/modelManager/modelInfo6.1.2请求与响应要求该接口执行请求，请求参数说明见表，请求响应结构见表5。地址，不明确的信息加注表3请求参数说明字段名是否必须数据类型描述模型服务信息，内容结构见表4模型服务部署包文件地址modelInfo是ModelInfopackagePath是string表4ModelInfo对象结构字段名name数据类型string描述模型服务名称string模型服务唯一标识符模型服务版本versiondeveloperabstractmetadatastringstring模型服务开发者string模型服务内容简要描述模型元数据，见T/CAGISobject5字段名数据类型描述X2025模型服务是否在线0：离线，：在线permissionint表5请求响应结构字段名数据类型描述string模型服务唯一标识符6.2查询服务6.2.1基本描述用于查询地理分析模型服务概要信息。接口形式为：/modelManager/modelInfo6.2.2请求与响应要求该接口执行请求，请求参数说明见表6，请求响应结构见表。表6请求参数说明字段名是否必须数据类型描述模型服务唯一标识符是string表7请求响应结构字段名modelInfo数据类型描述模型服务信息，内容结构见表4ModelInfo6.3删除服务6.3.1基本描述用于删除地理分析模型服务。接口形式为：/modelManager/modelInfo66.3.2请求与响应要求该接口执行DELETE请求，请求参数说明见表8，该接口不返回数据。表8请求参数说明字段名是否必须数据类型描述模型服务唯一标识符是string6.4服务列表6.4.1基本描述获取服务器端所有模型服务的概要信息。接口形式为：/modelManager/modelInfos6.4.2请求与响应要求该接口执行请求，不需要请求参数，请求响应结构见表。表9请求响应结构字段名数据类型描述模型服务资源列表用ModelInfo对象的数组描述，见表4modelInfosModelInfo[]6.5查询运行记录6.5.1基本描述用于获取服务器端指定模型运行记录的详细信息。接口形式为：6.5.2请求与响应要求该接口执行请求，请求参数说明见表10，请求响应结构见表。7表10请求参数说明字段名是否必须数据类型string描述是任务唯一标识符表11请求响应结构数据类型字段名描述任务概览信息inputsParam[]用对象的数组描述，见表任务输入参数用Param对象的数组描述，见表任务输出事件outputsParam[]用Param对象的数组描述，见表表12对象结构字段名数据类型string描述任务唯一标识符任务开始运行时间任务结束运行时间任务运行状态标识-1：失败，：已创建，：正在运行，2：成功任务发起者statususerintstring表13Param对象结构字段名name数据类型string描述模型参数名称filePathstring参数对应的文件地址6.6运行记录列表6.6.1基本描述8用于获取服务器端指定模型服务的所有运行记录列表信息。接口形式为：6.6.2请求与响应要求该接口执行请求，请求参数说明见表14，请求响应结构见表。表14请求参数说明数据类型字段名是否必须描述是string模型服务唯一标识符表15请求响应结构字段名数据类型描述任务列表用对象的数组描述，见表7描述接口7.1添加属性7.1.1基本描述用于添加地理分析模型服务属性描述。接口形式为：/modelDescription/property7.1.2请求与响应要求该接口执行请求，请求参数说明见表，该接口不返回数据。表16请求参数说明数据类型字段名是否必须描述是是是stringstringobject模型服务唯一标识符模型服务属性名称模型服务属性值propNamevalue97.2修改属性7.2.1基本描述用于修改地理分析模型服务属性描述。接口形式为：/modelDescription/property7.2.2请求与响应要求该接口执行PUT请求，请求参数说明见表17，该接口不返回数据。表17请求参数说明数据类型字段名是否必须描述是是是stringstringobject模型服务唯一标识符模型服务属性名称模型服务属性值propNamevalue7.3查询属性7.3.1基本描述用于查询地理分析模型服务属性描述。接口形式为：/modelDescription/property7.3.2请求与响应要求该接口执行请求，请求参数说明见表18，请求响应结构见表。表18请求参数说明数据类型字段名是否必须描述是是stringstring模型服务唯一标识符模型服务属性名称propName表19请求响应结构数据类型字段名描述valueobject模型服务属性值107.4删除属性7.4.1基本描述用于删除地理分析模型服务属性描述。接口形式为：/modelDescription/property7.4.2请求与响应要求该接口执行DELETE请求，请求参数说明见表，该接口不返回数据。表20请求参数说明数据类型字段名是否必须描述是是stringstring模型服务唯一标识符模型服务属性名称propName8部署接口8.1部署包完整性检测8.1.1基本描述用于检测模型服务部署包是否完整。接口形式为：8.1.2请求与响应要求该接口执行请求，请求参数说明见表21，请求响应结构见表。表21请求参数说明数据类型string字段名是否必须描述模型服务唯一标识符是表22请求响应结构字段名数据类型描述模型服务部署包状态标识-1：缺失，：不完整，：完整statusint8.2运行环境检测8.2.1基本描述用于检测服务器端软硬件环境是否符合模型运行条件。接口形式为：8.2.2请求与响应要求该接口执行请求，请求参数说明见表23，请求响应结构见表。表23请求参数说明数据类型string字段名是否必须描述模型服务唯一标识符是表24请求响应结构数据类型int字段名status描述运行环境检测结果标识0：不符合，1：符合8.3部署服务8.3.1基本描述用于在服务器端部署模型服务。接口形式为：/modelDeployment/deploy8.3.2请求与响应要求12该接口执行请求，请求参数说明见表，请求响应结构见表。表25请求参数说明数据类型string字段名是否必须描述模型服务唯一标识符是表26请求响应结构数据类型int字段名status描述部署结果标识0：失败，：成功8.4运行测试8.4.1基本描述用于检测部署的模型服务能否正常运行。接口形式为：8.4.2请求与响应要求该接口执行请求，请求参数说明见表27，请求响应结构见表。表27请求参数说明数据类型string字段名是否必须描述模型服务唯一标识符是表28请求响应结构数据类型int字段名status描述运行测试结果标识0：失败，：成功9集成接口9.1创建集成工作流139.1.1基本描述用于配置参与集成工作流的模型服务及数据连接方式。接口形式为：/modelIntegration/workflow9.1.2请求与响应要求该接口执行请求，请求参数说明见表，请求响应结构见表。表29请求参数说明数据类型字段名是否必须描述集成工作流信息用对象描述，见表workflowInfo是表30对象结构字段名数据类型描述参与集成工作流的所有模型服务idsstring[]模型服务数据连接数组，用于数据传输dataConnDataConnection[]用DataConnection对象的数组描述，见表表31DataConnection对象结构字段名数据类型描述数据传输的起始模型参数用ModelParam对象描述，见表fromModelParamModelParam数据传输的目标模型参数用ModelParam对象描述，见表14表32ModelParam对象结构字段名数据类型string描述模型服务唯一标识符模型参数名称paramNamestring表33请求响应结构字段名数据类型描述string集成工作流唯一标识符9.2修改集成工作流9.2.1基本描述用于配置参与集成工作流的模型服务及运行顺序。接口形式为：/modelIntegration/workflow9.2.2请求与响应要求该接口执行PUT请求，请求参数说明见表34，该接口不返回数据。表34请求参数说明数据类型字段名是否必须描述集成工作流唯一标识符是string集成工作流信息用对象描述，见表workflowInfo是9.3查询集成工作流9.3.1基本描述用于查询参与集成工作流的模型服务及运行顺序。接口形式为：/modelIntegration/workflow9.3.2请求与响应要求15该接口执行请求，请求参数说明见表35，请求响应结构见表。表35请求参数说明数据类型string字段名是否必须描述集成工作流唯一标识符是表36请求响应结构字段名数据类型描述集成工作流信息用对象描述，见表30workflowInfo9.4删除集成工作流9.4.1基本描述用于删除已创建的集成工作流。接口形式为：/modelIntegration/workflow9.4.2请求与响应要求该接口执行DELETE请求，请求参数说明见表，该接口不返回数据。表37请求参数说明数据类型string字段名是否必须描述集成工作流唯一标识符是9.5集成工作流列表9.5.1基本描述用于获取服务器端所有集成工作流的信息列表。接口形式为：/modelIntegration/workflows169.5.2请求与响应要求该接口执行请求，不需要请求参数，请求响应结构见表。表38请求响应结构字段名数据类型描述集成工作流信息列表用对象的数组描述，见表workflowInfos10数据接口10.1输入数据10.1.1基本描述提供模型服务运行所需数据。接口形式为：/modelData/input10.1.2请求与响应要求该接口执行请求，请求参数说明见表，该接口不返回数据。表39请求参数说明数据类型字段名是否必须描述是string模型任务唯一标识符任务输入参数用Param对象描述，见表input是Param10.2输出数据10.2.1基本描述获取模型输出数据。接口形式为：/modelData/output1710.2.2请求与响应要求该接口执行请求，请求参数说明见表40，请求响应结构见表。表40请求参数说明数据类型string字段名是否必须描述模型任务唯一标识符是表41请求响应结构数据类型字段名描述任务输出参数用Param对象描述，见表13outputParam10.3数据可视化10.3.1基本描述将模型的输入或输出数据进行在线可视化。接口形式为：/modelData/visualization10.3.2请求与响应要求该接口执行请求，请求参数说明见表42，请求响应结构见表。表42请求参数说明数据类型字段名是否必须描述是是stringstring模型任务唯一标识符模型参数名称paramName可视化类型选项，可选择的类型有文本（texttype是string（image（3D）等。18表43请求响应结构字段名数据类型描述webPathstring数据可视化结果的在线地址11调用接口11.1在线服务检测11.1.1基本描述用于检测模型服务是否支持调用。接口形式为：11.1.2请求与响应要求该接口执行请求，请求参数说明见表44，请求响应结构见表。表44请求参数说明数据类型string字段名是否必须描述模型服务唯一标识符是表45请求响应结构数据类型int字段名描述服务状态标识0：离线，：在线status11.2任务初始化11.2.1基本描述用于创建并初始化地理分析模型服务运行任务。接口形式为：/modelInvocation/taskInit11.2.2请求与响应要求19该接口执行请求，请求参数说明见表，请求响应结构见表。表46请求参数说明数据类型string字段名是否必须描述模型服务或集成工作流唯一标识符是表47请求响应结构字段名数据类型string描述任务唯一标识符11.3开始运行11.3.1基本描述开始运行任务。接口形式为：/modelInvocation/start11.3.2请求与响应要求该接口执行请求，请求参数说明见表，请求响应结构见表。表48请求参数说明字段名是否必须数据类型string描述是任务唯一标识符表49请求响应结构数据类型字段名描述任务状态标识-1：输入数据不完整，0：模型启动失败，1：模型启动成功statusint11.4暂停运行11.4.1基本描述20暂停运行任务。接口形式为：/modelInvocation/pause11.4.2请求与响应要求该接口执行请求，请求参数说明见表，该接口不