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
|
<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_v1.html">Cloud DNS API</a> . <a href="dns_v1.resourceRecordSets.html">resourceRecordSets</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, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new ResourceRecordSet.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a previously created ResourceRecordSet.</p>
<p class="toc_element">
<code><a href="#get">get(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches the representation of an existing ResourceRecordSet.</p>
<p class="toc_element">
<code><a href="#list">list(project, managedZone, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Enumerates ResourceRecordSets that you have created but not yet deleted.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(project, managedZone, name, type, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Applies a partial update to an existing ResourceRecordSet.</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, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Creates a new ResourceRecordSet.
Args:
project: string, Identifies the project addressed by this request. (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 unit of data that is returned by the DNS servers.
"kind": "dns#resourceRecordSet",
"name": "A String", # For example, www.example.com.
"routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution).
"geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"healthCheck": "A String", # The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks
"kind": "dns#rRSetRoutingPolicy",
"primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy.
"backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy",
"primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.
},
"wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
"items": [
{ # A routing block which contains the routing information for one WRR item.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem",
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
"weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.
},
],
"kind": "dns#rRSetRoutingPolicyWrrPolicy",
},
},
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
"ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
}
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 unit of data that is returned by the DNS servers.
"kind": "dns#resourceRecordSet",
"name": "A String", # For example, www.example.com.
"routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution).
"geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"healthCheck": "A String", # The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks
"kind": "dns#rRSetRoutingPolicy",
"primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy.
"backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy",
"primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.
},
"wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
"items": [
{ # A routing block which contains the routing information for one WRR item.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem",
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
"weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.
},
],
"kind": "dns#rRSetRoutingPolicyWrrPolicy",
},
},
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
"ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</code>
<pre>Deletes a previously created ResourceRecordSet.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
name: string, Fully qualified domain name. (required)
type: string, RRSet type. (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:
{
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</code>
<pre>Fetches the representation of an existing ResourceRecordSet.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
name: string, Fully qualified domain name. (required)
type: string, RRSet type. (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 unit of data that is returned by the DNS servers.
"kind": "dns#resourceRecordSet",
"name": "A String", # For example, www.example.com.
"routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution).
"geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"healthCheck": "A String", # The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks
"kind": "dns#rRSetRoutingPolicy",
"primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy.
"backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy",
"primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.
},
"wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
"items": [
{ # A routing block which contains the routing information for one WRR item.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem",
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
"weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.
},
],
"kind": "dns#rRSetRoutingPolicyWrrPolicy",
},
},
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
"ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, managedZone, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)</code>
<pre>Enumerates ResourceRecordSets that you have created but not yet deleted.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
name: string, Restricts the list to return only records with this fully qualified domain name.
pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
type: string, Restricts the list to return only records of this type. If present, the "name" parameter must also be present.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "dns#resourceRecordSetsListResponse", # Type of resource.
"nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection 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 can't retrieve a consistent snapshot of a collection larger than the maximum page size.
"rrsets": [ # The resource record set resources.
{ # A unit of data that is returned by the DNS servers.
"kind": "dns#resourceRecordSet",
"name": "A String", # For example, www.example.com.
"routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution).
"geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"healthCheck": "A String", # The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks
"kind": "dns#rRSetRoutingPolicy",
"primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy.
"backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy",
"primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.
},
"wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
"items": [
{ # A routing block which contains the routing information for one WRR item.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem",
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
"weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.
},
],
"kind": "dns#rRSetRoutingPolicyWrrPolicy",
},
},
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
"ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(project, managedZone, name, type, body=None, clientOperationId=None, x__xgafv=None)</code>
<pre>Applies a partial update to an existing ResourceRecordSet.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
name: string, Fully qualified domain name. (required)
type: string, RRSet type. (required)
body: object, The request body.
The object takes the form of:
{ # A unit of data that is returned by the DNS servers.
"kind": "dns#resourceRecordSet",
"name": "A String", # For example, www.example.com.
"routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution).
"geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"healthCheck": "A String", # The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks
"kind": "dns#rRSetRoutingPolicy",
"primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy.
"backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy",
"primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.
},
"wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
"items": [
{ # A routing block which contains the routing information for one WRR item.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem",
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
"weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.
},
],
"kind": "dns#rRSetRoutingPolicyWrrPolicy",
},
},
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
"ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
}
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 unit of data that is returned by the DNS servers.
"kind": "dns#resourceRecordSet",
"name": "A String", # For example, www.example.com.
"routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution).
"geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"healthCheck": "A String", # The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks
"kind": "dns#rRSetRoutingPolicy",
"primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy.
"backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy.
"enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.
"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
{ # ResourceRecordSet data for one geo location.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
"location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
},
],
"kind": "dns#rRSetRoutingPolicyGeoPolicy",
},
"kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy",
"primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.
},
"wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
"items": [
{ # A routing block which contains the routing information for one WRR item.
"healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set.
"externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
"A String",
],
"internalLoadBalancers": [ # Configuration for internal load balancers to be health checked.
{ # The configuration for an individual load balancer to health check.
"ipAddress": "A String", # The frontend IP address of the load balancer to health check.
"ipProtocol": "A String", # The protocol of the load balancer to health check.
"kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
"loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer.
"networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.
"port": "A String", # The configured port of the load balancer.
"project": "A String", # The project ID in which the load balancer is located.
"region": "A String", # The region in which the load balancer is located.
},
],
},
"kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem",
"rrdatas": [
"A String",
],
"signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.
"A String",
],
"weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.
},
],
"kind": "dns#rRSetRoutingPolicyWrrPolicy",
},
},
"rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
"A String",
],
"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
"A String",
],
"ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers.
"type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
}</pre>
</div>
</body></html>
|
