projects

GET /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}

Gets a PersistentResource.

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
persistentResourcesIdstring required

Response

Successful response

createTimestring google-datetime

Output only. Time when the PersistentResource was created.

displayNamestring

Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.

labelsobject

Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

namestring

Immutable. Resource name of a PersistentResource.

networkstring

Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the resources aren't peered with any network.

reservedIpRangesstring[]

Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].

satisfiesPziboolean

Output only. Reserved for future use.

satisfiesPzsboolean

Output only. Reserved for future use.

startTimestring google-datetime

Output only. Time when the PersistentResource for the first time entered the RUNNING state.

state'STATE_UNSPECIFIED' | 'PROVISIONING' | 'RUNNING' | 'STOPPING' | 'ERROR' | 'REBOOTING' | 'UPDATING'

Output only. The detailed state of a Study.

updateTimestring google-datetime

Output only. Time when the PersistentResource was most recently updated.

Changes

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