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/spanner_v1.projects.instances.html
+48Lines changed: 48 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -151,6 +151,18 @@ <h3>Method Details</h3>
151
151
152
152
{ # The request for CreateInstance.
153
153
"instance": { # An isolated set of Cloud Spanner resources on which databases can be hosted. # Required. The instance to create. The name may be omitted, but if specified must be `/instances/`.
154
+
"autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
155
+
"autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance.
156
+
"maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes.
157
+
"maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.
158
+
"minNodes": 42, # Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.
159
+
"minProcessingUnits": 42, # Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.
160
+
},
161
+
"autoscalingTargets": { # The autoscaling targets for an instance. # Required. The autoscaling targets for an instance.
162
+
"highPriorityCpuUtilizationPercent": 42, # Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive.
163
+
"storageUtilizationPercent": 42, # Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 100] inclusive.
164
+
},
165
+
},
154
166
"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
155
167
"createTime": "A String", # Output only. The time at which the instance was created.
156
168
"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
@@ -238,6 +250,18 @@ <h3>Method Details</h3>
238
250
An object of the form:
239
251
240
252
{ # An isolated set of Cloud Spanner resources on which databases can be hosted.
253
+
"autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
254
+
"autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance.
255
+
"maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes.
256
+
"maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.
257
+
"minNodes": 42, # Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.
258
+
"minProcessingUnits": 42, # Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.
259
+
},
260
+
"autoscalingTargets": { # The autoscaling targets for an instance. # Required. The autoscaling targets for an instance.
261
+
"highPriorityCpuUtilizationPercent": 42, # Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive.
262
+
"storageUtilizationPercent": 42, # Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 100] inclusive.
263
+
},
264
+
},
241
265
"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
242
266
"createTime": "A String", # Output only. The time at which the instance was created.
243
267
"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
@@ -325,6 +349,18 @@ <h3>Method Details</h3>
325
349
{ # The response for ListInstances.
326
350
"instances": [ # The list of requested instances.
327
351
{ # An isolated set of Cloud Spanner resources on which databases can be hosted.
352
+
"autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
353
+
"autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance.
354
+
"maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes.
355
+
"maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.
356
+
"minNodes": 42, # Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.
357
+
"minProcessingUnits": 42, # Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.
358
+
},
359
+
"autoscalingTargets": { # The autoscaling targets for an instance. # Required. The autoscaling targets for an instance.
360
+
"highPriorityCpuUtilizationPercent": 42, # Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive.
361
+
"storageUtilizationPercent": 42, # Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 100] inclusive.
362
+
},
363
+
},
328
364
"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
329
365
"createTime": "A String", # Output only. The time at which the instance was created.
330
366
"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
@@ -380,6 +416,18 @@ <h3>Method Details</h3>
380
416
{ # The request for UpdateInstance.
381
417
"fieldMask": "A String", # Required. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them.
382
418
"instance": { # An isolated set of Cloud Spanner resources on which databases can be hosted. # Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included.
419
+
"autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
420
+
"autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance.
421
+
"maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes.
422
+
"maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.
423
+
"minNodes": 42, # Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.
424
+
"minProcessingUnits": 42, # Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.
425
+
},
426
+
"autoscalingTargets": { # The autoscaling targets for an instance. # Required. The autoscaling targets for an instance.
427
+
"highPriorityCpuUtilizationPercent": 42, # Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive.
428
+
"storageUtilizationPercent": 42, # Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 100] inclusive.
429
+
},
430
+
},
383
431
"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
384
432
"createTime": "A String", # Output only. The time at which the instance was created.
385
433
"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
Copy file name to clipboardExpand all lines: googleapiclient/discovery_cache/documents/spanner.v1.json
+63Lines changed: 63 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -2604,6 +2604,65 @@
2604
2604
"revision": "20231017",
2605
2605
"rootUrl": "https://spanner.googleapis.com/",
2606
2606
"schemas": {
2607
+
"AutoscalingConfig": {
2608
+
"description": "Autoscaling config for an instance.",
2609
+
"id": "AutoscalingConfig",
2610
+
"properties": {
2611
+
"autoscalingLimits": {
2612
+
"$ref": "AutoscalingLimits",
2613
+
"description": "Required. Autoscaling limits for an instance."
2614
+
},
2615
+
"autoscalingTargets": {
2616
+
"$ref": "AutoscalingTargets",
2617
+
"description": "Required. The autoscaling targets for an instance."
2618
+
}
2619
+
},
2620
+
"type": "object"
2621
+
},
2622
+
"AutoscalingLimits": {
2623
+
"description": "The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.",
2624
+
"id": "AutoscalingLimits",
2625
+
"properties": {
2626
+
"maxNodes": {
2627
+
"description": "Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes.",
2628
+
"format": "int32",
2629
+
"type": "integer"
2630
+
},
2631
+
"maxProcessingUnits": {
2632
+
"description": "Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.",
2633
+
"format": "int32",
2634
+
"type": "integer"
2635
+
},
2636
+
"minNodes": {
2637
+
"description": "Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.",
2638
+
"format": "int32",
2639
+
"type": "integer"
2640
+
},
2641
+
"minProcessingUnits": {
2642
+
"description": "Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.",
2643
+
"format": "int32",
2644
+
"type": "integer"
2645
+
}
2646
+
},
2647
+
"type": "object"
2648
+
},
2649
+
"AutoscalingTargets": {
2650
+
"description": "The autoscaling targets for an instance.",
2651
+
"id": "AutoscalingTargets",
2652
+
"properties": {
2653
+
"highPriorityCpuUtilizationPercent": {
2654
+
"description": "Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive.",
2655
+
"format": "int32",
2656
+
"type": "integer"
2657
+
},
2658
+
"storageUtilizationPercent": {
2659
+
"description": "Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 100] inclusive.",
2660
+
"format": "int32",
2661
+
"type": "integer"
2662
+
}
2663
+
},
2664
+
"type": "object"
2665
+
},
2607
2666
"Backup": {
2608
2667
"description": "A backup of a Cloud Spanner database.",
2609
2668
"id": "Backup",
@@ -3717,6 +3776,10 @@
3717
3776
"description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
3718
3777
"id": "Instance",
3719
3778
"properties": {
3779
+
"autoscalingConfig": {
3780
+
"$ref": "AutoscalingConfig",
3781
+
"description": "Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance."
3782
+
},
3720
3783
"config": {
3721
3784
"description": "Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.",
0 commit comments