REST Resource: organizations.instances

Resource: Instance

Apigee runtime instance.

JSON representation
{
  "name": string,
  "location": string,
  "host": string,
  "port": string,
  "description": string,
  "displayName": string,
  "createdAt": string,
  "lastModifiedAt": string,
  "diskEncryptionKeyName": string,
  "state": enum (State)
}
Fields
name

string

Required. Resource ID of the instance. Values must match the regular expression ^[a-z][a-z\-\d]{0,30}[a-z\d]$.

location

string

Required. Compute Engine location where the instance resides.

host

string

Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.

port

string

Output only. Port number of the exposed Apigee endpoint.

description

string

Optional. Description of the instance.

displayName

string

Optional. Display name for the instance.

createdAt

string (int64 format)

Output only. Time the instance was created in milliseconds since epoch.

lastModifiedAt

string (int64 format)

Output only. Time the instance was last modified in milliseconds since epoch.

diskEncryptionKeyName

string

Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.

state

enum (State)

Output only. State of the instance. Values other than ACTIVE means the resource is not ready to use.

State

State represents the current status of a resource.

Enums
STATE_UNSPECIFIED Resource is in an unspecified state.
CREATING Resource is being created.
ACTIVE Resource is provisioned and ready to use.
DELETING The resource is being deleted.

Methods

create

Creates an Apigee runtime instance.

delete

Deletes an Apigee runtime instance.

get

Gets the details for an Apigee runtime instance.

list

Lists all Apigee runtime instances for the organization.