Environment スキーマ

Environment オブジェクト

create、get、list、update、archive エンドポイントで返却されます。

フィールド	型	説明
`id`	string	`env_` プレフィックス付きの Environment ID
`type`	string	固定値 `"environment"`
`name`	string	Environment 名
`description`	string	Environment の説明
`config`	Environment 設定	Environment の設定
`metadata`	object	メタデータオブジェクト。デフォルトは `{}`
`status`	string	Environment のステータス。有効な値: `ready`、`archived`
`archived`	boolean	Environment がアーカイブ済みかどうか
`archived_at`	string \| null	UTC でのアーカイブ時刻、未アーカイブの場合は `null`
`created_at`	string	UTC での作成時刻
`updated_at`	string	UTC での最終更新時刻

フィールド	型	必須	説明
`type`	string	はい	`"cloud"` でなければなりません
`networking`	Environment ネットワーク	いいえ	ネットワークアクセス設定
`packages`	Environment パッケージ	いいえ	Session のサンドボックス準備時にインストールする依存関係

packages はサポートされるパッケージマネージャーをキーとし、パッケージ指定文字列の配列を値とするマップです。サポートされるキーは apt、pip、npm です。それ以外のキーは現在の環境準備フローではインストールされません。

キー	型	説明	例
`apt`	string の配列	`apt-get install -y` でインストールされる Debian/Ubuntu システムパッケージ	`["git", "curl", "build-essential"]`
`pip`	string の配列	`pip install` でインストールされる Python パッケージ	`["pandas", "PyYAML==6.0.1"]`
`npm`	string の配列	`npm install -g` でグローバルにインストールされる Node.js パッケージ	`["typescript@5.0.0", "eslint"]`

パッケージのインストールは Session のサンドボックス準備時に実行されます。無効なパッケージ名や利用できないバージョンを指定すると、環境設定エラーで Session が失敗する場合があります。

フィールド	型	必須	説明
`type`	string	はい	有効な値: `limited`、`unrestricted`

Agent が動作するコンテナ、ネットワーク、依存関係を選択する。