1. OpenAPI
Arcadia 一站式代码自动化运维平台
  • OpenAPI
    • 概述
    • File 文件系统
      • 获取文件列表
      • 获取文件内容
      • 保存文件内容
      • 删除
      • 查询属性
      • 创建
      • 移动
      • 重命名
      • 下载
      • 上传
    • Env 环境变量
      • 分页查询
      • 全局查询
      • 查询复合变量(组)的成员
      • 精准查询
      • 获取所有标签
      • 创建
      • 更新
      • 更改状态
      • 调整排序
      • 删除
    • Cron 定时任务
      • 分页查询
      • 查询
      • 创建
      • 更新
      • 删除
      • 调整排序
      • 获取标签列表
      • 查询运行中的任务
      • 运行任务
      • 终止任务
    • Exec 命令执行
      • 查询运行状态
      • 执行 Shell 命令
      • 执行 Shell 命令(Stream)
      • 运行代码文件
      • 运行代码文件(Stream)
      • 终止运行代码文件
  • 数据模型
    • Schemas
      • EnvData
      • EnvGroupData
    • EnvTagList
    • BinaryStatus
    • CronData
    • EnvCategory
    • EnvOrderBy
    • SortDirection
    • EnvsRecordBase
    • EnvsData
    • EnvsCreateData
    • EnvsUpdateData
    • EnvsGroupRecordBase
    • EnvsGroupData
    • EnvsGroupCreateData
    • EnvsGroupUpdateData
    • PageResponseBase
    • EnvPageResponse
    • EnvQueryResult
    • EnvIdOrIds
    • EnvChangeStatusRequest
    • EnvOrderRequest
    • EnvTagItem
    • EnvBatchCreateResult
    • CronTaskType
    • CronOrderBy
    • CronRecordBase
    • CronCreateRequest
    • CronUpdateRequest
    • CronPageResponse
    • CronTaskConfig
    • CronIdOrIds
    • CronOrderRequest
    • CronTagItem
    • FileType
    • FilePathList
    • FilePathOrPaths
    • FileListChildren
    • FileListResponse
    • FileInfoResponse
    • FileCreateRequest
    • FileMoveRequest
    • FileRenameRequest
    • FileDeleteRequest
    • ExecCommandRequest
    • ExecRunRequest
    • ExecStatusResponse
    • RunConfigOptions
    • RunConfigEnvs
  1. OpenAPI

概述

接口基准地址#

http://localhost:5678/api/open
服务端已开启 CORS 跨域支持

需要授权#

需要在 请求头(Header) 或 请求地址参数(URL) 中携带 api-token 字段并提供授权令牌,建议优先在请求头中携带
关于如何创建和管理该令牌请前往面板《个人设置 - 令牌管理》页面

权限控制#

令牌可以单独设置访问权限,接口会根据令牌的权限来限制访问,关于权限说明详见此处

安全的操作#

接口封装方法都经过了严格的设计以确保操作的安全性
接口会对请求传参进行严格的格式校验,一般不会响应原生错误信息

返回内容格式#

数据返回格式统一使用 JSON
名称类型描述
codenumber<0 | 1 | 4400 | 4401 | 4403 | 4404 | 4405>业务代码,详见下方
messagestring消息
typestring类型
resultboolean | object | string结果

业务代码说明#

状态码含义说明
0OK请求成功
1FAIL请求失败
4400BAD REQUEST请求的地址不存在或者包含不支持的参数
4401UNAUTHORIZED未提供授权信息
4403FORBIDDEN认证失败
4404NOT FOUND路径不存在
4405PERMISSION DENIED权限不足

编程接口#

基准地址 http://localhost:5678/api/open/extra
后端使用 Node.js 搭建,所以如果你想使用这个功能则需要会写一些 JavaScript 代码
请参考下方的简单示例
点此展开查看代码示例
下一页
获取文件列表
Built with