本页面演示了如何使用 Python SDK 管理有效沙盒环境的生命周期。您可以列出现有沙盒、查看其详细信息,或在不再需要沙盒时将其删除。
准备工作
如需管理沙盒,您需要拥有项目的以下角色:
- Agent Platform User (
roles/aiplatform.user)
管理沙盒
您可以列出、查看与 Agent Platform 实例关联的有效沙盒环境的详细信息,以及删除这些环境。如需更改现有沙盒的配置,您必须将其删除并创建新的沙盒。
列出沙盒
如需列出与 Agent Platform 实例关联的所有沙盒,请执行以下操作:
import vertexai
client = vertexai.Client(project='<var>PROJECT_ID</var>', location='<var>LOCATION</var>')
instance_name = 'projects/PROJECT_ID/locations/LOCATION/reasoningEngines/INSTANCE_ID'
sandboxes = client.agent_engines.sandboxes.list(name=instance_name)
for sandbox in sandboxes:
print(sandbox.name)
替换以下内容:
PROJECT_ID:您的 Google Cloud 项目 ID。LOCATION:Agent Platform 实例的 Google Cloud 区域。请参阅支持的区域。INSTANCE_ID:Agent Platform 实例 ID。
查看沙盒详情
如需查看特定沙盒的配置和状态,请执行以下操作:
sandbox_name = 'projects/PROJECT_ID/locations/LOCATION/reasoningEngines/INSTANCE_ID/sandboxEnvironments/SANDBOX_ID'
sandbox = client.agent_engines.sandboxes.get(name=sandbox_name)
print(sandbox)
替换以下内容:
PROJECT_ID:您的 Google Cloud 项目 ID。LOCATION:Agent Platform 实例的 Google Cloud 区域。请参阅支持的区域。INSTANCE_ID:包含沙盒的 Agent Platform 实例 ID。SANDBOX_ID:现有沙盒 ID。
输出包括创建时间、状态(例如 STATE_RUNNING)和沙盒规范等详细信息。
删除沙盒
如需明确删除沙盒环境并释放资源,请执行以下操作:
client.agent_engines.sandboxes.delete(name=sandbox_name)
print("Sandbox deleted.")