REST Resource: projects.locations.instances

Resource: Instance

Represents a geographical MPC instance.

JSON representation 
{
  "name": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "etag": string,
  "state": enum (State),
  "stateMessage": string,
  "createTime": string,
  "updateTime": string,
  "uid": string,
  "url": string,
  "adminPrincipals": [
    string
  ]
}
Fields
name

string

Identifier. The resource name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}
displayName

string

Optional. A human-readable title. Can be changed.
labels

map (key: string, value: string)

Optional. Labels as key-value pairs for categorization and billing. Example: {"env": "prod", "cost_center": "treasury"}

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
etag

string

Output only. An opaque tag indicating the current version of the resource, used for concurrency control.
state

enum (State)

Output only. The current state of the instance.
stateMessage

string

Output only. A human-readable explanation of the current state, particularly useful if the instance is in a FAILED state.
createTime

string (Timestamp format)

Output only. The time at which the Instance was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time at which the Instance was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
uid

string

Output only. The unique identifier of the instance.
url

string

Output only. The data plane URL for interacting with this Instance. Example: "https://my-instance.us-central1.mpc.goog"
adminPrincipals[]

string

Required. Input only. Immutable. Principals of the initial administrators for this Instance: each entry is a Google account email address (e.g., "alice@example.com") or a BYOID (workforce/workload identity) principal (e.g., "principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{subject}"). At least 2 distinct administrators must be specified, and the authenticated caller creating the Instance must be included in this list.

State

The lifecycle state of the MPC Instance. Adheres to AIP-216 definitions.

Enums
STATE_UNSPECIFIED Not specified.
CREATING The instance is being created and provisioned.
ACTIVE The instance is fully active and ready to process policies.
UPDATING The instance is being updated.
DELETING The instance is being deleted.
FAILED The instance is in a failed state.

Methods

create

 Creates a new Instance in a given project and location.

delete

 Deletes a single Instance.

get

 Gets details of a single Instance.

list

 Lists Instances in a given project and location.

patch

 Updates the parameters of a single Instance.