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/vmwareengine_v1.projects.locations.privateClouds.clusters.html
+108Lines changed: 108 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -125,6 +125,33 @@ <h3>Method Details</h3>
125
125
The object takes the form of:
126
126
127
127
{ # A cluster in a private cloud.
128
+
"autoscalingSettings": { # Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud. # Optional. Configuration of the autoscaling applied to this cluster.
129
+
"autoscalingPolicies": { # Required. The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) Currently there map must contain only one element that describes the autoscaling policy for compute nodes.
130
+
"a_key": { # Autoscaling policy describes the behavior of the autoscaling with respect to the resource utilization. The scale-out operation is initiated if the utilization exceeds ANY of the respective thresholds. The scale-in operation is initiated if the utilization is below ALL of the respective thresholds.
131
+
"consumedMemoryThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of consumed memory.
132
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
133
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
134
+
},
135
+
"cpuThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to CPU utilization.
136
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
137
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
138
+
},
139
+
"grantedMemoryThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of granted memory.
140
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
141
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
142
+
},
143
+
"nodeTypeId": "A String", # Required. The canonical identifier of the node type to add or remove. Corresponds to the `NodeType`.
144
+
"scaleOutSize": 42, # Required. Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters. During a scale-in operation only one node (or 2 for stretched clusters) are removed in a single iteration.
145
+
"storageThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of consumed storage.
146
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
147
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
148
+
},
149
+
},
150
+
},
151
+
"coolDownPeriod": "A String", # Optional. The minimum duration between consecutive autoscale operations. It starts once addition or removal of nodes is fully completed. Defaults to 30 minutes if not specified. Cool down period must be in whole minutes (for example, 30, 31, 50, 180 minutes).
152
+
"maxClusterNodeCount": 42, # Optional. Maximum number of nodes of any type in a cluster. If not specified the default limits apply.
153
+
"minClusterNodeCount": 42, # Optional. Minimum number of nodes of any type in a cluster. If not specified the default limits apply.
154
+
},
128
155
"createTime": "A String", # Output only. Creation time of this resource.
129
156
"management": True or False, # Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
130
157
"name": "A String", # Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
@@ -226,6 +253,33 @@ <h3>Method Details</h3>
226
253
An object of the form:
227
254
228
255
{ # A cluster in a private cloud.
256
+
"autoscalingSettings": { # Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud. # Optional. Configuration of the autoscaling applied to this cluster.
257
+
"autoscalingPolicies": { # Required. The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) Currently there map must contain only one element that describes the autoscaling policy for compute nodes.
258
+
"a_key": { # Autoscaling policy describes the behavior of the autoscaling with respect to the resource utilization. The scale-out operation is initiated if the utilization exceeds ANY of the respective thresholds. The scale-in operation is initiated if the utilization is below ALL of the respective thresholds.
259
+
"consumedMemoryThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of consumed memory.
260
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
261
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
262
+
},
263
+
"cpuThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to CPU utilization.
264
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
265
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
266
+
},
267
+
"grantedMemoryThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of granted memory.
268
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
269
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
270
+
},
271
+
"nodeTypeId": "A String", # Required. The canonical identifier of the node type to add or remove. Corresponds to the `NodeType`.
272
+
"scaleOutSize": 42, # Required. Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters. During a scale-in operation only one node (or 2 for stretched clusters) are removed in a single iteration.
273
+
"storageThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of consumed storage.
274
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
275
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
276
+
},
277
+
},
278
+
},
279
+
"coolDownPeriod": "A String", # Optional. The minimum duration between consecutive autoscale operations. It starts once addition or removal of nodes is fully completed. Defaults to 30 minutes if not specified. Cool down period must be in whole minutes (for example, 30, 31, 50, 180 minutes).
280
+
"maxClusterNodeCount": 42, # Optional. Maximum number of nodes of any type in a cluster. If not specified the default limits apply.
281
+
"minClusterNodeCount": 42, # Optional. Minimum number of nodes of any type in a cluster. If not specified the default limits apply.
282
+
},
229
283
"createTime": "A String", # Output only. Creation time of this resource.
230
284
"management": True or False, # Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
231
285
"name": "A String", # Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
@@ -314,6 +368,33 @@ <h3>Method Details</h3>
314
368
{ # Response message for VmwareEngine.ListClusters
315
369
"clusters": [ # A list of private cloud clusters.
316
370
{ # A cluster in a private cloud.
371
+
"autoscalingSettings": { # Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud. # Optional. Configuration of the autoscaling applied to this cluster.
372
+
"autoscalingPolicies": { # Required. The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) Currently there map must contain only one element that describes the autoscaling policy for compute nodes.
373
+
"a_key": { # Autoscaling policy describes the behavior of the autoscaling with respect to the resource utilization. The scale-out operation is initiated if the utilization exceeds ANY of the respective thresholds. The scale-in operation is initiated if the utilization is below ALL of the respective thresholds.
374
+
"consumedMemoryThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of consumed memory.
375
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
376
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
377
+
},
378
+
"cpuThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to CPU utilization.
379
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
380
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
381
+
},
382
+
"grantedMemoryThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of granted memory.
383
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
384
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
385
+
},
386
+
"nodeTypeId": "A String", # Required. The canonical identifier of the node type to add or remove. Corresponds to the `NodeType`.
387
+
"scaleOutSize": 42, # Required. Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters. During a scale-in operation only one node (or 2 for stretched clusters) are removed in a single iteration.
388
+
"storageThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of consumed storage.
389
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
390
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
391
+
},
392
+
},
393
+
},
394
+
"coolDownPeriod": "A String", # Optional. The minimum duration between consecutive autoscale operations. It starts once addition or removal of nodes is fully completed. Defaults to 30 minutes if not specified. Cool down period must be in whole minutes (for example, 30, 31, 50, 180 minutes).
395
+
"maxClusterNodeCount": 42, # Optional. Maximum number of nodes of any type in a cluster. If not specified the default limits apply.
396
+
"minClusterNodeCount": 42, # Optional. Minimum number of nodes of any type in a cluster. If not specified the default limits apply.
397
+
},
317
398
"createTime": "A String", # Output only. Creation time of this resource.
318
399
"management": True or False, # Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
319
400
"name": "A String", # Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
@@ -363,6 +444,33 @@ <h3>Method Details</h3>
363
444
The object takes the form of:
364
445
365
446
{ # A cluster in a private cloud.
447
+
"autoscalingSettings": { # Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud. # Optional. Configuration of the autoscaling applied to this cluster.
448
+
"autoscalingPolicies": { # Required. The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) Currently there map must contain only one element that describes the autoscaling policy for compute nodes.
449
+
"a_key": { # Autoscaling policy describes the behavior of the autoscaling with respect to the resource utilization. The scale-out operation is initiated if the utilization exceeds ANY of the respective thresholds. The scale-in operation is initiated if the utilization is below ALL of the respective thresholds.
450
+
"consumedMemoryThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of consumed memory.
451
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
452
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
453
+
},
454
+
"cpuThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to CPU utilization.
455
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
456
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
457
+
},
458
+
"grantedMemoryThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of granted memory.
459
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
460
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
461
+
},
462
+
"nodeTypeId": "A String", # Required. The canonical identifier of the node type to add or remove. Corresponds to the `NodeType`.
463
+
"scaleOutSize": 42, # Required. Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters. During a scale-in operation only one node (or 2 for stretched clusters) are removed in a single iteration.
464
+
"storageThresholds": { # Thresholds define the utilization of resources triggering scale-out and scale-in operations. # Optional. Utilization thresholds pertaining to amount of consumed storage.
465
+
"scaleIn": 42, # Required. The utilization triggering the scale-in operation in percent.
466
+
"scaleOut": 42, # Required. The utilization triggering the scale-out operation in percent.
467
+
},
468
+
},
469
+
},
470
+
"coolDownPeriod": "A String", # Optional. The minimum duration between consecutive autoscale operations. It starts once addition or removal of nodes is fully completed. Defaults to 30 minutes if not specified. Cool down period must be in whole minutes (for example, 30, 31, 50, 180 minutes).
471
+
"maxClusterNodeCount": 42, # Optional. Maximum number of nodes of any type in a cluster. If not specified the default limits apply.
472
+
"minClusterNodeCount": 42, # Optional. Minimum number of nodes of any type in a cluster. If not specified the default limits apply.
473
+
},
366
474
"createTime": "A String", # Output only. Creation time of this resource.
367
475
"management": True or False, # Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
368
476
"name": "A String", # Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
0 commit comments