-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Expand file tree
/
Copy pathnetworkmanagement.v1.json
More file actions
1992 lines (1992 loc) · 98.3 KB
/
networkmanagement.v1.json
File metadata and controls
1992 lines (1992 loc) · 98.3 KB
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 Platform data"
}
}
}
},
"basePath": "",
"baseUrl": "https://networkmanagement.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Network Management",
"description": "The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/",
"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": "networkmanagement:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://networkmanagement.mtls.googleapis.com/",
"name": "networkmanagement",
"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": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "networkmanagement.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists information about the supported locations for this service.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "networkmanagement.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"global": {
"resources": {
"connectivityTests": {
"methods": {
"create": {
"description": "Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. If the endpoint specifications in `ConnectivityTest` are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of `UNKNOWN`. If the endpoint specifications in `ConnectivityTest` are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation.",
"flatPath": "v1/projects/{projectsId}/locations/global/connectivityTests",
"httpMethod": "POST",
"id": "networkmanagement.projects.locations.global.connectivityTests.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource of the Connectivity Test to create: `projects/{project_id}/locations/global`",
"location": "path",
"pattern": "^projects/[^/]+/locations/global$",
"required": true,
"type": "string"
},
"testId": {
"description": "Required. The logical name of the Connectivity Test in your project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/connectivityTests",
"request": {
"$ref": "ConnectivityTest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a specific `ConnectivityTest`.",
"flatPath": "v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}",
"httpMethod": "DELETE",
"id": "networkmanagement.projects.locations.global.connectivityTests.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/global/connectivityTests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the details of a specific Connectivity Test.",
"flatPath": "v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}",
"httpMethod": "GET",
"id": "networkmanagement.projects.locations.global.connectivityTests.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. `ConnectivityTest` resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/global/connectivityTests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ConnectivityTest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:getIamPolicy",
"httpMethod": "GET",
"id": "networkmanagement.projects.locations.global.connectivityTests.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/global/connectivityTests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Connectivity Tests owned by a project.",
"flatPath": "v1/projects/{projectsId}/locations/global/connectivityTests",
"httpMethod": "GET",
"id": "networkmanagement.projects.locations.global.connectivityTests.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Lists the `ConnectivityTests` that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \"projects/proj-1/locations/global/connectivityTests/test-1 - Filter by labels: - Resources that have a key called `foo` labels.foo:* - Resources that have a key called `foo` whose value is `bar` labels.foo = bar",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field to use to sort the list.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Number of `ConnectivityTests` to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token from an earlier query, as returned in `next_page_token`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource of the Connectivity Tests: `projects/{project_id}/locations/global`",
"location": "path",
"pattern": "^projects/[^/]+/locations/global$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/connectivityTests",
"response": {
"$ref": "ListConnectivityTestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the configuration of an existing `ConnectivityTest`. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result. If the endpoint specifications in `ConnectivityTest` are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN. If the endpoint specifications in `ConnectivityTest` are incomplete, the reachability result returns a value of `AMBIGUOUS`. See the documentation in `ConnectivityTest` for for more details.",
"flatPath": "v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}",
"httpMethod": "PATCH",
"id": "networkmanagement.projects.locations.global.connectivityTests.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/global/connectivityTests/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields to update. At least one path must be supplied in this field.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "ConnectivityTest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"rerun": {
"description": "Rerun an existing `ConnectivityTest`. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes. If the endpoint specifications in `ConnectivityTest` become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of `UNKNOWN`.",
"flatPath": "v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:rerun",
"httpMethod": "POST",
"id": "networkmanagement.projects.locations.global.connectivityTests.rerun",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/global/connectivityTests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:rerun",
"request": {
"$ref": "RerunConnectivityTestRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:setIamPolicy",
"httpMethod": "POST",
"id": "networkmanagement.projects.locations.global.connectivityTests.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/global/connectivityTests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:testIamPermissions",
"httpMethod": "POST",
"id": "networkmanagement.projects.locations.global.connectivityTests.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/global/connectivityTests/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"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/projects/{projectsId}/locations/global/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "networkmanagement.projects.locations.global.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/global/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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/projects/{projectsId}/locations/global/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "networkmanagement.projects.locations.global.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/global/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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/projects/{projectsId}/locations/global/operations/{operationsId}",
"httpMethod": "GET",
"id": "networkmanagement.projects.locations.global.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/global/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1/projects/{projectsId}/locations/global/operations",
"httpMethod": "GET",
"id": "networkmanagement.projects.locations.global.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": "^projects/[^/]+/locations/global$",
"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}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
}
}
},
"revision": "20210603",
"rootUrl": "https://networkmanagement.googleapis.com/",
"schemas": {
"AbortInfo": {
"description": "Details of the final state \"abort\" and associated resource.",
"id": "AbortInfo",
"properties": {
"cause": {
"description": "Causes that the analysis is aborted.",
"enum": [
"CAUSE_UNSPECIFIED",
"UNKNOWN_NETWORK",
"UNKNOWN_IP",
"UNKNOWN_PROJECT",
"PERMISSION_DENIED",
"NO_SOURCE_LOCATION",
"INVALID_ARGUMENT",
"NO_EXTERNAL_IP",
"UNINTENDED_DESTINATION",
"TRACE_TOO_LONG",
"INTERNAL_ERROR",
"SOURCE_ENDPOINT_NOT_FOUND",
"MISMATCHED_SOURCE_NETWORK",
"DESTINATION_ENDPOINT_NOT_FOUND",
"MISMATCHED_DESTINATION_NETWORK"
],
"enumDescriptions": [
"Cause is unspecified.",
"Aborted due to unknown network. The reachability analysis cannot proceed because the user does not have access to the host project's network configurations, including firewall rules and routes. This happens when the project is a service project and the endpoints being traced are in the host project's network.",
"Aborted because the IP address(es) are unknown.",
"Aborted because no project information can be derived from the test input.",
"Aborted because the user lacks the permission to access all or part of the network configurations required to run the test.",
"Aborted because no valid source endpoint is derived from the input test request.",
"Aborted because the source and/or destination endpoint specified in the test are invalid. The possible reasons that an endpoint is invalid include: malformed IP address; nonexistent instance or network URI; IP address not in the range of specified network URI; and instance not owning the network interface in the specified network.",
"Aborted because traffic is sent from a public IP to an instance without an external IP.",
"Aborted because none of the traces matches destination information specified in the input test request.",
"Aborted because the number of steps in the trace exceeding a certain limit which may be caused by routing loop.",
"Aborted due to internal server error.",
"Aborted because the source endpoint could not be found.",
"Aborted because the source network does not match the source endpoint.",
"Aborted because the destination endpoint could not be found.",
"Aborted because the destination network does not match the destination endpoint."
],
"type": "string"
},
"resourceUri": {
"description": "URI of the resource that caused the abort.",
"type": "string"
}
},
"type": "object"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.",
"id": "AuditConfig",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"items": {
"$ref": "AuditLogConfig"
},
"type": "array"
},
"service": {
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
"type": "string"
}
},
"type": "object"
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
"id": "AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
},
"logType": {
"description": "The log type that this config enables.",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"type": "string"
}
},
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
"type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
"properties": {},
"type": "object"
},
"CloudSQLInstanceInfo": {
"description": "For display only. Metadata associated with a Cloud SQL instance.",
"id": "CloudSQLInstanceInfo",
"properties": {
"displayName": {
"description": "Name of a Cloud SQL instance.",
"type": "string"
},
"externalIp": {
"description": "External IP address of a Cloud SQL instance.",
"type": "string"
},
"internalIp": {
"description": "Internal IP address of a Cloud SQL instance.",
"type": "string"
},
"networkUri": {
"description": "URI of a Cloud SQL instance network or empty string if the instance does not have one.",
"type": "string"
},
"region": {
"description": "Region in which the Cloud SQL instance is running.",
"type": "string"
},
"uri": {
"description": "URI of a Cloud SQL instance.",
"type": "string"
}
},
"type": "object"
},
"ConnectivityTest": {
"description": "A Connectivity Test for a network reachability analysis.",
"id": "ConnectivityTest",
"properties": {
"createTime": {
"description": "Output only. The time the test was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "The user-supplied description of the Connectivity Test. Maximum of 512 characters.",
"type": "string"
},
"destination": {
"$ref": "Endpoint",
"description": "Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test."
},
"displayName": {
"description": "Output only. The display name of a Connectivity Test.",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Resource labels to represent user-provided metadata.",
"type": "object"
},
"name": {
"description": "Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`",
"type": "string"
},
"protocol": {
"description": "IP Protocol of the test. When not provided, \"TCP\" is assumed.",
"type": "string"
},
"reachabilityDetails": {
"$ref": "ReachabilityDetails",
"description": "Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.",
"readOnly": true
},
"relatedProjects": {
"description": "Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.",
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"$ref": "Endpoint",
"description": "Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test."
},
"updateTime": {
"description": "Output only. The time the test's configuration was updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"DeliverInfo": {
"description": "Details of the final state \"deliver\" and associated resource.",
"id": "DeliverInfo",
"properties": {
"resourceUri": {
"description": "URI of the resource that the packet is delivered to.",
"type": "string"
},
"target": {
"description": "Target type where the packet is delivered to.",
"enum": [
"TARGET_UNSPECIFIED",
"INSTANCE",
"INTERNET",
"GOOGLE_API",
"GKE_MASTER",
"CLOUD_SQL_INSTANCE"
],
"enumDescriptions": [
"Target not specified.",
"Target is a Compute Engine instance.",
"Target is the internet.",
"Target is a Google API.",
"Target is a Google Kubernetes Engine cluster master.",
"Target is a Cloud SQL instance."
],
"type": "string"
}
},
"type": "object"
},
"DropInfo": {
"description": "Details of the final state \"drop\" and associated resource.",
"id": "DropInfo",
"properties": {
"cause": {
"description": "Cause that the packet is dropped.",
"enum": [
"CAUSE_UNSPECIFIED",
"UNKNOWN_EXTERNAL_ADDRESS",
"FOREIGN_IP_DISALLOWED",
"FIREWALL_RULE",
"NO_ROUTE",
"ROUTE_BLACKHOLE",
"ROUTE_WRONG_NETWORK",
"PRIVATE_TRAFFIC_TO_INTERNET",
"PRIVATE_GOOGLE_ACCESS_DISALLOWED",
"NO_EXTERNAL_ADDRESS",
"UNKNOWN_INTERNAL_ADDRESS",
"FORWARDING_RULE_MISMATCH",
"FORWARDING_RULE_NO_INSTANCES",
"FIREWALL_BLOCKING_LOAD_BALANCER_BACKEND_HEALTH_CHECK",
"INSTANCE_NOT_RUNNING",
"TRAFFIC_TYPE_BLOCKED",
"GKE_MASTER_UNAUTHORIZED_ACCESS",
"CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS",
"DROPPED_INSIDE_GKE_SERVICE",
"DROPPED_INSIDE_CLOUD_SQL_SERVICE",
"GOOGLE_MANAGED_SERVICE_NO_PEERING",
"CLOUD_SQL_INSTANCE_NO_IP_ADDRESS"
],
"enumDescriptions": [
"Cause is unspecified.",
"Destination external address cannot be resolved to a known target. If the address is used in a Google Cloud project, provide the project ID as test input.",
"A Compute Engine instance can only send or receive a packet with a foreign IP address if ip_forward is enabled.",
"Dropped due to a firewall rule, unless allowed due to connection tracking.",
"Dropped due to no routes.",
"Dropped due to invalid route. Route's next hop is a blackhole.",
"Packet is sent to a wrong (unintended) network. Example: you trace a packet from VM1:Network1 to VM2:Network2, however, the route configured in Network1 sends the packet destined for VM2's IP addresss to Network3.",
"Packet with internal destination address sent to the internet gateway.",
"Instance with only an internal IP address tries to access Google API and services, but private Google access is not enabled.",
"Instance with only an internal IP address tries to access external hosts, but Cloud NAT is not enabled in the subnet, unless special configurations on a VM allow this connection. For more details, see [Special configurations for VM instances](https://cloud.google.com/vpc/docs/special-configurations).",
"Destination internal address cannot be resolved to a known target. If this is a shared VPC scenario, verify if the service project ID is provided as test input. Otherwise, verify if the IP address is being used in the project.",
"Forwarding rule's protocol and ports do not match the packet header.",
"Forwarding rule does not have backends configured.",
"Firewalls block the health check probes to the backends and cause the backends to be unavailable for traffic from the load balancer. For more details, see [Health check firewall rules](https://cloud.google.com/load-balancing/docs/health-checks#firewall_rules).",
"Packet is sent from or to a Compute Engine instance that is not in a running state.",
"The type of traffic is blocked and the user cannot configure a firewall rule to enable it. See [Always blocked traffic](https://cloud.google.com/vpc/docs/firewalls#blockedtraffic) for more details.",
"Access to Google Kubernetes Engine cluster master's endpoint is not authorized. See [Access to the cluster endpoints](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#access_to_the_cluster_endpoints) for more details.",
"Access to the Cloud SQL instance endpoint is not authorized. See [Authorizing with authorized networks](https://cloud.google.com/sql/docs/mysql/authorize-networks) for more details.",
"Packet was dropped inside Google Kubernetes Engine Service.",
"Packet was dropped inside Cloud SQL Service.",
"Packet was dropped because there is no peering between the originating network and the Google Managed Services Network.",
"Packet was dropped because the Cloud SQL instance has neither a private nor a public IP address."
],
"type": "string"
},
"resourceUri": {
"description": "URI of the resource that caused the drop.",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"Endpoint": {
"description": "Source or destination of the Connectivity Test.",
"id": "Endpoint",
"properties": {
"cloudSqlInstance": {
"description": "A [Cloud SQL](https://cloud.google.com/sql) instance URI.",
"type": "string"
},
"gkeMasterCluster": {
"description": "A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).",
"type": "string"
},
"instance": {
"description": "A Compute Engine instance URI.",
"type": "string"
},
"ipAddress": {
"description": "The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](/load-balancing/docs/load-balancing-overview).",
"type": "string"
},
"network": {
"description": "A Compute Engine network URI.",
"type": "string"
},
"networkType": {
"description": "Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.",
"enum": [
"NETWORK_TYPE_UNSPECIFIED",
"GCP_NETWORK",
"NON_GCP_NETWORK"
],
"enumDescriptions": [
"Default type if unspecified.",
"A network hosted within Google Cloud Platform. To receive more detailed output, specify the URI for the source or destination network.",
"A network hosted outside of Google Cloud Platform. This can be an on-premises network, or a network hosted by another cloud provider."
],
"type": "string"
},
"port": {
"description": "The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.",
"format": "int32",
"type": "integer"
},
"projectId": {
"description": "Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.",
"type": "string"
}
},
"type": "object"
},
"EndpointInfo": {
"description": "For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model.",
"id": "EndpointInfo",
"properties": {
"destinationIp": {
"description": "Destination IP address.",
"type": "string"
},
"destinationNetworkUri": {
"description": "URI of the network where this packet is sent to.",
"type": "string"
},
"destinationPort": {
"description": "Destination port. Only valid when protocol is TCP or UDP.",
"format": "int32",
"type": "integer"
},
"protocol": {
"description": "IP protocol in string format, for example: \"TCP\", \"UDP\", \"ICMP\".",
"type": "string"
},
"sourceIp": {
"description": "Source IP address.",
"type": "string"
},
"sourceNetworkUri": {
"description": "URI of the network where this packet originates from.",
"type": "string"
},
"sourcePort": {
"description": "Source port. Only valid when protocol is TCP or UDP.",
"format": "int32",
"type": "integer"
}
},