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
|
<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="dns_v2.html">Cloud DNS API</a> . <a href="dns_v2.managedZones.html">managedZones</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(project, location, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new ManagedZone.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, location, managedZone, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a previously created ManagedZone.</p>
<p class="toc_element">
<code><a href="#get">get(project, location, managedZone, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches the representation of an existing ManagedZone.</p>
<p class="toc_element">
<code><a href="#list">list(project, location, dnsName=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Enumerates ManagedZones that have been created but not yet deleted.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(project, location, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Applies a partial update to an existing ManagedZone.</p>
<p class="toc_element">
<code><a href="#update">update(project, location, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing ManagedZone.</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(project, location, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Creates a new ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
body: object, The request body.
The object takes the form of:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
}
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, location, managedZone, clientOperationId=None, x__xgafv=None)</code>
<pre>Deletes a previously created ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, location, managedZone, clientOperationId=None, x__xgafv=None)</code>
<pre>Fetches the representation of an existing ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, location, dnsName=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Enumerates ManagedZones that have been created but not yet deleted.
Args:
project: string, Identifies the project addressed by this request. (required)
location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
dnsName: string, Restricts the list to return only zones with this domain name.
maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"header": { # Elements common to every response.
"operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
},
"kind": "dns#managedZonesListResponse", # Type of resource.
"managedZones": [ # The managed zone resources.
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
},
],
"nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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(project, location, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Applies a partial update to an existing ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
body: object, The request body.
The object takes the form of:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
}
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
"dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
"newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
{
"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
"type": "A String", # Specifies the algorithm used to calculate this digest.
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"isActive": True or False, # Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
"keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable.
"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
"kind": "dns#dnsKey",
"publicKey": "A String", # Base64 encoded public half of this key. Output only.
"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
},
"oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
{
"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
"type": "A String", # Specifies the algorithm used to calculate this digest.
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"isActive": True or False, # Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
"keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable.
"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
"kind": "dns#dnsKey",
"publicKey": "A String", # Base64 encoded public half of this key. Output only.
"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
},
},
"id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
"kind": "dns#operation",
"startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
"status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
"type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
"user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
"zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
"newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
},
"oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(project, location, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Updates an existing ManagedZone.
Args:
project: string, Identifies the project addressed by this request. (required)
location: string, Specifies the location of the resource. This information will be used for routing and will be part of the resource name. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
body: object, The request body.
The object takes the form of:
{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
}
clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
"dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
"newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
{
"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
"type": "A String", # Specifies the algorithm used to calculate this digest.
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"isActive": True or False, # Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
"keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable.
"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
"kind": "dns#dnsKey",
"publicKey": "A String", # Base64 encoded public half of this key. Output only.
"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
},
"oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
"creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
{
"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
"type": "A String", # Specifies the algorithm used to calculate this digest.
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"isActive": True or False, # Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
"keyLength": 42, # Length of the key in bits. Specified at creation time, and then immutable.
"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
"kind": "dns#dnsKey",
"publicKey": "A String", # Base64 encoded public half of this key. Output only.
"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
},
},
"id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
"kind": "dns#operation",
"startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
"status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
"type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
"user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
"zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
"newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
},
"oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
"cloudLoggingConfig": { # Cloud Logging configurations for publicly visible zones.
"enableLogging": True or False, # If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
"kind": "dns#managedZoneCloudLoggingConfig",
},
"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
"description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
"dnssecConfig": { # DNSSEC configuration.
"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
{ # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
"keyLength": 42, # Length of the keys in bits.
"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
"kind": "dns#dnsKeySpec",
},
],
"kind": "dns#managedZoneDnsSecConfig",
"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
},
"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
"kind": "dns#managedZoneForwardingConfig",
"targetNameServers": [ # List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
{
"forwardingPath": "A String", # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
"ipv4Address": "A String", # IPv4 address of a target name server.
"kind": "dns#managedZoneForwardingConfigNameServerTarget",
},
],
},
"id": "A String", # Unique identifier for the resource; defined by the server (output only)
"kind": "dns#managedZone",
"labels": { # User labels.
"a_key": "A String",
},
"name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
"A String",
],
"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
"kind": "dns#managedZonePeeringConfig",
"targetNetwork": { # The network with which to peer.
"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
"kind": "dns#managedZonePeeringConfigTargetNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
},
"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
"gkeClusters": [ # The list of Google Kubernetes Engine clusters that can see this zone.
{
"gkeClusterName": "A String", # The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
"kind": "dns#managedZonePrivateVisibilityConfigGKECluster",
},
],
"kind": "dns#managedZonePrivateVisibilityConfig",
"networks": [ # The list of VPC networks that can see this zone.
{
"kind": "dns#managedZonePrivateVisibilityConfigNetwork",
"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
},
],
},
"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
"kind": "dns#managedZoneReverseLookupConfig",
},
"serviceDirectoryConfig": { # Contains information about Service Directory-backed zones. # This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
"kind": "dns#managedZoneServiceDirectoryConfig",
"namespace": { # Contains information about the namespace associated with the zone.
"deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.
"kind": "dns#managedZoneServiceDirectoryConfigNamespace",
"namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
},
},
"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
},
},
}</pre>
</div>
</body></html>
|
