REST Resource: organizations.instances

Resource: Instance

Apigee runtime instance.

JSON representation
{
  "name": string,
  "location": string,
  "peeringCidrRange": enum (CidrRange),
  "host": string,
  "port": string,
  "description": string,
  "displayName": string,
  "createdAt": string,
  "lastModifiedAt": string,
  "diskEncryptionKeyName": string,
  "state": enum (State),
  "runtimeVersion": string,
  "ipRange": string,
  "consumerAcceptList": [
    string
  ],
  "serviceAttachment": string
}
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.

peeringCidrRange
(deprecated)

enum (CidrRange)

Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support SLASH_16 to SLASH_20 and defaults to SLASH_16. Evaluation organizations support only SLASH_23.

host

string

Output only. Internal hostname or IP address of the 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

Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)

state

enum (State)

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

runtimeVersion

string

Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.

ipRange

string

Optional. IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation. This optional range, if provided, should be freely available as part of larger named range the customer has allocated to the Service Networking peering. If this is not provided, Apigee will automatically request for any available /22 CIDR block from Service Networking. The customer should use this CIDR block for configuring their firewall needs to allow traffic from Apigee. Input format: "a.b.c.d/22", Output format: a.b.c.d/22, e.f.g.h/28"

consumerAcceptList[]

string

Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.

serviceAttachment

string

Output only. Resource name of the service attachment created for the instance in the format: projects/*/regions/*/serviceAttachments/* Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.

CidrRange

CIDR block range that will be reserved by the instance.

Enums
CIDR_RANGE_UNSPECIFIED Range not specified.
SLASH_16 /16 CIDR range.
SLASH_17 /17 CIDR range.
SLASH_18 /18 CIDR range.
SLASH_19 /19 CIDR range.
SLASH_20 /20 CIDR range.
SLASH_22 /22 CIDR range. Supported for evaluation only.
SLASH_23 /23 CIDR range. Supported for evaluation only.

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.

patch

Updates an Apigee runtime instance.