You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/apigee_v1.organizations.instances.html
+72Lines changed: 72 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -142,12 +142,30 @@ <h3>Method Details</h3>
142
142
"displayName": "A String", # Optional. Display name for the instance.
143
143
"host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
144
144
"ipRange": "A 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`
145
+
"isVersionLocked": True or False, # 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.
145
146
"lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
146
147
"location": "A String", # Required. Compute Engine location where the instance resides.
148
+
"maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day). # Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day).
149
+
"maintenanceChannel": "A String", # Optional. Maintenance channel to specify relative scheduling for maintenance.
150
+
"maintenanceWindows": [ # Optional. Preferred windows to perform maintenance. Currently limited to 1.
151
+
{ # MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance.
152
+
"day": "A String", # Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
153
+
"startTime": { # 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`. # Required. The start time (UTC) of the maintenance window.
154
+
"hours": 42, # 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.
155
+
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
156
+
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
157
+
"seconds": 42, # 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.
158
+
},
159
+
},
160
+
],
161
+
},
147
162
"name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
148
163
"peeringCidrRange": "A 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`.
149
164
"port": "A String", # Output only. Port number of the exposed Apigee endpoint.
150
165
"runtimeVersion": "A 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.
166
+
"scheduledMaintenance": { # Scheduled maintenance information for an instance. # 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.
167
+
"startTime": "A String", # Output only. The start time (UTC) of the scheduled maintenance.
168
+
},
151
169
"serviceAttachment": "A 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.
152
170
"state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use.
153
171
}
@@ -244,12 +262,30 @@ <h3>Method Details</h3>
244
262
"displayName": "A String", # Optional. Display name for the instance.
245
263
"host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
246
264
"ipRange": "A 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`
265
+
"isVersionLocked": True or False, # 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.
247
266
"lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
248
267
"location": "A String", # Required. Compute Engine location where the instance resides.
268
+
"maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day). # Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day).
269
+
"maintenanceChannel": "A String", # Optional. Maintenance channel to specify relative scheduling for maintenance.
270
+
"maintenanceWindows": [ # Optional. Preferred windows to perform maintenance. Currently limited to 1.
271
+
{ # MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance.
272
+
"day": "A String", # Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
273
+
"startTime": { # 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`. # Required. The start time (UTC) of the maintenance window.
274
+
"hours": 42, # 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.
275
+
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
276
+
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
277
+
"seconds": 42, # 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.
278
+
},
279
+
},
280
+
],
281
+
},
249
282
"name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
250
283
"peeringCidrRange": "A 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`.
251
284
"port": "A String", # Output only. Port number of the exposed Apigee endpoint.
252
285
"runtimeVersion": "A 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.
286
+
"scheduledMaintenance": { # Scheduled maintenance information for an instance. # 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.
287
+
"startTime": "A String", # Output only. The start time (UTC) of the scheduled maintenance.
288
+
},
253
289
"serviceAttachment": "A 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.
254
290
"state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use.
255
291
}</pre>
@@ -287,12 +323,30 @@ <h3>Method Details</h3>
287
323
"displayName": "A String", # Optional. Display name for the instance.
288
324
"host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
289
325
"ipRange": "A 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`
326
+
"isVersionLocked": True or False, # 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.
290
327
"lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
291
328
"location": "A String", # Required. Compute Engine location where the instance resides.
329
+
"maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day). # Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day).
330
+
"maintenanceChannel": "A String", # Optional. Maintenance channel to specify relative scheduling for maintenance.
331
+
"maintenanceWindows": [ # Optional. Preferred windows to perform maintenance. Currently limited to 1.
332
+
{ # MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance.
333
+
"day": "A String", # Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
334
+
"startTime": { # 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`. # Required. The start time (UTC) of the maintenance window.
335
+
"hours": 42, # 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.
336
+
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
337
+
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
338
+
"seconds": 42, # 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.
339
+
},
340
+
},
341
+
],
342
+
},
292
343
"name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
293
344
"peeringCidrRange": "A 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`.
294
345
"port": "A String", # Output only. Port number of the exposed Apigee endpoint.
295
346
"runtimeVersion": "A 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.
347
+
"scheduledMaintenance": { # Scheduled maintenance information for an instance. # 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.
348
+
"startTime": "A String", # Output only. The start time (UTC) of the scheduled maintenance.
349
+
},
296
350
"serviceAttachment": "A 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.
297
351
"state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use.
298
352
},
@@ -338,12 +392,30 @@ <h3>Method Details</h3>
338
392
"displayName": "A String", # Optional. Display name for the instance.
339
393
"host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
340
394
"ipRange": "A 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`
395
+
"isVersionLocked": True or False, # 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.
341
396
"lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
342
397
"location": "A String", # Required. Compute Engine location where the instance resides.
398
+
"maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day). # Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day).
399
+
"maintenanceChannel": "A String", # Optional. Maintenance channel to specify relative scheduling for maintenance.
400
+
"maintenanceWindows": [ # Optional. Preferred windows to perform maintenance. Currently limited to 1.
401
+
{ # MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance.
402
+
"day": "A String", # Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
403
+
"startTime": { # 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`. # Required. The start time (UTC) of the maintenance window.
404
+
"hours": 42, # 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.
405
+
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
406
+
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
407
+
"seconds": 42, # 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.
408
+
},
409
+
},
410
+
],
411
+
},
343
412
"name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
344
413
"peeringCidrRange": "A 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`.
345
414
"port": "A String", # Output only. Port number of the exposed Apigee endpoint.
346
415
"runtimeVersion": "A 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.
416
+
"scheduledMaintenance": { # Scheduled maintenance information for an instance. # 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.
417
+
"startTime": "A String", # Output only. The start time (UTC) of the scheduled maintenance.
418
+
},
347
419
"serviceAttachment": "A 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.
348
420
"state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use.
0 commit comments