JavaScript SDK：环境变量

环境变量位于 api.apps.envs 上。每个方法都以应用 ID 作为第一个参数，并以普通的 Record<string, string> 返回应用的变量。示例使用创建客户端中的 api 客户端。appId 是你的某个应用的 ID：api.account.me() 会列出它们。

静态应用没有环境变量：每个方法都会返回 400 STATIC_APP_ENV_NOT_SUPPORTED。更改会在下一次重启时生效。

读取变量

const envs = await api.apps.envs.get(appId);

console.log(envs.NODE_ENV);

添加或更新变量

envs.set(appId, envs) 添加给定的键，并覆盖已存在的键。其他变量保持不变。它返回更改后的所有变量。

const envs = await api.apps.envs.set(appId, {
    NODE_ENV: "production",
    LOG_LEVEL: "info",
});

替换所有变量

envs.replace(appId, envs) 用给定的集合替换所有变量。不在该对象中的键会被删除。

await api.apps.envs.replace(appId, { NODE_ENV: "production" });

删除变量

envs.delete(appId, keys) 删除给定的键，并返回剩余的变量。

const remaining = await api.apps.envs.delete(appId, ["LOG_LEVEL"]);

限制和错误

状态	代码	触发条件
400	`STATIC_APP_ENV_NOT_SUPPORTED`	该应用是静态应用
400	`INVALID_ENV_CONTENT`	变量不是有效的对象（对于 `delete`，则是空列表）
400	`TOO_MANY_ENV_VARS`	结果将超过 256 个变量
400	`ENV_NAME_TOO_LONG`	某个键超过 1024 个字符
400	`ENV_CONTENT_TOO_LONG`	某个值超过 4096 个字符
400	`READ_FAILED`	集群无法读取这些变量

后续步骤

Deploys

通过 webhook 或 GitHub App 在每次 push 时部署。

环境变量 API 参考

这些方法背后的 REST 端点。

用 CLI 管理变量

在终端中完成同样的操作。

在代码中读取变量

通过 dashboard、CLI 或 API 设置变量，并在运行时读取。

CLI

VS Code

SDKs

JavaScript SDK：环境变量

读取变量

添加或更新变量

替换所有变量

删除变量

限制和错误

后续步骤

Deploys

环境变量 API 参考

用 CLI 管理变量

在代码中读取变量

​读取变量

​添加或更新变量

​替换所有变量

​删除变量

​限制和错误

​后续步骤

Deploys

环境变量 API 参考

用 CLI 管理变量

在代码中读取变量

读取变量

添加或更新变量

替换所有变量

删除变量

限制和错误

后续步骤