环境变量
本章将介绍
makers.projects 上的环境变量列出、写入和删除方法。环境变量作用于整个项目，不按生产环境与预览环境拆分。
deployments.deploy 不接受环境变量，创建项目时可以通过 initialEnvVars/initial_env_vars 一并写入。数据模型
projects.listEnvs / projects.list_envs 返回环境变量对象。projects.setEnvs / projects.set_envs 与 projects.deleteEnvs / projects.delete_envs 无返回值。字段 | 类型 | 必有 | 说明 |
key | string/str | 是 | 变量名 |
value | string/str | 是 | 变量值 |
comment | string/str | 否 | 备注 |
projects.listEnvs / projects.list_envs
列出项目的全部环境变量。
参数
参数 | 类型 | 必填 | 说明 |
projectId/project_id | string/str | 是 | 项目 ID |
返回值
Promise<EnvVar[]>/list[dict]
示例
const envVars = await makers.projects.listEnvs({projectId: "your-project-id",});for (const envVar of envVars) {console.log(envVar.key, envVar.comment);}
env_vars = makers.projects.list_envs(project_id="your-project-id")for env_var in env_vars:print(env_var["key"], env_var.get("comment"))
projects.setEnvs / projects.set_envs
已存在的变量名会被覆盖，未传入的变量名保持原值。同一批参数中出现重复变量名时，在发请求前抛出
ValidationError。参数
参数 | 类型 | 必填 | 说明 |
projectId/project_id | string/str | 是 | 项目 ID |
envVars/env_vars | EnvVar[]/list[dict] | 是 | 要写入的变量，按变量名覆盖或新增 |
返回值
Promise<void>/None
示例
await makers.projects.setEnvs({projectId: "your-project-id",envVars: [{ key: "API_URL", value: "https://example.com", comment: "origin" },],});
makers.projects.set_envs(project_id="your-project-id",env_vars=[{"key": "API_URL","value": "https://example.com","comment": "origin",},],)
projects.deleteEnvs / projects.delete_envs
keys 中出现重复项时，在发请求前抛出 ValidationError。参数
参数 | 类型 | 必填 | 说明 |
projectId/project_id | string/str | 是 | 项目 ID |
keys | string[]/list[str] | 是 | 要删除的变量名 |
返回值
Promise<void>/None
示例
await makers.projects.deleteEnvs({projectId: "your-project-id",keys: ["API_URL"],});
makers.projects.delete_envs(project_id="your-project-id",keys=["API_URL"],)