API =================== .. toctree:: :hidden: :glob: ./api/* ./api/*/*/* .. role:: strike :class: strike 说明 ------------------ REST API 文档，所有 API 符合通用规范。 所有 URL 的 api 前缀是为前后端分离，nginx 反向代理自动去除前缀。 :doc:`通用规范<./api/common>` 所有的接口均返回状态码，其他接口返回数据不再赘述 系统管理中心（ispatial-system） --------------------------------------------------- - 用户管理（LoginController） - :doc:`登录<./api/ispatial-system/LoginController/login>` - :doc:`用户验证<./api/ispatial-system/LoginController/isCurrentUserValid>` - 用户管理（UserController） - :doc:`用户列表<./api/ispatial-system/UserController/userGet>` - :doc:`添加用户<./api/ispatial-system/UserController/userAdd>` - :doc:`普通用户修改密码<./api/ispatial-system/UserController/userModify>` - :doc:`系统管理员修改密码<./api/ispatial-system/UserController/userModifyByAdmin>` - :doc:`废弃用户<./api/ispatial-system/UserController/userDelete>` - :doc:`赋予成员角色<./api/ispatial-system/UserController/userRoleAdd>` - :doc:`移除成员角色<./api/ispatial-system/UserController/userRoleDelete>` - :doc:`修改成员角色<./api/ispatial-system/UserController/userRoleModify>` - 角色管理（RoleController） - :doc:`角色列表<./api/ispatial-system/RoleController/roleGet>` - :doc:`添加角色<./api/ispatial-system/RoleController/roleAdd>` - :doc:`删除角色<./api/ispatial-system/RoleController/roleDelete>` - :doc:`修改角色权限<./api/ispatial-system/RoleController/roleModify>` - 权限管理（PrivileageController） - :doc:`权限列表<./api/ispatial-system/PrivilegeController/privilegeGet>` - CDH 运维管理(clouderamanage) - :doc:`查询集群主机信息<./api/ispatial-system/clouderamanage/clusterHost>` - :doc:`查询集群主机信息<./api/ispatial-system/clouderamanage/clusterService>` 数据管理中心（ispatial-manage） ----------------------------------------------------------- - 数据目录管理（CatalogController） - :doc:`数据目录查询<./api/ispatial-manage/CatalogController/listCatalogData>` - :doc:`创建文件夹<./api/ispatial-manage/CatalogController/createFolder>` - :doc:`修改文件夹<./api/ispatial-manage/CatalogController/updateFolder>` - :doc:`删除文件夹<./api/ispatial-manage/CatalogController/deleteFolder>` - :doc:`查询数据表结构信息<./api/ispatial-manage/CatalogController/queryTableById>` - :doc:`查询数据表结构信息<./api/ispatial-manage/CatalogController/queryTableByName>` - :doc:`创建数据表<./api/ispatial-manage/CatalogController/createTable>` - :doc:`更新数据表结构信息<./api/ispatial-manage/CatalogController/updateTable>` - :doc:`删除数据表<./api/ispatial-manage/CatalogController/deleteTable>` - :doc:`删除栅格数据表<./api/ispatial-manage/CatalogController/deleteKuduRasterTableByName>` - :doc:`查询所有数据表<./api/ispatial-manage/CatalogController/queryAllTables>` - :doc:`按条件查询数据表<./api/ispatial-manage/CatalogController/queryTablesByCon>` - :doc:`文件上传<./api/ispatial-manage/CatalogController/uploadDataFile>` - :doc:`文件保存入库<./api/ispatial-manage/CatalogController/saveDataFiles>` - :doc:`文件删除<./api/ispatial-manage/CatalogController/deleteDataFile>` - :doc:`文件下载<./api/ispatial-manage/CatalogController/downloadDataFile>` - :doc:`文件压缩<./api/ispatial-manage/CatalogController/compressDataFiles>` - :doc:`文件解压<./api/ispatial-manage/CatalogController/decompressZipFile>` - :doc:`批量删除<./api/ispatial-manage/CatalogController/deleteItems>` - :doc:`文件在线预览<./api/ispatial-manage/CatalogController/browseDataFile>` - HDFS（HdfsController） - :doc:`HDFS 文件列表<./api/ispatial-system/HdfsController/hdfslistGet>` - :doc:`HDFS 上传文件<./api/ispatial-system/HdfsController/hdfsFlieAdd>` - :doc:`HDFS 删除文件<./api/ispatial-system/HdfsController/hdfsFileDelete>` - :doc:`HDFS 创建文件夹<./api/ispatial-system/HdfsController/hdfsFolderAdd>` - :doc:`HDFS 文件夹重命名<./api/ispatial-system/HdfsController/hdfsFolderRename>` - :doc:`HDFS 下载文件<./api/ispatial-system/HdfsController/downloadHdfsFile>` - 表管理（TableController） - :doc:`表-列表<./api/ispatial-manage/TableController/tablelistGet>` - :doc:`表-详细信息<./api/ispatial-manage/TableController/tableinfoGet>` - :doc:`表-创建<./api/ispatial-manage/TableController/tableAdd>` - :doc:`表-删除<./api/ispatial-manage/TableController/tableDelete>` - :doc:`表-修改<./api/ispatial-manage/TableController/tableModify>` - :doc:`表-查询分区<./api/ispatial-manage/TableController/partitionlistGet>` - :doc:`表-添加分区<./api/ispatial-manage/TableController/partitionAdd>` - :doc:`表-删除分区<./api/ispatial-manage/TableController/partitionDelete>` - :doc:`表-添加列<./api/ispatial-manage/TableController/colAdd>` - :doc:`数据查询<./api/ispatial-manage/TableController/sqlGet>` - GIS 数据管理（WorkspaceController） - :doc:`工作区列表<./api/ispatial-manage/WorkspaceController/workspacelistGet>` - :doc:`创建工作区<./api/ispatial-manage/WorkspaceController/workspaceAdd>` - :doc:`工作区属性信息修改<./api/ispatial-manage/WorkspaceController/workspaceModify>` - :doc:`工作区删除<./api/ispatial-manage/WorkspaceController/workspaceDelete>` - :doc:`工作区属性信息查看<./api/ispatial-manage/WorkspaceController/workspaceGet>` - :doc:`工作区数据列表<./api/ispatial-manage/WorkspaceController/workspaceDatalistGet>` :strike:`- :doc:`数据批量删除<./api/ispatial-manage/WorkspaceController/dataBatchDelete>`` :strike:`- :doc:`数据属性信息查看<./api/ispatial-manage/WorkspaceController/dataGet>`` :strike:`- :doc:`数据属性信息修改<./api/ispatial-manage/WorkspaceController/dataModify>`` :strike:`- :doc:`数据删除<./api/ispatial-manage/WorkspaceController/dataDelete>`` - 数据集管理（DatasetController） - :doc:`创建数据集<./api/ispatial-manage/WorkspaceController/datasetAdd>` - :doc:`数据集属性信息修改<./api/ispatial-manage/DatasetController/datasetModify>` - :doc:`数据集删除<./api/ispatial-manage/DatasetController/datasetDelete>` - :doc:`数据集属性信息查看<./api/ispatial-manage/DatasetController/datasetGet>` - :doc:`数据集数据列表<./api/ispatial-manage/DatasetController/datasetDatalistGet>` - GIS 数据导入（DataController） - :doc:`Oralce（ArcSDE）矢量数据入库工具<./api/ImportTool>` - :doc:`导入数据<./api/ispatial-manage/DataController/dataImport>` - :doc:`导入数据进度查看<./api/ispatial-manage/DataController/dataImportProgressGet>` - 服务管理（ServiceController） - :doc:`发布服务<./api/ispatial-manage/ServiceController/addService>` - :doc:`查询所有服务<./api/ispatial-manage/ServiceController/queryAllService>` - :doc:`按业务类型查询服务<./api/ispatial-manage/ServiceController/queryServicesByTypes>` - :doc:`按条件查询服务<./api/ispatial-manage/ServiceController/queryServicesByCon>` - :doc:`查询矢量服务 TileJson<./api/ispatial-manage/ServiceController/queryServiceTilejson>` - :doc:`查询服务业务树<./api/ispatial-manage/ServiceController/queryServiceTree>` - :doc:`删除服务<./api/ispatial-manage/ServiceController/deleteService>` - :doc:`获取服务范围<./api/ispatial-manage/ServiceController/queryServiceRange>` - :doc:`查询图层字段<./api/ispatial-manage/ServiceController/queryLayerFields>` - :doc:`开启服务<./api/ispatial-manage/ServiceController/startService>` - :doc:`停止服务<./api/ispatial-manage/ServiceController/stopService>` - :doc:`制作已发布服务的瓦片缓存<./api/ispatial-manage/ServiceController/makeServiceTileCache>` - :doc:`查询缓存制作状态<./api/ispatial-manage/ServiceController/getServiceTileCacheStatus>` - :doc:`查询缓存制作进度<./api/ispatial-manage/ServiceController/queryServiceCacheProgress>` - :doc:`数据服务(wmts)<./api/ispatial-manage/ServiceController/wmts>` - :doc:`获取服务列表 tilesets<./api/ispatial-manage/ServiceController/queryMServiceTilesets>` - :doc:`查询服务样式表<./api/ispatial-manage/ServiceController/queryServiceStyle>` - :doc:`创建服务样式<./api/ispatial-manage/ServiceController/addMServiceStyle>` - 数据集成（IntegrateController） - :doc:`查询数据源列表<./api/ispatial-manage/IntegrateController/querySourceByCon>` - :doc:`添加数据源<./api/ispatial-manage/IntegrateController/addIntegrateSource>` - :doc:`删除数据源<./api/ispatial-manage/IntegrateController/deleteSourceById>` - :doc:`测试数据源连接状态<./api/ispatial-manage/IntegrateController/checkIntegrateSourceConnect>` - :doc:`获取 FTP 目录树结构<./api/ispatial-manage/IntegrateController/getFtpTreeNode>` - :doc:`查询导入任务列表<./api/ispatial-manage/IntegrateController/queryTaskByCon>` - :doc:`查询指定导入任务<./api/ispatial-manage/IntegrateController/queryTaskById>` - :doc:`终止一个导入任务<./api/ispatial-manage/IntegrateController/stopTaskById>` - :doc:`删除一个导入任务<./api/ispatial-manage/IntegrateController/deleteTaskById>` - :doc:`本地矢量数据文件上传（shp zip）<./api/ispatial-manage/IntegrateController/uploadDataFile>` - :doc:`导入客户端上传的矢量数据（shp zip）<./api/ispatial-manage/IntegrateController/saveClientFileData>` - :doc:`oracle矢量数据迁移kudu<./api/ispatial-manage/IntegrateController/ImportOracleVectorDataToKudu>` :strike:`- :doc:`通过 FTP 数据源导入矢量数据<./api/ispatial-manage/IntegrateController/saveFtpDataToKudu>``（被下面的接口替代） - :doc:`通过指定数据源导入数据至平台数据中心<./api/ispatial-manage/IntegrateController/importSourceDataToKudu>` webgis 可视化（ispatial-display） ----------------------------------------------------------- - Webgis（WebgisController） - :doc:`面积查询<./api/ispatial-display/WebgisController/selectsql>` 计算中心（ispatial-compute） ----------------------------------------------------------- - 资源管理（ResourceController） - :doc:`资源列表<./api/ispatial-compute/ResourceController/resourcelistGet>` - :doc:`上传资源<./api/ispatial-compute/ResourceController/uploadResouceFile>` - :doc:`创建资源<./api/ispatial-compute/ResourceController/resourceAdd>` - :doc:`删除资源<./api/ispatial-compute/ResourceController/resourceDelete>` - :doc:`修改资源<./api/ispatial-compute/ResourceController/resourceModify>` - :doc:`查看资源<./api/ispatial-compute/ResourceController/resourceGet>` - 调度管理（DispatchController） - :doc:`调度列表<./api/ispatial-compute/DispatchController/dispatchlistGet>` - :doc:`添加调度<./api/ispatial-compute/DispatchController/dispatchAdd>` - :doc:`调度删除<./api/ispatial-compute/DispatchController/dispatchDelete>` - :doc:`调度修改<./api/ispatial-compute/DispatchController/dispatchModify>` - :doc:`调度查看<./api/ispatial-compute/DispatchController/dispatchGet>` - :doc:`开启调度<./api/ispatial-compute/DispatchController/dispatchAlterStatus>` - 工作流管理（WorkflowController） - :doc:`工作流列表<./api/ispatial-compute/WorkflowController/workflowlistGet>` - :doc:`添加工作流<./api/ispatial-compute/WorkflowController/workflowAdd>` - :doc:`工作流删除<./api/ispatial-compute/WorkflowController/workflowDelete>` - :doc:`工作流修改<./api/ispatial-compute/WorkflowController/workflowModify>` - :doc:`工作流查看<./api/ispatial-compute/WorkflowController/workflowGet>` - :doc:`手动运行工作流<./api/ispatial-compute/WorkflowController/workflowRun>` - :doc:`获取工作流自定义算子<./api/ispatial-compute/WorkflowController/queryCustomWorkflowNode>` - 运行实例管理（InstanceController） - :doc:`实例列表<./api/ispatial-compute/InstanceController/instancelistGet>` - :doc:`查看实例<./api/ispatial-compute/InstanceController/instanceGet>` - :doc:`终止实例<./api/ispatial-compute/InstanceController/instanceStop>` - :strike:` :doc:`暂停实例<./api/ispatial-compute/InstanceController/instanceSuspended>` （暂不开放使用）` - :strike:` :doc:`继续运行实例<./api/ispatial-compute/InstanceController/instanceResume>` （暂不开放使用）` - :doc:`查看实例节点日志<./api/ispatial-compute/InstanceController/instanceCatLog>` - 机器学习-总览（MLWorkflowController） - :doc:`机器学习全节点-获取列信息<./api/ispatial-compute/machinelearning/workflowActionGetCol>` - :doc:`机器学习全节点-表节点数据预览<./api/ispatial-compute/machinelearning/tabledata>` - 机器学习-工作流管理 - :doc:`添加工作流<./api/ispatial-compute/machinelearning/workflowAdd>` - :doc:`更新工作流<./api/ispatial-compute/machinelearning/workflowUpdate>` - :doc:`删除工作流<./api/ispatial-compute/WorkflowController/workflowDelete>` **参考普通工作流删除接口** - :doc:`查看工作流<./api/ispatial-compute/WorkflowController/workflowGet>` **参考普通工作流查询接口** - :doc:`查看工作流列表<./api/ispatial-compute/WorkflowController/workflowlistGet>` **参考普通工作流列表查询接口** - :doc:`获取机器学习自定义算子<./api/ispatial-compute/machinelearning/queryCustomPaiNode>` - :doc:`查询算子配置（按类型）<./api/ispatial-compute/machinelearning/queryPaiNodeConfig>` - :doc:`查询全部算子配置<./api/ispatial-compute/machinelearning/queryAllPaiNodeConfig>` - 机器学习-工作流运行 - :doc:`工作流运行<./api/ispatial-compute/machinelearning/workflowrun>` - :doc:`单节点运行<./api/ispatial-compute/machinelearning/workflowsinglerun>` - :doc:`工作流节点轮询状态<./api/ispatial-compute/machinelearning/polling>` - :doc:`工作流节点状态修改<./api/ispatial-compute/machinelearning/actionmodify>` - 机器学习-辅助接口 - :doc:`上传 SQL 工具<./api/ispatial-compute/machinelearning/uploadSQL>` - :doc:`查询工作流数据表<./api/ispatial-compute/DataAccessController/queryWorkflowTables>` - :doc:`查询工作流数据表结构<./api/ispatial-compute/DataAccessController/queryWorkFlowTableInfo>` - 深度学习-模型管理 - :doc:`查询模型列表<./api/ispatial-deeplearning/dlmodel/queryModelList>` - :doc:`查询模型详细信息<./api/ispatial-deeplearning/dlmodel/queryModelDetail>` - :doc:`模型文件上传<./api/ispatial-deeplearning/dlmodel/uploadModelFile>` - :doc:`模型导入保存<./api/ispatial-deeplearning/dlmodel/saveModelFiles>` - :doc:`模型更新<./api/ispatial-deeplearning/dlmodel/updateModelDetail>` - :doc:`模型删除<./api/ispatial-deeplearning/dlmodel/deleteModel>` - :doc:`模型下载<./api/ispatial-deeplearning/dlmodel/downloadModelFile>` - 深度学习-目标检测微服务 - :doc:`提交预测任务<./api/ispatial-deeplearning/obj_det/predict>` - :doc:`终止任务<./api/ispatial-deeplearning/obj_det/stop>` - :doc:`查询特定任务<./api/ispatial-deeplearning/obj_det/task>` - :doc:`查询任务列表<./api/ispatial-deeplearning/obj_det/tasks>` - 深度学习-变化检测微服务 - :doc:`提交预测任务<./api/ispatial-deeplearning/chg_det/predict>` - :doc:`终止任务<./api/ispatial-deeplearning/chg_det/stop>` - :doc:`查询特定任务<./api/ispatial-deeplearning/chg_det/task>` - :doc:`查询任务列表<./api/ispatial-deeplearning/chg_det/tasks>`