instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	`instances`
Type	Resource
Id	`google.apigee.instances`

Fields

The following fields are returned by SELECT queries:

organizations_instances_get
organizations_instances_list

Successful response

Name	Datatype	Description
`name`	`string`	Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
`accessLoggingConfig`	`object`	Optional. Access logging configuration enables the access logging feature at the instance. Apigee customers can enable access logging to ship the access logs to their own project's cloud logging. (id: GoogleCloudApigeeV1AccessLoggingConfig)
`consumerAcceptList`	`array`	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.
`createdAt`	`string (int64)`	Output only. Time the instance was created in milliseconds since epoch.
`description`	`string`	Optional. Description of the instance.
`diskEncryptionKeyName`	`string`	Optional. Customer Managed Encryption Key (CMEK) used for disk and volume encryption. If not specified, a Google-Managed encryption key will be used. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`
`displayName`	`string`	Optional. Display name for the instance.
`host`	`string`	Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
`ipRange`	`string`	Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`
`lastModifiedAt`	`string (int64)`	Output only. Time the instance was last modified in milliseconds since epoch.
`location`	`string`	Required. Compute Engine location where the instance resides.
`peeringCidrRange`	`string`	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`.
`port`	`string`	Output only. Port number of the exposed Apigee endpoint.
`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.
`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.
`state`	`string`	Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use.

Successful response

Name	Datatype	Description
`name`	`string`	Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
`accessLoggingConfig`	`object`	Optional. Access logging configuration enables the access logging feature at the instance. Apigee customers can enable access logging to ship the access logs to their own project's cloud logging. (id: GoogleCloudApigeeV1AccessLoggingConfig)
`consumerAcceptList`	`array`	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.
`createdAt`	`string (int64)`	Output only. Time the instance was created in milliseconds since epoch.
`description`	`string`	Optional. Description of the instance.
`diskEncryptionKeyName`	`string`	Optional. Customer Managed Encryption Key (CMEK) used for disk and volume encryption. If not specified, a Google-Managed encryption key will be used. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`
`displayName`	`string`	Optional. Display name for the instance.
`host`	`string`	Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
`ipRange`	`string`	Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`
`lastModifiedAt`	`string (int64)`	Output only. Time the instance was last modified in milliseconds since epoch.
`location`	`string`	Required. Compute Engine location where the instance resides.
`peeringCidrRange`	`string`	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`.
`port`	`string`	Output only. Port number of the exposed Apigee endpoint.
`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.
`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.
`state`	`string`	Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`organizations_instances_get`	`select`	`organizationsId`, `instancesId`		Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid.
`organizations_instances_list`	`select`	`organizationsId`	`pageSize`, `pageToken`	Lists all Apigee runtime instances for the organization. Note: Not supported for Apigee hybrid.
`organizations_instances_create`	`insert`	`organizationsId`		Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid.
`organizations_instances_patch`	`update`	`organizationsId`, `instancesId`	`updateMask`	Updates an Apigee runtime instance. You can update the fields described in NodeConfig. No other fields will be updated. Note: Not supported for Apigee hybrid.
`organizations_instances_delete`	`delete`	`organizationsId`, `instancesId`		Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. Note: Not supported for Apigee hybrid.
`organizations_instances_report_status`	`exec`	`organizationsId`, `instancesId`		Reports the latest status for a runtime instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`instancesId`	`string`
`organizationsId`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

organizations_instances_get
organizations_instances_list

Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid.

SELECT
name,
accessLoggingConfig,
consumerAcceptList,
createdAt,
description,
diskEncryptionKeyName,
displayName,
host,
ipRange,
lastModifiedAt,
location,
peeringCidrRange,
port,
runtimeVersion,
serviceAttachment,
state
FROM google.apigee.instances
WHERE organizationsId = '{{ organizationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required;

Lists all Apigee runtime instances for the organization. Note: Not supported for Apigee hybrid.

SELECT
name,
accessLoggingConfig,
consumerAcceptList,
createdAt,
description,
diskEncryptionKeyName,
displayName,
host,
ipRange,
lastModifiedAt,
location,
peeringCidrRange,
port,
runtimeVersion,
serviceAttachment,
state
FROM google.apigee.instances
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

`INSERT` examples

organizations_instances_create
Manifest

Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid.

INSERT INTO google.apigee.instances (
data__name,
data__location,
data__peeringCidrRange,
data__description,
data__displayName,
data__diskEncryptionKeyName,
data__ipRange,
data__consumerAcceptList,
data__accessLoggingConfig,
organizationsId
)
SELECT 
'{{ name }}',
'{{ location }}',
'{{ peeringCidrRange }}',
'{{ description }}',
'{{ displayName }}',
'{{ diskEncryptionKeyName }}',
'{{ ipRange }}',
'{{ consumerAcceptList }}',
'{{ accessLoggingConfig }}',
'{{ organizationsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: instances
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the instances resource.
    - name: name
      value: string
      description: >
        Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
        
    - name: location
      value: string
      description: >
        Required. Compute Engine location where the instance resides.
        
    - name: peeringCidrRange
      value: string
      description: >
        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`.
        
      valid_values: ['CIDR_RANGE_UNSPECIFIED', 'SLASH_16', 'SLASH_17', 'SLASH_18', 'SLASH_19', 'SLASH_20', 'SLASH_22', 'SLASH_23']
    - name: description
      value: string
      description: >
        Optional. Description of the instance.
        
    - name: displayName
      value: string
      description: >
        Optional. Display name for the instance.
        
    - name: diskEncryptionKeyName
      value: string
      description: >
        Optional. Customer Managed Encryption Key (CMEK) used for disk and volume encryption. If not specified, a Google-Managed encryption key will be used. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`
        
    - name: ipRange
      value: string
      description: >
        Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`
        
    - name: consumerAcceptList
      value: array
      description: >
        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.
        
    - name: accessLoggingConfig
      value: object
      description: >
        Optional. Access logging configuration enables the access logging feature at the instance. Apigee customers can enable access logging to ship the access logs to their own project's cloud logging.
        

`UPDATE` examples

organizations_instances_patch

Updates an Apigee runtime instance. You can update the fields described in NodeConfig. No other fields will be updated. Note: Not supported for Apigee hybrid.

UPDATE google.apigee.instances
SET 
data__name = '{{ name }}',
data__location = '{{ location }}',
data__peeringCidrRange = '{{ peeringCidrRange }}',
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__diskEncryptionKeyName = '{{ diskEncryptionKeyName }}',
data__ipRange = '{{ ipRange }}',
data__consumerAcceptList = '{{ consumerAcceptList }}',
data__accessLoggingConfig = '{{ accessLoggingConfig }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

organizations_instances_delete

Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. Note: Not supported for Apigee hybrid.

DELETE FROM google.apigee.instances
WHERE organizationsId = '{{ organizationsId }}' --required
AND instancesId = '{{ instancesId }}' --required;

Lifecycle Methods

organizations_instances_report_status

Reports the latest status for a runtime instance.

EXEC google.apigee.instances.organizations_instances_report_status 
@organizationsId='{{ organizationsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"instanceUid": "{{ instanceUid }}", 
"reportTime": "{{ reportTime }}", 
"resources": "{{ resources }}"
}';

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​