1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="alloydb_v1beta.html">AlloyDB API</a> . <a href="alloydb_v1beta.projects.html">projects</a> . <a href="alloydb_v1beta.projects.locations.html">locations</a> . <a href="alloydb_v1beta.projects.locations.clusters.html">clusters</a> . <a href="alloydb_v1beta.projects.locations.clusters.instances.html">instances</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, instanceId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Instance in a given project and location.</p>
<p class="toc_element">
<code><a href="#createsecondary">createsecondary(parent, body=None, instanceId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new SECONDARY Instance in a given project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Instance.</p>
<p class="toc_element">
<code><a href="#failover">failover(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.</p>
<p class="toc_element">
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Instance.</p>
<p class="toc_element">
<code><a href="#getConnectionInfo">getConnectionInfo(parent, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get instance metadata used for a connection.</p>
<p class="toc_element">
<code><a href="#injectFault">injectFault(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Injects fault in an instance. Imperative only.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Instances in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single Instance.</p>
<p class="toc_element">
<code><a href="#restart">restart(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restart an Instance in a cluster. Imperative only.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, instanceId=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Creates a new Instance in a given project and location.
Args:
parent: string, Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. (required)
body: object, The request body.
The object takes the form of:
{ # An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
"activationPolicy": "A String", # Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"availabilityType": "A String", # Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
"clientConnectionConfig": { # Client connection configuration # Optional. Client connection specific configurations
"requireConnectors": True or False, # Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
"sslConfig": { # SSL configuration. # Optional. SSL configuration option for this instance.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
},
"connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP).
"defaultPoolSize": "A String", # Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.
"enable": True or False, # Optional. Deprecated; Prefer 'enabled' as this will be removed soon.
"enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP).
"flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs.
"a_key": "A String",
},
"ignoreStartupParameters": [ # Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"] Note: This field should not be added to client libraries if not present already.
"A String",
],
"maxClientConn": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.
"maxPreparedStatements": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.
"minPoolSize": "A String", # Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.
"poolMode": "A String", # Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.
"poolerCount": 42, # Output only. The number of running poolers per instance.
"queryWaitTimeout": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
"serverIdleTimeout": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
"statsUsers": [ # Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
"a_key": "A String",
},
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Instance.
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"gcaConfig": { # Instance level configuration parameters related to the Gemini Cloud Assist product. # Output only. Configuration parameters related to Gemini Cloud Assist.
"gcaEntitlement": "A String", # Output only. Represents the GCA entitlement state of the instance.
},
"gceZone": "A String", # The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
"geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future.
"entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future.
},
"instanceType": "A String", # Required. The type of the instance. Specified at creation time.
"ipAddress": "A String", # Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configurations for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
"machineType": "A String", # Machine type of the VM instance. E.g. "n2-highmem-4", "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the number of vCPUs in the machine type.
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
"allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
},
],
"enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
"enablePublicIp": True or False, # Optional. Enabling public ip for the instance.
"network": "A String", # Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number}/global/networks/{network_id}`.
},
"nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations.
"id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
},
],
"observabilityConfig": { # Observability Instance specific configuration. # Configuration for observability.
"assistiveExperiencesEnabled": True or False, # Whether assistive experiences are enabled for this AlloyDB instance.
"enabled": True or False, # Observability feature status for an instance. This flag is turned "off" by default.
"maxQueryStringLength": 42, # Query string length. The default value is 10k.
"preserveComments": True or False, # Preserve comments in query string for an instance. This flag is turned "off" by default.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default.
"trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default.
"trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off".
"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API.
"trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.
},
"outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance.
"A String",
],
"pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance.
"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
"A String",
],
"pscAutoConnections": [ # Optional. Configurations for setting up PSC service automation.
{ # Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.
"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project.
"consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.
"consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created.
"ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint.
"status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion.
},
],
"pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
"pscInterfaceConfigs": [ # Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface.
{ # Configuration for setting up a PSC interface to enable outbound connectivity.
"networkAttachmentResource": "A String", # The network attachment resource created in the consumer network to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.
},
],
"serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
},
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
"queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
"queryStringLength": 42, # Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default.
"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
},
"readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
"nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The current serving state of the instance.
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updatePolicy": { # Policy to be used while updating the instance. # Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
"mode": "A String", # Mode for updating the instance.
},
"updateTime": "A String", # Output only. Update time stamp
"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only.
"id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
},
}
instanceId: string, Required. ID of the requesting object.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="createsecondary">createsecondary(parent, body=None, instanceId=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Creates a new SECONDARY Instance in a given project and location.
Args:
parent: string, Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. (required)
body: object, The request body.
The object takes the form of:
{ # An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
"activationPolicy": "A String", # Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"availabilityType": "A String", # Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
"clientConnectionConfig": { # Client connection configuration # Optional. Client connection specific configurations
"requireConnectors": True or False, # Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
"sslConfig": { # SSL configuration. # Optional. SSL configuration option for this instance.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
},
"connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP).
"defaultPoolSize": "A String", # Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.
"enable": True or False, # Optional. Deprecated; Prefer 'enabled' as this will be removed soon.
"enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP).
"flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs.
"a_key": "A String",
},
"ignoreStartupParameters": [ # Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"] Note: This field should not be added to client libraries if not present already.
"A String",
],
"maxClientConn": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.
"maxPreparedStatements": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.
"minPoolSize": "A String", # Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.
"poolMode": "A String", # Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.
"poolerCount": 42, # Output only. The number of running poolers per instance.
"queryWaitTimeout": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
"serverIdleTimeout": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
"statsUsers": [ # Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
"a_key": "A String",
},
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Instance.
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"gcaConfig": { # Instance level configuration parameters related to the Gemini Cloud Assist product. # Output only. Configuration parameters related to Gemini Cloud Assist.
"gcaEntitlement": "A String", # Output only. Represents the GCA entitlement state of the instance.
},
"gceZone": "A String", # The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
"geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future.
"entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future.
},
"instanceType": "A String", # Required. The type of the instance. Specified at creation time.
"ipAddress": "A String", # Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configurations for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
"machineType": "A String", # Machine type of the VM instance. E.g. "n2-highmem-4", "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the number of vCPUs in the machine type.
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
"allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
},
],
"enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
"enablePublicIp": True or False, # Optional. Enabling public ip for the instance.
"network": "A String", # Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number}/global/networks/{network_id}`.
},
"nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations.
"id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
},
],
"observabilityConfig": { # Observability Instance specific configuration. # Configuration for observability.
"assistiveExperiencesEnabled": True or False, # Whether assistive experiences are enabled for this AlloyDB instance.
"enabled": True or False, # Observability feature status for an instance. This flag is turned "off" by default.
"maxQueryStringLength": 42, # Query string length. The default value is 10k.
"preserveComments": True or False, # Preserve comments in query string for an instance. This flag is turned "off" by default.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default.
"trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default.
"trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off".
"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API.
"trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.
},
"outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance.
"A String",
],
"pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance.
"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
"A String",
],
"pscAutoConnections": [ # Optional. Configurations for setting up PSC service automation.
{ # Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.
"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project.
"consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.
"consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created.
"ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint.
"status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion.
},
],
"pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
"pscInterfaceConfigs": [ # Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface.
{ # Configuration for setting up a PSC interface to enable outbound connectivity.
"networkAttachmentResource": "A String", # The network attachment resource created in the consumer network to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.
},
],
"serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
},
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
"queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
"queryStringLength": 42, # Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default.
"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
},
"readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
"nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The current serving state of the instance.
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updatePolicy": { # Policy to be used while updating the instance. # Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
"mode": "A String", # Mode for updating the instance.
},
"updateTime": "A String", # Output only. Update time stamp
"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only.
"id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
},
}
instanceId: string, Required. ID of the requesting object.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Deletes a single Instance.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Instance.name field. (required)
etag: string, Optional. The current etag of the Instance. If an etag is provided and does not match the current etag of the Instance, deletion will be blocked and an ABORTED error will be returned.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="failover">failover(name, body=None, x__xgafv=None)</code>
<pre>Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Instance.name field. (required)
body: object, The request body.
The object takes the form of:
{ # Message for triggering failover on an Instance
"requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
"validateOnly": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
<pre>Gets details of a single Instance.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Instance.name field. (required)
view: string, The view of the instance to return.
Allowed values
INSTANCE_VIEW_UNSPECIFIED - INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
INSTANCE_VIEW_BASIC - BASIC server responses for a primary or read instance include all the relevant instance details, excluding the details of each node in the instance. The default value.
INSTANCE_VIEW_FULL - FULL response is equivalent to BASIC for primary instance (for now). For read pool instance, this includes details of each node in the pool.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
"activationPolicy": "A String", # Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"availabilityType": "A String", # Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
"clientConnectionConfig": { # Client connection configuration # Optional. Client connection specific configurations
"requireConnectors": True or False, # Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
"sslConfig": { # SSL configuration. # Optional. SSL configuration option for this instance.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
},
"connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP).
"defaultPoolSize": "A String", # Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.
"enable": True or False, # Optional. Deprecated; Prefer 'enabled' as this will be removed soon.
"enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP).
"flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs.
"a_key": "A String",
},
"ignoreStartupParameters": [ # Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"] Note: This field should not be added to client libraries if not present already.
"A String",
],
"maxClientConn": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.
"maxPreparedStatements": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.
"minPoolSize": "A String", # Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.
"poolMode": "A String", # Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.
"poolerCount": 42, # Output only. The number of running poolers per instance.
"queryWaitTimeout": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
"serverIdleTimeout": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
"statsUsers": [ # Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
"a_key": "A String",
},
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Instance.
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"gcaConfig": { # Instance level configuration parameters related to the Gemini Cloud Assist product. # Output only. Configuration parameters related to Gemini Cloud Assist.
"gcaEntitlement": "A String", # Output only. Represents the GCA entitlement state of the instance.
},
"gceZone": "A String", # The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
"geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future.
"entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future.
},
"instanceType": "A String", # Required. The type of the instance. Specified at creation time.
"ipAddress": "A String", # Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configurations for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
"machineType": "A String", # Machine type of the VM instance. E.g. "n2-highmem-4", "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the number of vCPUs in the machine type.
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
"allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
},
],
"enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
"enablePublicIp": True or False, # Optional. Enabling public ip for the instance.
"network": "A String", # Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number}/global/networks/{network_id}`.
},
"nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations.
"id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
},
],
"observabilityConfig": { # Observability Instance specific configuration. # Configuration for observability.
"assistiveExperiencesEnabled": True or False, # Whether assistive experiences are enabled for this AlloyDB instance.
"enabled": True or False, # Observability feature status for an instance. This flag is turned "off" by default.
"maxQueryStringLength": 42, # Query string length. The default value is 10k.
"preserveComments": True or False, # Preserve comments in query string for an instance. This flag is turned "off" by default.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default.
"trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default.
"trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off".
"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API.
"trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.
},
"outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance.
"A String",
],
"pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance.
"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
"A String",
],
"pscAutoConnections": [ # Optional. Configurations for setting up PSC service automation.
{ # Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.
"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project.
"consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.
"consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created.
"ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint.
"status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion.
},
],
"pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
"pscInterfaceConfigs": [ # Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface.
{ # Configuration for setting up a PSC interface to enable outbound connectivity.
"networkAttachmentResource": "A String", # The network attachment resource created in the consumer network to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.
},
],
"serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
},
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
"queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
"queryStringLength": 42, # Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default.
"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
},
"readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
"nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The current serving state of the instance.
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updatePolicy": { # Policy to be used while updating the instance. # Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
"mode": "A String", # Mode for updating the instance.
},
"updateTime": "A String", # Output only. Update time stamp
"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only.
"id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
},
}</pre>
</div>
<div class="method">
<code class="details" id="getConnectionInfo">getConnectionInfo(parent, requestId=None, x__xgafv=None)</code>
<pre>Get instance metadata used for a connection.
Args:
parent: string, Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance} (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ConnectionInfo singleton resource. https://google.aip.dev/156
"instanceUid": "A String", # Output only. The unique ID of the Instance.
"ipAddress": "A String", # Output only. The private network IP address for the Instance. This is the default IP for the instance and is always created (even if enable_public_ip is set). This is the connection endpoint for an end-user application.
"name": "A String", # The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo This field currently has no semantic meaning.
"pemCertificateChain": [ # Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.
"A String",
],
"pscDnsName": "A String", # Output only. The DNS name to use with PSC for the Instance.
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
}</pre>
</div>
<div class="method">
<code class="details" id="injectFault">injectFault(name, body=None, x__xgafv=None)</code>
<pre>Injects fault in an instance. Imperative only.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Instance.name field. (required)
body: object, The request body.
The object takes the form of:
{ # Message for triggering fault injection on an instance
"faultType": "A String", # Required. The type of fault to be injected in an instance.
"requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
"validateOnly": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Instances in a given project and location.
Args:
parent: string, Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: * projects/{project}/locations/-/clusters/- * projects/{project}/locations/{region}/clusters/- (required)
filter: string, Optional. Filtering results
orderBy: string, Optional. Hint for how to order the results
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Instances
"instances": [ # The list of Instance
{ # An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
"activationPolicy": "A String", # Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"availabilityType": "A String", # Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
"clientConnectionConfig": { # Client connection configuration # Optional. Client connection specific configurations
"requireConnectors": True or False, # Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
"sslConfig": { # SSL configuration. # Optional. SSL configuration option for this instance.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
},
"connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP).
"defaultPoolSize": "A String", # Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.
"enable": True or False, # Optional. Deprecated; Prefer 'enabled' as this will be removed soon.
"enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP).
"flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs.
"a_key": "A String",
},
"ignoreStartupParameters": [ # Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"] Note: This field should not be added to client libraries if not present already.
"A String",
],
"maxClientConn": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.
"maxPreparedStatements": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.
"minPoolSize": "A String", # Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.
"poolMode": "A String", # Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.
"poolerCount": 42, # Output only. The number of running poolers per instance.
"queryWaitTimeout": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
"serverIdleTimeout": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
"statsUsers": [ # Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
"a_key": "A String",
},
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Instance.
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"gcaConfig": { # Instance level configuration parameters related to the Gemini Cloud Assist product. # Output only. Configuration parameters related to Gemini Cloud Assist.
"gcaEntitlement": "A String", # Output only. Represents the GCA entitlement state of the instance.
},
"gceZone": "A String", # The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
"geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future.
"entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future.
},
"instanceType": "A String", # Required. The type of the instance. Specified at creation time.
"ipAddress": "A String", # Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configurations for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
"machineType": "A String", # Machine type of the VM instance. E.g. "n2-highmem-4", "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the number of vCPUs in the machine type.
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
"allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
},
],
"enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
"enablePublicIp": True or False, # Optional. Enabling public ip for the instance.
"network": "A String", # Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number}/global/networks/{network_id}`.
},
"nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations.
"id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
},
],
"observabilityConfig": { # Observability Instance specific configuration. # Configuration for observability.
"assistiveExperiencesEnabled": True or False, # Whether assistive experiences are enabled for this AlloyDB instance.
"enabled": True or False, # Observability feature status for an instance. This flag is turned "off" by default.
"maxQueryStringLength": 42, # Query string length. The default value is 10k.
"preserveComments": True or False, # Preserve comments in query string for an instance. This flag is turned "off" by default.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default.
"trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default.
"trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off".
"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API.
"trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.
},
"outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance.
"A String",
],
"pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance.
"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
"A String",
],
"pscAutoConnections": [ # Optional. Configurations for setting up PSC service automation.
{ # Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.
"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project.
"consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.
"consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created.
"ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint.
"status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion.
},
],
"pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
"pscInterfaceConfigs": [ # Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface.
{ # Configuration for setting up a PSC interface to enable outbound connectivity.
"networkAttachmentResource": "A String", # The network attachment resource created in the consumer network to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.
},
],
"serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
},
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
"queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
"queryStringLength": 42, # Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default.
"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
},
"readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
"nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The current serving state of the instance.
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updatePolicy": { # Policy to be used while updating the instance. # Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
"mode": "A String", # Mode for updating the instance.
},
"updateTime": "A String", # Output only. Update time stamp
"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only.
"id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
},
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
<pre>Updates the parameters of a single Instance.
Args:
name: string, Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} (required)
body: object, The request body.
The object takes the form of:
{ # An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
"activationPolicy": "A String", # Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"availabilityType": "A String", # Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
"clientConnectionConfig": { # Client connection configuration # Optional. Client connection specific configurations
"requireConnectors": True or False, # Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
"sslConfig": { # SSL configuration. # Optional. SSL configuration option for this instance.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
},
"connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP).
"defaultPoolSize": "A String", # Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.
"enable": True or False, # Optional. Deprecated; Prefer 'enabled' as this will be removed soon.
"enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP).
"flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs.
"a_key": "A String",
},
"ignoreStartupParameters": [ # Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"] Note: This field should not be added to client libraries if not present already.
"A String",
],
"maxClientConn": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.
"maxPreparedStatements": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.
"minPoolSize": "A String", # Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.
"poolMode": "A String", # Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.
"poolerCount": 42, # Output only. The number of running poolers per instance.
"queryWaitTimeout": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
"serverIdleTimeout": "A String", # Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
"statsUsers": [ # Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
"a_key": "A String",
},
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Instance.
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"gcaConfig": { # Instance level configuration parameters related to the Gemini Cloud Assist product. # Output only. Configuration parameters related to Gemini Cloud Assist.
"gcaEntitlement": "A String", # Output only. Represents the GCA entitlement state of the instance.
},
"gceZone": "A String", # The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
"geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future.
"entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future.
},
"instanceType": "A String", # Required. The type of the instance. Specified at creation time.
"ipAddress": "A String", # Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configurations for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
"machineType": "A String", # Machine type of the VM instance. E.g. "n2-highmem-4", "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the number of vCPUs in the machine type.
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
"allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
},
],
"enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
"enablePublicIp": True or False, # Optional. Enabling public ip for the instance.
"network": "A String", # Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number}/global/networks/{network_id}`.
},
"nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
{ # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations.
"id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
},
],
"observabilityConfig": { # Observability Instance specific configuration. # Configuration for observability.
"assistiveExperiencesEnabled": True or False, # Whether assistive experiences are enabled for this AlloyDB instance.
"enabled": True or False, # Observability feature status for an instance. This flag is turned "off" by default.
"maxQueryStringLength": 42, # Query string length. The default value is 10k.
"preserveComments": True or False, # Preserve comments in query string for an instance. This flag is turned "off" by default.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default.
"trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default.
"trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off".
"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API.
"trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.
},
"outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance.
"A String",
],
"pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance.
"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
"A String",
],
"pscAutoConnections": [ # Optional. Configurations for setting up PSC service automation.
{ # Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.
"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project.
"consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.
"consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created.
"ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint.
"status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion.
},
],
"pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
"pscInterfaceConfigs": [ # Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface.
{ # Configuration for setting up a PSC interface to enable outbound connectivity.
"networkAttachmentResource": "A String", # The network attachment resource created in the consumer network to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.
},
],
"serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
},
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
"queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
"queryStringLength": 42, # Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default.
"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
},
"readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
"nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The current serving state of the instance.
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updatePolicy": { # Policy to be used while updating the instance. # Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
"mode": "A String", # Mode for updating the instance.
},
"updateTime": "A String", # Output only. Update time stamp
"writableNode": { # Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. # Output only. This is set for the read-write VM of the PRIMARY instance only.
"id": "A String", # Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # Output only. The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
},
}
allowMissing: boolean, Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and `update_mask` is ignored.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
validateOnly: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="restart">restart(name, body=None, x__xgafv=None)</code>
<pre>Restart an Instance in a cluster. Imperative only.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Instance.name field. (required)
body: object, The request body.
The object takes the form of:
{
"nodeIds": [ # Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances.
"A String",
],
"requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
"validateOnly": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
