REST Resource: projects.locations.instances

Resource: Instance

A Looker instance.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "platformEdition": enum (PlatformEdition),
  "publicIpEnabled": boolean,
  "privateIpEnabled": boolean,
  "lookerVersion": string,
  "egressPublicIp": string,
  "ingressPrivateIp": string,
  "ingressPublicIp": string,
  "lookerUri": string,
  "pscEnabled": boolean,
  "pscConfig": {
    object (PscConfig)
  },
  "consumerNetwork": string,
  "reservedRange": string,
  "maintenanceWindow": {
    object (MaintenanceWindow)
  },
  "denyMaintenancePeriod": {
    object (DenyMaintenancePeriod)
  },
  "lastDenyMaintenancePeriod": {
    object (DenyMaintenancePeriod)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "userMetadata": {
    object (UserMetadata)
  },
  "customDomain": {
    object (CustomDomain)
  },
  "encryptionConfig": {
    object (EncryptionConfig)
  },
  "adminSettings": {
    object (AdminSettings)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "linkedLspProjectNumber": string,
  "fipsEnabled": boolean,
  "geminiEnabled": boolean,
  "controlledEgressConfig": {
    object (ControlledEgressConfig)
  },
  "controlledEgressEnabled": boolean,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Fields
name

string

Output only. Format: projects/{project}/locations/{location}/instances/{instance}.
createTime

string (Timestamp format)

Output only. The time when the Looker instance provisioning was first requested.

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 when the Looker 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".
state

enum (State)

Output only. The state of the instance.
platformEdition

enum (PlatformEdition)

Platform edition.
publicIpEnabled

boolean

Whether public IP is enabled on the Looker instance.
privateIpEnabled

boolean

Whether private IP is enabled on the Looker instance.
lookerVersion

string

Output only. The Looker version that the instance is using.
egressPublicIp

string

Output only. Public Egress IP (IPv4).
ingressPrivateIp

string

Output only. Private Ingress IP (IPv4).
ingressPublicIp

string

Output only. Public Ingress IP (IPv4).
lookerUri

string

Output only. Looker instance URI which can be used to access the Looker Instance UI.
pscEnabled

boolean

Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither publicIpEnabled nor privateIpEnabled can be true.
pscConfig

object (PscConfig)

Optional. PSC configuration. Used when pscEnabled is true.
consumerNetwork

string

Network name in the consumer project. Format: projects/{project}/global/networks/{network}. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance.
reservedRange

string

Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request.
maintenanceWindow

object (MaintenanceWindow)

Maintenance window for this instance.
denyMaintenancePeriod

object (DenyMaintenancePeriod)

Maintenance denial period for this instance.
lastDenyMaintenancePeriod

object (DenyMaintenancePeriod)

Output only. Last computed maintenance denial period for this instance.
maintenanceSchedule

object (MaintenanceSchedule)

Maintenance schedule for this instance.
userMetadata

object (UserMetadata)

Optional. User metadata.
customDomain

object (CustomDomain)

Custom domain configuration for the instance.
encryptionConfig

object (EncryptionConfig)

Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance.
adminSettings

object (AdminSettings)

Looker Instance Admin settings.
oauthConfig

object (OAuthConfig)

Looker instance OAuth login settings.
linkedLspProjectNumber

string (int64 format)

Optional. Linked Google Cloud Project Number for Looker Studio Pro.
fipsEnabled

boolean

Optional. Whether FIPS is enabled on the Looker instance.
geminiEnabled

boolean

Optional. Whether Gemini feature is enabled on the Looker instance or not.
controlledEgressConfig

object (ControlledEgressConfig)

Optional. Controlled egress configuration.
controlledEgressEnabled

boolean

Optional. Whether controlled egress is enabled on the Looker instance.
satisfiesPzs

boolean

Output only. Reserved for future use.
satisfiesPzi

boolean

Output only. Reserved for future use.

State

Possible states for a Looker instance.

Enums
STATE_UNSPECIFIED State is unspecified.
ACTIVE Instance is active and ready for use.
CREATING Instance provisioning is in progress.
FAILED Instance is in a failed state.
SUSPENDED Instance was suspended.
UPDATING Instance update is in progress.
DELETING Instance delete is in progress.
EXPORTING Instance is being exported.
IMPORTING Instance is importing data.

PlatformEdition

Platform editions for a Looker instance. Each edition maps to a set of instance features.

Enums
PLATFORM_EDITION_UNSPECIFIED Platform edition is unspecified.
LOOKER_CORE_TRIAL Trial.
LOOKER_CORE_STANDARD Standard.
LOOKER_CORE_STANDARD_ANNUAL Subscription Standard.
LOOKER_CORE_ENTERPRISE_ANNUAL Subscription Enterprise.
LOOKER_CORE_EMBED_ANNUAL Subscription Embed.
LOOKER_CORE_NONPROD_STANDARD_ANNUAL Nonprod Subscription Standard.
LOOKER_CORE_NONPROD_ENTERPRISE_ANNUAL Nonprod Subscription Enterprise.
LOOKER_CORE_NONPROD_EMBED_ANNUAL Nonprod Subscription Embed.
LOOKER_CORE_TRIAL_STANDARD Trial Standard.
LOOKER_CORE_TRIAL_ENTERPRISE Trial Enterprise.
LOOKER_CORE_TRIAL_EMBED Trial Embed.

PscConfig

Information for Private Service Connect (PSC) setup for a Looker instance.

JSON representation 
{
  "allowedVpcs": [
    string
  ],
  "serviceAttachments": [
    {
      object (ServiceAttachment)
    }
  ],
  "lookerServiceAttachmentUri": string
}
Fields
allowedVpcs[]

string

Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network}
serviceAttachments[]

object (ServiceAttachment)

Optional. List of egress service attachment configurations.
lookerServiceAttachmentUri

string

Output only. URI of the Looker service attachment.

ServiceAttachment

Service attachment configuration.

JSON representation 
{
  "localFqdn": string,
  "targetServiceAttachmentUri": string,
  "connectionStatus": enum (ConnectionStatus),
  "localFqdns": [
    string
  ],
  "failureReason": string
}
Fields
localFqdn

string

Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment.
targetServiceAttachmentUri

string

Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
connectionStatus

enum (ConnectionStatus)

Output only. Connection status.
localFqdns[]

string

Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment.
failureReason

string

Output only. Reason the service attachment creation failed. This value will only be populated if the service attachment encounters an issue during provisioning.

ConnectionStatus

Status of the service attachment connection. Referencing https://cloud.google.com/vpc/docs/about-accessing-vpc-hosted-services-endpoints#connection-statuses

Enums
UNKNOWN Connection status is unspecified.
ACCEPTED Connection is established and functioning normally.
PENDING Connection is not established (Looker tenant project hasn't been allowlisted).
REJECTED Connection is not established (Looker tenant project is explicitly in reject list).
NEEDS_ATTENTION Issue with target service attachment, e.g. NAT subnet is exhausted.
CLOSED Target service attachment does not exist. This status is a terminal state.

MaintenanceWindow

Specifies the recurring maintenance window.

JSON representation 
{
  "dayOfWeek": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
Fields
dayOfWeek

enum (DayOfWeek)

Required. Day of the week for this MaintenanceWindow (in UTC).
startTime

object (TimeOfDay)

Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes.

DayOfWeek

Represents a day of the week.

Enums
DAY_OF_WEEK_UNSPECIFIED The day of the week is unspecified.
MONDAY Monday
TUESDAY Tuesday
WEDNESDAY Wednesday
THURSDAY Thursday
FRIDAY Friday
SATURDAY Saturday
SUNDAY Sunday

TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

JSON representation 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Fields
hours

integer

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes

integer

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
seconds

integer

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
nanos

integer

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

DenyMaintenancePeriod

Specifies the maintenance denial period.

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "time": {
    object (TimeOfDay)
  }
}
Fields
startDate

object (Date)

Required. Start date of the deny maintenance period.
endDate

object (Date)

Required. End date of the deny maintenance period.
time

object (TimeOfDay)

Required. Time in UTC when the period starts and ends.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

  • A full date, with non-zero year, month, and day values.
  • A month and day, with a zero year (for example, an anniversary).
  • A year on its own, with a zero month and a zero day.
  • A year and month, with a zero day (for example, a credit card expiration date).

Related types:

JSON representation 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Fields
year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

MaintenanceSchedule

Published upcoming future maintenance schedule.

JSON representation 
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

The scheduled start time for the maintenance.

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".
endTime

string (Timestamp format)

The scheduled end time for the maintenance.

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".

UserMetadata

Metadata about users for a Looker instance.

JSON representation 
{
  "additionalViewerUserCount": integer,
  "additionalStandardUserCount": integer,
  "additionalDeveloperUserCount": integer
}
Fields
additionalViewerUserCount

integer

Optional. The number of additional viewer users the instance owner has purchased.
additionalStandardUserCount

integer

Optional. The number of additional standard users the instance owner has purchased.
additionalDeveloperUserCount

integer

Optional. The number of additional developer users the instance owner has purchased.

CustomDomain

Custom domain information.

JSON representation 
{
  "domain": string,
  "state": enum (CustomDomainState)
}
Fields
domain

string

Domain name.
state

enum (CustomDomainState)

Domain state.

CustomDomainState

Enum for Custom Domain State.

Enums
CUSTOM_DOMAIN_STATE_UNSPECIFIED Unspecified state.
UNVERIFIED DNS record is not created.
VERIFIED DNS record is created.
MODIFYING Calling SLM to update.
AVAILABLE ManagedCertificate is ready.
UNAVAILABLE ManagedCertificate is not ready.
UNKNOWN Status is not known.

AdminSettings

Looker instance Admin settings fields.

JSON representation 
{
  "allowedEmailDomains": [
    string
  ]
}
Fields
allowedEmailDomains[]

string

Email domain allowlist for the instance.

OAuthConfig

Looker instance OAuth login settings.

JSON representation 
{
  "clientId": string,
  "clientSecret": string
}
Fields
clientId

string

Input only. Client ID from an external OAuth application. This is an input-only field, and thus will not be set in any responses.
clientSecret

string

Input only. Client secret from an external OAuth application. This is an input-only field, and thus will not be set in any responses.

ControlledEgressConfig

Controlled egress configuration.

JSON representation 
{
  "marketplaceEnabled": boolean,
  "egressFqdns": [
    string
  ]
}
Fields
marketplaceEnabled

boolean

Optional. Whether marketplace is enabled.
egressFqdns[]

string

Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic.

Methods

create

 Creates a new Instance in a given project and location.

delete

 Delete instance.

export

 Export instance.

get

 Gets details of a single Instance.

import

 Import instance.

list

 Lists Instances in a given project and location.

patch

 Update Instance.

restart

 Restart instance.

restore

 Restore Looker instance.