GOgoogle
projects

POST /v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments

Creates a SandboxEnvironment in a given reasoning engine.

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required
reasoningEnginesIdstring required

Request body

createTimestring google-datetime

Output only. The timestamp when this SandboxEnvironment was created.

displayNamestring

Required. The display name of the SandboxEnvironment.

expireTimestring google-datetime

Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is always provided on output, regardless of what expiration was sent on input.

latestSandboxEnvironmentSnapshotstring

Output only. The resource name of the latest snapshot taken for this SandboxEnvironment.

namestring

Identifier. The name of the SandboxEnvironment.

ownerstring

Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner.

sandboxEnvironmentSnapshotstring

Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}

sandboxEnvironmentTemplatestring

Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from.

state'STATE_UNSPECIFIED' | 'STATE_PROVISIONING' | 'STATE_RUNNING' | 'STATE_DEPROVISIONING' | 'STATE_TERMINATED' | 'STATE_DELETED' | 'STATE_PAUSED' | 'STATE_PAUSING' | 'STATE_RESUMING' | 'STATE_STOPPING'

Output only. The runtime state of the SandboxEnvironment.

ttlstring google-duration

Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.

updateTimestring google-datetime

Output only. The timestamp when this SandboxEnvironment was most recently updated.

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes

No recorded changes to this operation across all 8 revisions of this API.