创建或更新应用文件
在应用中创建或覆盖文件(PUT /v2/apps//files)。二进制文件请以 base64 发送内容,每个最大 10 MB,无需重启。
PUT
创建或更新应用文件
需要具有
files:write 权限范围的 API 密钥。
创建/修改文件会将 content 写入应用内正在运行的 path,如果文件不存在则创建它,存在则覆盖它。对于二进制文件,请将 content 以 base64 编码发送,并同时传入 encoding: "base64",这是推荐的格式。content 也可以是文本文件的 UTF-8 字符串、字节值数组([104, 105])或 { type: "Buffer", data: number[] } 对象。空的 content("" 或 [])会写入一个空文件。每次写入最多 10 MB,按解码后的字节计算。写入限制为每位用户每 5 秒 10 次请求。可用它进行小范围、有针对性的编辑,例如调整某个配置值或放入一个生成的文件,而无需重新上传整个应用;如需批量更改或上传 .zip,请改用提交应用。
写入 squarecloud.app 或 squarecloud.config 会被特殊处理:平台会将其解析为应用的配置(显示名称、描述、内存、autorestart、子域名)并校验每个字段,非法值会返回具体的错误代码(例如 INVALID_MEMORY 或 INVALID_SUBDOMAIN),而不会写入文件。这类配置重写的速率限制为每个用户每 15 秒 1 次请求。
在工作区共享的应用上,调用者需要具有 maintain 或 admin 角色,没有受限文件权限的成员会被阻止写入 .env 等排除路径。与其他文件管理器路由一样,此操作不会重启应用,需要新进程才能生效的更改请调用重启应用。
参数
string
必填
应用的 ID。你可以在应用控制面板的 URL 中找到它。
string
必填
文件应被创建的路径,最多 256 个字符。示例:/test.txt
string | number[]
必填
待创建文件的内容:当
encoding 为 base64 时为 base64,否则为 UTF-8 字符串或字节数组。string
当
content 是经过 base64 编码的文件时,设为 base64。推荐用于二进制文件。响应
string
指示调用是否成功。成功时为
success,否则为 error。常见错误
相关内容
- CLI:
squarecloud app file write - SDK:
api.apps.files.write()(JavaScript)、client.apps.files.write()(Python)、c.Apps.Files.Write()(Go)

