热门搜索:
kbase/staging_service
kbase
staging_service是一个用于本地开发环境搭建的服务镜像，提供文件管理（上传、下载、删除、移动）、目录列表与搜索、文件元数据获取、压缩文件解压、Globus ACL管理及文件类型与导入器映射检测等功能，需Docker环境运行，支持本地Python开发调试。
下载次数: 0状态：社区镜像维护者：kbase仓库类型：镜像最近更新：4 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
staging_service 镜像文档
镜像概述
staging_service是一个用于搭建本地开发环境的服务镜像，主要提供文件管理、用户认证、Globus集成及文件类型检测等功能。该镜像需在Docker环境中运行，也支持本地Python开发调试，适用于需要处理用户文件、权限验证和第三方存储集成的开发场景。
核心功能与特性
- 文件管理：支持文件/文件夹的上传、下载、删除、移动（重命名）操作
- 目录操作：提供目录列表展示（支持显示/隐藏隐藏文件）和文件搜索功能
- 文件元数据：获取文件/文件夹的名称、路径、修改时间、大小、类型等信息，文件还包含MD5、行数、头部和尾部内容
- 压缩与解压：支持多种归档格式（.zip、.tar.gz、.tgz等）的解压
- 权限控制：基于Auth token的用户认证机制
- Globus集成：支持添加/移除Globus访问控制列表（ACL）
- 文件类型检测：自动预测文件对应的导入器应用，并返回文件类型信息
- 调试支持：提供Visual Studio Code调试配置，方便本地开发调试
使用场景与适用范围
- 本地开发和测试文件管理服务
- KBase相关应用开发中的文件处理模块测试
- 需要模拟用户文件上传、权限验证流程的开发环境
- 集成Globus存储服务的应用调试
使用方法与配置说明
环境准备
- Docker环境：必须安装Docker
- 本地开发（可选）：需安装Python 3.6及
requirements.txt依赖
目录结构设置
需创建以下目录结构：
data/ - bulk/ - username/ # 为每个需要使用服务的用户创建目录 - username/
本地运行
-
安装Python依赖：
bashpip install -r requirements.txt -
启动服务：
bash/deployment/bin/entrypoint.sh
Docker运行
bash/run_in_docker.sh
调试配置
镜像包含Visual Studio Code的Python调试配置，与entrypoint.sh中的设置一致。在VSCode中打开项目后，可直接使用调试器设置断点进行本地调试和测试。
依赖命令行工具
- 本地环境：需安装
tar、unzip、zip、gzip、bzip2、md5sum、head、tail、wc - Docker容器：已包含所有上述工具
API文档
所有路径均以用户主目录为根目录。
Test Service
- URL：
ci.kbase.us/services/staging_service/test-service - 本地URL：
localhost:3000/test-service - 方法：
GET
成功响应
- 状态码：
200 OK - 响应示例：
This is just a test. This is only a test.
Test Auth
- URL：
ci.kbase.us/services/staging_service/test-auth - 本地URL：
localhost:3000/test-auth - 方法：
GET - 请求头：
Authorization: <Valid Auth token>
成功响应
- 状态码：
200 OK - 响应示例：
I'm authenticated as <username>
错误响应
- 认证错误：状态码
401 Unauthorized，响应内容Error Connecting to auth service ... - 缺少token：状态码
400 Bad Request，响应内容Must supply token
File Lifetime
- URL：
ci.kbase.us/services/staging_service/file-lifetime - 本地URL：
localhost:3000/file-lifetime - 方法：
GET
成功响应
- 状态码：
200 OK - 响应示例：
90 - 说明：返回文件在staging服务中保留的天数（实际由cron job处理，服务仅读取环境变量）
List Directory
默认不显示隐藏文件（以.开头的文件）。
- URL：
ci.kbase.us/services/staging_service/list/{path to directory} - URL：
ci.kbase.us/services/staging_service/list/{path to directory}?showHidden={True/False} - 本地URL：
localhost:3000/list/{path to directory} - 本地URL：
localhost:3000/list/{path to directory}?showHidden={True/False} - 方法：
GET - 请求头：
Authorization: <Valid Auth token>
成功响应
- 状态码：
200 OK - 响应示例：
json
[ { "name": "testFolder", "path": "nixonpjoshua/testFolder", "mtime": 1510949575000, "size": 96, "isFolder": true }, { "name": "testfile", "path": "nixonpjoshua/testfile", "mtime": 1510949629000, "size": 335, "isFolder": false } ]
错误响应
- 认证错误：状态码
401 Unauthorized，响应内容Error Connecting to auth service ... - 缺少token：状态码
400 Bad Request，响应内容Must supply token - 路径不存在：状态码
404 Not Found，响应内容path <username>/<incorrect path> does not exist
Download File
- URL：
ci.kbase.us/services/staging_service/download/{path to file} - 本地URL：
localhost:3000/download/{path to file} - 方法：
GET - 请求头：
Authorization: <Valid Auth token>
成功响应
- 状态码：
200 OK - 响应内容：文件内容
错误响应
- 认证错误：状态码
401 Unauthorized，响应内容Error Connecting to auth service ... - 缺少token：状态码
400 Bad Request，响应内容Must supply token - 路径为目录：状态码
400 Bad Request，响应内容<username>/<incorrect path> is a directory not a file - 路径不存在：状态码
404 Not Found，响应内容path <username>/<incorrect path> does not exist
Search files and folders
默认不显示隐藏文件。
- URL：
ci.kbase.us/services/staging_service/search/{search query} - URL：
ci.kbase.us/services/staging_service/search/{search query}?showHidden={True/False} - 本地URL：
localhost:3000/search/{search query} - 本地URL：
localhost:3000/search/?showHidden={True/False} - 方法：
GET - 请求头：
Authorization: <Valid Auth token>
成功响应
- 状态码：
200 OK - 响应示例：
json
[ { "name": "testfile", "path": "nixonpjoshua/testfile", "mtime": 1510949629000, "size": 335, "isFolder": false }, { "name": "testFolder", "path": "nixonpjoshua/testFolder", "mtime": 1510949575000, "size": 96, "isFolder": true }, { "name": "testinnerFile", "path": "nixonpjoshua/testFolder/testinnerFile", "mtime": 1510949575000, "size": 0, "isFolder": false } ]
错误响应
- 认证错误：状态码
401 Unauthorized，响应内容Error Connecting to auth service ... - 缺少token：状态码
400 Bad Request，响应内容Must supply token
File and Folder Metadata
- URL：
ci.kbase.us/services/staging_service/metadata/{path to file or folder} - 本地URL：
localhost:3000/metadata/{path to file or folder} - 方法：
GET - 请求头：
Authorization: <Valid Auth token>
成功响应
- 状态码：
200 OK - 文件夹响应示例：
json
{ "name": "testFolder", "path": "nixonpjoshua/testFolder", "mtime": 1510949575000, "size": 96, "isFolder": true } - 文件响应示例：
json
{ "md5": "73cf08ad9d78d3fc826f0f265139de33", "lineCount": "13", "head": "there is stuff in this file\nthere is stuff in this file\nthere is stuff in this file\nthere is stuff in this file\nthere is stuff in this file\nthere is stuff in this file\nthere is stuff in this file\nstuff at the bottom\nstuff at the bottom\nstuff at the bottom", "tail": "there is stuff in this file\nthere is stuff in this file\nthere is stuff in this file\nstuff at the bottom\nstuff at the bottom\nstuff at the bottom\nstuff at the bottom\nstuff at the bottom\nstuff at the bottom\nstuff at the bottom", "name": "testFile", "path": "nixonpjoshua/testFile", "mtime": 1510949629000, "size": 335, "isFolder": false }
错误响应
- 认证错误：状态码
401 Unauthorized，响应内容Error Connecting to auth service ... - 缺少token：状态码
400 Bad Request，响应内容Must supply token - 路径不存在：状态码
404 Not Found，响应内容path <username>/<incorrect path> does not exist
Upload File
- URL：
ci.kbase.us/services/staging_service/upload - 本地URL：
localhost:3000/upload - 方法：
POST - 请求头：
Authorization: <Valid Auth token> - 请求体约束：
- 第一个元素：
destPath: {path file should end up in}（文件目标路径） - 第二个元素：
uploads: {multipart file}（多部分文件数据） - 不允许上传以空格或
.开头的文件
- 第一个元素：
成功响应
- 状态码：
200 OK - 响应示例：
json
[ { "name": "fasciculatum_supercontig.fasta", "path": "nixonpjoshua/fasciculatum_supercontig.fasta", "mtime": 1510950061000, "size": 31536508, "isFolder": false } ]
错误响应
- 认证错误：状态码
401 Unauthorized，响应内容Error Connecting to auth service ... - 缺少token：状态码
400 Bad Request，响应内容Must supply token
Define/Create UPA for file which has been imported
- URL：
ci.kbase.us/services/staging_service/define-upa/{path to imported file} - 本地URL：
localhost:3000/define-upa/{path to imported file} - 方法：
POST - 请求头：
Authorization: <Valid Auth token> - 请求体约束：第一个元素
UPA: {the actual UPA of imported file}（导入文件的UPA）
成功响应
- 状态码：
200 OK - 响应示例：
successfully update UPA <UPA> for file <Path>
错误响应
- 认证错误：状态码
401 Unauthorized，响应内容Error Connecting to auth service ... - 缺少token：状态码
400 Bad Request，响应内容Must supply token - 缺少UPA字段：状态码
400 Bad Request，响应内容must provide UPA field in body
Delete file or folder (will delete things contained in folder)
- URL：
ci.kbase.us/services/staging_service/delete/{path to file or folder} - 本地URL：
localhost:3000/delete/{path to file or folder} - 方法：
DELETE - 请求头：
Authorization: <Valid Auth token>
成功响应
- 状态码：
200 OK - 响应示例：
successfully deleted UPA <Path>
错误响应
- 认证错误：状态码
401 Unauthorized，响应内容Error Connecting to auth service ... - 缺少token：状态码
400 Bad Request，响应内容Must supply token - 路径不存在：状态码
404 Not Found，响应内容could not delete <Path> - 禁止删除：状态码
403 Forbidden，响应内容cannot delete home directory或cannot delete protected file
Move/rename a file or folder
- URL：
ci.kbase.us/services/staging_service/mv/{path to file or folder} - 本地URL：
localhost:3000/mv/{path to file or folder} - 方法：
PATCH - 请求头：
Authorization: <Valid Auth token> - 请求体约束：第一个元素
newPath : {the new location/name for file or folder}（新路径/名称）
成功响应
- 状态码：
200 OK - 响应示例：
successfully moved <path> to <newPath>
错误响应
- 认证错误：状态码
401 Unauthorized，响应内容Error Connecting to auth service ... - 缺少token：状态码
400 Bad Request，响应内容Must supply token - 缺少newPath字段：状态码
400 Bad Request，响应内容must provide newPath field in body - 禁止操作：状态码
403 Forbidden，响应内容cannot rename home or move directory或cannot rename or move protected file - 路径已存在：状态码
409 Conflict，响应内容<newPath> allready exists
Decompress various archive formats
支持的归档格式：.zip、.ZIP、.tar.gz、.tgz、.tar.bz、.tar.bz2、.tar、.gz、.bz2、.bzip2
- URL：
ci.kbase.us/services/staging_service/decompress/{path to archive} - 本地URL：
localhost:3000/decompress/{path to archive} - 方法：
PATCH - 请求头：
Authorization: <Valid Auth token>
成功响应
- 状态码：
200 OK - 响应示例：
successfully decompressed <path to archive>
错误响应
- 认证错误：状态码
401 Unauthorized，响应内容Error Connecting to auth service ... - 缺少token：状态码
400 Bad Request，响应内容Must supply token - 不支持的格式：状态码
400 Bad Request，响应内容cannot decompress a <file extension> file
Add Globus ACL
认证后，查询AUTH获取文件路径和Globus ID文件，用于链接Globus。
- URL：
ci.kbase.us/services/staging_service/add-acl - 本地URL：
localhost:3000/add-acl - 方法：
GET - 请求头：
Authorization: <Valid Auth token>
成功响应
- **状态码
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 staging_service 镜像标签
docker pull docker.xuanyuan.run/kbase/staging_service:<标签>
DockerHub 原生拉取命令
docker pull kbase/staging_service:<标签>
更多 staging_service 镜像推荐
kbase/narrbase
kbase
KBase Narrative基础镜像，基于Jupyter Notebook构建，用于与KBase的各类工具和数据存储交互，支持科学研究中的叙事化数据分析与工作流管理。
1万+ 次下载
5 年前更新
kbase/sdkbase2
kbase
该镜像为KBase SDK仓库的基础镜像，支持Java、Python、Perl三种编程语言，用于构建和开发KBase平台相关的应用程序。
1万+ 次下载
7 年前更新
kbase/catalog
kbase
KBase Catalog是KBase平台的核心服务，负责管理应用和模块的信息、注册及发布流程，助力开发者向叙事用户展示工具。
1万+ 次下载
5 年前更新
kbase/search_api
kbase
API wrapper around Elasticsearch.
1万+ 次下载
5 年前更新
kbase/docker-collectd
kbase
这是一个容器化的CollectD镜像，用于收集主机系统和Docker容器的统计数据，基于CollectD官方贡献的Docker内容并针对KBase优化。
1万+ 次下载
6 年前更新
kbase/kb-sdk
kbase
暂无描述
1 次收藏1万+ 次下载
3 年前更新
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"