替换全部环境变量
替换应用的全部环境变量(PUT /v2/apps/:app_id/envs):请求体中没有的变量会被删除,传入空的 envs 对象会清空所有变量。
PUT
替换全部环境变量
需要具有
envs:write 权限范围的 API 密钥。
Overwrite 会将应用的整个环境替换为你发送的变量:任何已设置但未包含在请求体中的变量都会被删除。发送一个空的 envs 对象会清空所有变量,因此该端点适用于完全重置,而不是增量更改。
与其他环境变量端点相同的限制在此同样适用:每个应用最多 256 个变量,键最长 1024 个字符,值最长 4096 个字符。静态应用不受支持,会返回错误;在工作区共享的应用上,调用者需要具有 admin 角色或为所有者。
你的应用通过 shell 加载变量,因此包含空格或 shell 特殊字符(例如 & 或 ;)的值会像控制面板一样用单引号括起来存储,并按此形式返回;你已经加了引号的值会按发送时的样子保留。对其他变量的引用($HOST、${HOST},单独使用或放在双引号内)仍然有效,而命令替换($(...) 或反引号)始终按纯文本存储。名称由字母、数字、下划线、点和连字符组成,且不能以数字开头。由于会发送整个变量集,已经以无效名称(含空格或以数字开头)存储的变量会让请求返回 INVALID_ENV_CONTENT:请在请求中为它改名。
如果你只需更改少数几个变量而不影响其余变量,请改用添加/编辑变量,或使用移除变量删除特定的键。
参数
string
必填
应用程序 ID。
object
你希望在环境中设置的键和值变量。
响应
string
指示调用是否成功。成功时为
success,否则为 error。object
你定义的所有环境变量的键和值。
常见错误
相关内容
- CLI:
squarecloud app env replace - SDK:
api.apps.envs.replace()(JavaScript)、client.apps.envs.replace()(Python)、c.Apps.Envs.Replace()(Go)

