-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
servicenetworking.v1.json
3796 lines (3796 loc) 路 210 KB
/
servicenetworking.v1.json
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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/service.management": {
"description": "Manage your Google API service configuration"
}
}
}
},
"basePath": "",
"baseUrl": "https://servicenetworking.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Service Networking",
"description": "Provides automatic management of network configurations necessary for certain services.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "servicenetworking:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://servicenetworking.mtls.googleapis.com/",
"name": "servicenetworking",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"flatPath": "v1/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "servicenetworking.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "servicenetworking.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"id": "servicenetworking.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1/operations",
"httpMethod": "GET",
"id": "servicenetworking.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^operations$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
}
},
"services": {
"methods": {
"addSubnetwork": {
"description": "For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask). The method checks against the assigned allocated ranges to find a non-conflicting IP address range. The method will reuse a subnet if subsequent calls contain the same subnet name, region, and prefix length. This method will make producer's tenant project to be a shared VPC service project as needed.",
"flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}:addSubnetwork",
"httpMethod": "POST",
"id": "servicenetworking.services.addSubnetwork",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. A tenant project in the service producer organization, in the following format: services/{service}/{collection-id}/{resource-id}. {collection-id} is the cloud resource collection type that represents the tenant project. Only `projects` are supported. {resource-id} is the tenant project numeric id, such as `123456`. {service} the name of the peering service, such as `service-peering.example.com`. This service must already be enabled in the service consumer's project.",
"location": "path",
"pattern": "^services/[^/]+/[^/]+/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:addSubnetwork",
"request": {
"$ref": "AddSubnetworkRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"disableVpcServiceControls": {
"description": "Disables VPC service controls for a connection.",
"flatPath": "v1/services/{servicesId}:disableVpcServiceControls",
"httpMethod": "PATCH",
"id": "servicenetworking.services.disableVpcServiceControls",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:disableVpcServiceControls",
"request": {
"$ref": "DisableVpcServiceControlsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"enableVpcServiceControls": {
"description": "Enables VPC service controls for a connection.",
"flatPath": "v1/services/{servicesId}:enableVpcServiceControls",
"httpMethod": "PATCH",
"id": "servicenetworking.services.enableVpcServiceControls",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:enableVpcServiceControls",
"request": {
"$ref": "EnableVpcServiceControlsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"searchRange": {
"description": "Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation).",
"flatPath": "v1/services/{servicesId}:searchRange",
"httpMethod": "POST",
"id": "servicenetworking.services.searchRange",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. This is in a form services/{service}. {service} the name of the private access management service, for example 'service-peering.example.com'.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:searchRange",
"request": {
"$ref": "SearchRangeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"validate": {
"description": "Service producers use this method to validate if the consumer provided network, project and requested range are valid. This allows them to use a fail-fast mechanism for consumer requests, and not have to wait for AddSubnetwork operation completion to determine if user request is invalid.",
"flatPath": "v1/services/{servicesId}:validate",
"httpMethod": "POST",
"id": "servicenetworking.services.validate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. This is in a form services/{service} where {service} is the name of the private access management service. For example 'service-peering.example.com'.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:validate",
"request": {
"$ref": "ValidateConsumerConfigRequest"
},
"response": {
"$ref": "ValidateConsumerConfigResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
},
"resources": {
"connections": {
"methods": {
"create": {
"description": "Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once.",
"flatPath": "v1/services/{servicesId}/connections",
"httpMethod": "POST",
"id": "servicenetworking.services.connections.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/connections",
"request": {
"$ref": "Connection"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"deleteConnection": {
"description": "Deletes a private service access connection.",
"flatPath": "v1/services/{servicesId}/connections/{connectionsId}",
"httpMethod": "POST",
"id": "servicenetworking.services.connections.deleteConnection",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of `services/{peering_service_name}/connections/{vpc_peering_name}`. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`.",
"location": "path",
"pattern": "^services/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "DeleteConnectionRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"list": {
"description": "List the private connections that are configured in a service consumer's VPC network.",
"flatPath": "v1/services/{servicesId}/connections",
"httpMethod": "GET",
"id": "servicenetworking.services.connections.list",
"parameterOrder": [
"parent"
],
"parameters": {
"network": {
"description": "The name of service consumer's VPC network that's connected with service producer network through a private connection. The network name must be in the following format: `projects/{project}/global/networks/{network}`. {project} is a project number, such as in `12345` that includes the VPC service consumer's VPC network. {network} is the name of the service consumer's VPC network.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. If you specify `services/-` as the parameter value, all configured peering services are listed.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/connections",
"response": {
"$ref": "ListConnectionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"patch": {
"description": "Updates the allocated ranges that are assigned to a connection.",
"flatPath": "v1/services/{servicesId}/connections/{connectionsId}",
"httpMethod": "PATCH",
"id": "servicenetworking.services.connections.patch",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "If a previously defined allocated range is removed, force flag must be set to true.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of `services/{peering_service_name}/connections/{vpc_peering_name}`. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`.",
"location": "path",
"pattern": "^services/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The update mask. If this is omitted, it defaults to \"*\". You can only update the listed peering ranges.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Connection"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
}
},
"dnsRecordSets": {
"methods": {
"add": {
"description": "Service producers can use this method to add DNS record sets to private DNS zones in the shared producer host project.",
"flatPath": "v1/services/{servicesId}/dnsRecordSets:add",
"httpMethod": "POST",
"id": "servicenetworking.services.dnsRecordSets.add",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dnsRecordSets:add",
"request": {
"$ref": "AddDnsRecordSetRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"remove": {
"description": "Service producers can use this method to remove DNS record sets from private DNS zones in the shared producer host project.",
"flatPath": "v1/services/{servicesId}/dnsRecordSets:remove",
"httpMethod": "POST",
"id": "servicenetworking.services.dnsRecordSets.remove",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dnsRecordSets:remove",
"request": {
"$ref": "RemoveDnsRecordSetRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"update": {
"description": "Service producers can use this method to update DNS record sets from private DNS zones in the shared producer host project.",
"flatPath": "v1/services/{servicesId}/dnsRecordSets:update",
"httpMethod": "POST",
"id": "servicenetworking.services.dnsRecordSets.update",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dnsRecordSets:update",
"request": {
"$ref": "UpdateDnsRecordSetRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
}
},
"dnsZones": {
"methods": {
"add": {
"description": "Service producers can use this method to add private DNS zones in the shared producer host project and matching peering zones in the consumer project.",
"flatPath": "v1/services/{servicesId}/dnsZones:add",
"httpMethod": "POST",
"id": "servicenetworking.services.dnsZones.add",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dnsZones:add",
"request": {
"$ref": "AddDnsZoneRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"remove": {
"description": "Service producers can use this method to remove private DNS zones in the shared producer host project and matching peering zones in the consumer project.",
"flatPath": "v1/services/{servicesId}/dnsZones:remove",
"httpMethod": "POST",
"id": "servicenetworking.services.dnsZones.remove",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dnsZones:remove",
"request": {
"$ref": "RemoveDnsZoneRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
}
},
"projects": {
"resources": {
"global": {
"resources": {
"networks": {
"methods": {
"get": {
"description": "Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.",
"flatPath": "v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}",
"httpMethod": "GET",
"id": "servicenetworking.services.projects.global.networks.get",
"parameterOrder": [
"name"
],
"parameters": {
"includeUsedIpRanges": {
"description": "Optional. When true, include the used IP ranges as part of the GetConsumerConfig output. This includes routes created inside the service networking network, consumer network, peers of the consumer network, and reserved ranges inside the service networking network. By default, this is false",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. Name of the consumer config to retrieve in the format: `services/{service}/projects/{project}/global/networks/{network}`. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is a project number e.g. `12345` that contains the service consumer's VPC network. {network} is the name of the service consumer's VPC network.",
"location": "path",
"pattern": "^services/[^/]+/projects/[^/]+/global/networks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ConsumerConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"updateConsumerConfig": {
"description": "Service producers use this method to update the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.",
"flatPath": "v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig",
"httpMethod": "PATCH",
"id": "servicenetworking.services.projects.global.networks.updateConsumerConfig",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource identifying the connection for which the consumer config is being updated in the format: `services/{service}/projects/{project}/global/networks/{network}` {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is the number of the project that contains the service consumer's VPC network e.g. `12345`. {network} is the name of the service consumer's VPC network.",
"location": "path",
"pattern": "^services/[^/]+/projects/[^/]+/global/networks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:updateConsumerConfig",
"request": {
"$ref": "UpdateConsumerConfigRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
},
"resources": {
"peeredDnsDomains": {
"methods": {
"create": {
"description": "Creates a peered DNS domain which sends requests for records in given namespace originating in the service producer VPC network to the consumer VPC network to be resolved.",
"flatPath": "v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains",
"httpMethod": "POST",
"id": "servicenetworking.services.projects.global.networks.peeredDnsDomains.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource identifying the connection for which the peered DNS domain will be created in the format: `services/{service}/projects/{project}/global/networks/{network}` {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is the number of the project that contains the service consumer's VPC network e.g. `12345`. {network} is the name of the service consumer's VPC network.",
"location": "path",
"pattern": "^services/[^/]+/projects/[^/]+/global/networks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/peeredDnsDomains",
"request": {
"$ref": "PeeredDnsDomain"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"delete": {
"description": "Deletes a peered DNS domain.",
"flatPath": "v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}",
"httpMethod": "DELETE",
"id": "servicenetworking.services.projects.global.networks.peeredDnsDomains.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the peered DNS domain to delete in the format: `services/{service}/projects/{project}/global/networks/{network}/peeredDnsDomains/{name}`. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is the number of the project that contains the service consumer's VPC network e.g. `12345`. {network} is the name of the service consumer's VPC network. {name} is the name of the peered DNS domain.",
"location": "path",
"pattern": "^services/[^/]+/projects/[^/]+/global/networks/[^/]+/peeredDnsDomains/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"list": {
"description": "Lists peered DNS domains for a connection.",
"flatPath": "v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains",
"httpMethod": "GET",
"id": "servicenetworking.services.projects.global.networks.peeredDnsDomains.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource identifying the connection which owns this collection of peered DNS domains in the format: `services/{service}/projects/{project}/global/networks/{network}`. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is a project number e.g. `12345` that contains the service consumer's VPC network. {network} is the name of the service consumer's VPC network.",
"location": "path",
"pattern": "^services/[^/]+/projects/[^/]+/global/networks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/peeredDnsDomains",
"response": {
"$ref": "ListPeeredDnsDomainsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
}
}
}
}
}
}
}
},
"roles": {
"methods": {
"add": {
"description": "Service producers can use this method to add roles in the shared VPC host project. Each role is bound to the provided member. Each role must be selected from within an allowlisted set of roles. Each role is applied at only the granularity specified in the allowlist.",
"flatPath": "v1/services/{servicesId}/roles:add",
"httpMethod": "POST",
"id": "servicenetworking.services.roles.add",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. This is in a form services/{service} where {service} is the name of the private access management service. For example 'service-peering.example.com'.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/roles:add",
"request": {
"$ref": "AddRolesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
}
}
}
}
},
"revision": "20230402",
"rootUrl": "https://servicenetworking.googleapis.com/",
"schemas": {
"AddDnsRecordSetMetadata": {
"description": "Metadata provided through GetOperation request for the LRO generated by AddDnsRecordSet API",
"id": "AddDnsRecordSetMetadata",
"properties": {},
"type": "object"
},
"AddDnsRecordSetRequest": {
"description": "Request to add a record set to a private managed DNS zone in the shared producer host project.",
"id": "AddDnsRecordSetRequest",
"properties": {
"consumerNetwork": {
"description": "Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is the project number, as in '12345' {network} is the network name.",
"type": "string"
},
"dnsRecordSet": {
"$ref": "DnsRecordSet",
"description": "Required. The DNS record set to add."
},
"zone": {
"description": "Required. The name of the private DNS zone in the shared producer host project to which the record set will be added.",
"type": "string"
}
},
"type": "object"
},
"AddDnsZoneMetadata": {
"description": "Metadata provided through GetOperation request for the LRO generated by AddDnsZone API",
"id": "AddDnsZoneMetadata",
"properties": {},
"type": "object"
},
"AddDnsZoneRequest": {
"description": "Request to add a private managed DNS zone in the shared producer host project and a matching DNS peering zone in the consumer project.",
"id": "AddDnsZoneRequest",
"properties": {
"consumerNetwork": {
"description": "Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is the project number, as in '12345' {network} is the network name.",
"type": "string"
},
"dnsSuffix": {
"description": "Required. The DNS name suffix for the zones e.g. `example.com.`. Cloud DNS requires that a DNS suffix ends with a trailing dot.",
"type": "string"
},
"name": {
"description": "Required. The name for both the private zone in the shared producer host project and the peering zone in the consumer project. Must be unique within both projects. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.",
"type": "string"
}
},
"type": "object"
},
"AddDnsZoneResponse": {
"description": "Represents managed DNS zones created in the shared producer host and consumer projects.",
"id": "AddDnsZoneResponse",
"properties": {
"consumerPeeringZone": {
"$ref": "DnsZone",
"description": "The DNS peering zone created in the consumer project."
},
"producerPrivateZone": {
"$ref": "DnsZone",
"description": "The private DNS zone created in the shared producer host project."
}
},
"type": "object"
},
"AddRolesMetadata": {
"description": "Metadata provided through GetOperation request for the LRO generated by AddRoles API",
"id": "AddRolesMetadata",
"properties": {},
"type": "object"
},
"AddRolesRequest": {
"description": "Request for AddRoles to allow Service Producers to add roles in the shared VPC host project for them to use.",
"id": "AddRolesRequest",
"properties": {
"consumerNetwork": {
"description": "Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is a project number, as in '12345' {network} is a network name.",
"type": "string"
},
"policyBinding": {
"description": "Required. List of policy bindings to add to shared VPC host project.",
"items": {
"$ref": "PolicyBinding"
},
"type": "array"
}
},
"type": "object"
},
"AddRolesResponse": {
"description": "Represents IAM roles added to the shared VPC host project.",
"id": "AddRolesResponse",
"properties": {
"policyBinding": {
"description": "Required. List of policy bindings that were added to the shared VPC host project.",
"items": {
"$ref": "PolicyBinding"
},
"type": "array"
}
},
"type": "object"
},
"AddSubnetworkRequest": {
"description": "Request to create a subnetwork in a previously peered service network.",
"id": "AddSubnetworkRequest",
"properties": {
"allowSubnetCidrRoutesOverlap": {
"description": "Optional. Defines the allowSubnetCidrRoutesOverlap field of the subnet, e.g. Available in alpha and beta according to [Compute API documentation](https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks/insert)",
"type": "boolean"
},
"checkServiceNetworkingUsePermission": {
"description": "Optional. The IAM permission check determines whether the consumer project has 'servicenetworking.services.use' permission or not.",
"type": "boolean"
},
"computeIdempotencyWindow": {
"description": "Optional. Specifies a custom time bucket for Arcus subnetwork request idempotency. If two equivalent concurrent requests are made, Arcus will know to ignore the request if it has already been completed or is in progress. Only requests with matching compute_idempotency_window have guaranteed idempotency. Changing this time window between requests results in undefined behavior. Zero (or empty) value with custom_compute_idempotency_window=true specifies no idempotency (i.e. no request ID is provided to Arcus). Maximum value of 14 days (enforced by Arcus limit). For more information on how to use, see: go/revisit-sn-idempotency-window",
"format": "google-duration",
"type": "string"
},
"consumer": {
"description": "Required. A resource that represents the service consumer, such as `projects/123456`. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC.",
"type": "string"
},
"consumerNetwork": {
"description": "Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`. {network} is the name of a VPC network in the project.",
"type": "string"
},
"description": {
"description": "Optional. Description of the subnet.",