Console
    Contact Us Start free

    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 
 , 
 "accessLoggingConfig" 
 : 
 { 
 object (  AccessLoggingConfig 
 
) 
 } 
 , 
 "scheduledMaintenance" 
 : 
 { 
 object (  ScheduledMaintenance 
 
) 
 } 
 , 
 "maintenanceUpdatePolicy" 
 : 
 { 
 object (  MaintenanceUpdatePolicy 
 
) 
 } 
 , 
 "isVersionLocked" 
 : 
 boolean 
 }
    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

    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/([^/]+)

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

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

    object ( AccessLoggingConfig )

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

    object ( ScheduledMaintenance )

    Output only. Time and date of the scheduled maintenance for this instance. This field is only populated for instances that have opted into Maintenance Window and if there is an upcoming maintenance. Cleared once the maintenance is complete.
    maintenanceUpdatePolicy

    object ( MaintenanceUpdatePolicy )

    Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day).
    isVersionLocked

    boolean

    Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances.

    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.

    AccessLoggingConfig

    Access logging configuration enables customers to ship the access logs from the tenant projects to their own project's cloud logging. The feature is at the instance level ad disabled by default. It can be enabled during instances.create or instances.patch.

    JSON representation 
     { 
 "enabled" 
 : 
 boolean 
 , 
 "filter" 
 : 
 string 
 }
    Fields
    enabled

    boolean

    Optional. Boolean flag that specifies whether the customer access log feature is enabled.
    filter

    string

    Optional. Ship the access log entries that match the statusCode defined in the filter. The statusCode is the only expected/supported filter field. (Ex: statusCode) The filter will parse it to the Common Expression Language semantics for expression evaluation to build the filter condition. (Ex: "filter": statusCode >= 200 && statusCode < 300 )

    ScheduledMaintenance

    Scheduled maintenance information for an instance.

    JSON representation 
     { 
 "startTime" 
 : 
 string 
 }
    Fields
    startTime

    string ( Timestamp format)

    Output only. The start time (UTC) of the scheduled 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" .

    MaintenanceUpdatePolicy

    MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day).

    JSON representation 
     { 
 "maintenanceWindows" 
 : 
 [ 
 { 
 object (  MaintenanceWindow 
 
) 
 } 
 ] 
 , 
 "maintenanceChannel" 
 : 
 enum (  MaintenanceChannel 
 
) 
 }
    Fields
    maintenanceWindows[]

    object ( MaintenanceWindow )

    Optional. Preferred windows to perform maintenance. Currently limited to 1.
    maintenanceChannel

    enum ( MaintenanceChannel )

    Optional. Maintenance channel to specify relative scheduling for maintenance.

    MaintenanceWindow

    MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance.

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

    enum ( DayOfWeek )

    Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
    startTime

    object ( TimeOfDay )

    Required. The start time (UTC) of the maintenance window.

    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.

    MaintenanceChannel

    MaintenanceChannel specifies the relative scheduling for maintenance.

    Enums
    MAINTENANCE_CHANNEL_UNSPECIFIED Unspecified maintenance channel.
    WEEK1 Receive 1 weeks notice before maintenance occurs
    WEEK2 Receive 2 weeks notice before maintenance occurs

    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.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: