REST Resource: projects.locations.instances

Stay organized with collections Save and categorize content based on your preferences.

Resource: Instance

An Instance represents the instance resources of the Registry. Currently, only one instance is allowed for each project.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "stateMessage": string,
  "config": {
    object (Config)
  }
}
Fields
name

string

Format: projects/*/locations/*/instance. Currently only locations/global is supported.

createTime

string (Timestamp format)

Output only. Creation timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Last update timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Output only. The current state of the Instance.

stateMessage

string

Output only. Extra information of Instance.State if the state is FAILED.

config

object (Config)

Required. Config of the Instance.

State

State of the Instance.

Enums
STATE_UNSPECIFIED The default value. This value is used if the state is omitted.
INACTIVE The Instance has not been initialized or has been deleted.
CREATING The Instance is being created.
ACTIVE The Instance has been created and is ready for use.
UPDATING The Instance is being updated.
DELETING The Instance is being deleted.
FAILED The Instance encountered an error during a state change.

Config

Available configurations to provision an Instance.

JSON representation
{
  "location": string,
  "cmekKeyName": string
}
Fields
location

string

Output only. The GCP location where the Instance resides.

cmekKeyName

string

Required. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.

Methods

create

Provisions instance resources for the Registry.

delete

Deletes the Registry instance.

get

Gets details of a single Instance.

getIamPolicy

Gets the access control policy for a resource.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.