環境変数

環境変数は client.apps.envs にあります。すべてのメソッドは第 1 引数にアプリ ID を取り、アプリの変数をプレーンな dict[str, str] として返します。

静的アプリには環境変数がありません。すべてのメソッドが 400 STATIC_APP_ENV_NOT_SUPPORTED を返します。変更は次回の再起動で反映されます。

変数の読み取り

envs = client.apps.envs.get(app_id)

print(envs.get("NODE_ENV"))

envs.set(app_id, envs) は、指定したキーを追加し、既存のキーは上書きします。その他の変数は維持されます。変更後のすべての変数を返します。

envs = client.apps.envs.set(app_id, {
    "NODE_ENV": "production",
    "LOG_LEVEL": "info",
})

envs.replace(app_id, envs) は、すべての変数を指定したセットで置き換えます。dict に含まれないキーは削除されます。{} を渡すとすべて消去されます。

client.apps.envs.replace(app_id, {"NODE_ENV": "production"})

envs.delete(app_id, keys) は指定したキーを削除し、残りの変数を返します。keys はリスト (文字列の任意のイテラブル) または単一のキーです。

remaining = client.apps.envs.delete(app_id, ["LOG_LEVEL"])

# A single key also works
remaining = client.apps.envs.delete(app_id, "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`	クラスターが変数を読み取れなかった