Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates a PersistentResource.

post/v1/{+parent}/persistentResources

Path parameters

parentstring required

Required. The resource name of the Location to create the PersistentResource in. Format: projects/{project}/locations/{location}

Query parameters

persistentResourceIdstring

Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are /^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/.

Request body

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.

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.

satisfiesPziboolean

Output only. Reserved for future use.

namestring

Immutable. Resource name of a PersistentResource.

satisfiesPzsboolean

Output only. Reserved for future use.

startTimestring google-datetime

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

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'].

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

Output only. The detailed state of a Study.

createTimestring google-datetime

Output only. Time when the PersistentResource was created.

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.

updateTimestring google-datetime

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

Response

Successful response