/
monitoring.v1.json
2290 lines (2290 loc) 路 113 KB
/
monitoring.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/monitoring": {
"description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
},
"https://www.googleapis.com/auth/monitoring.read": {
"description": "View monitoring data for all of your Google Cloud and third-party projects"
},
"https://www.googleapis.com/auth/monitoring.write": {
"description": "Publish metric data to your Google Cloud projects"
}
}
}
},
"basePath": "",
"baseUrl": "https://monitoring.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Monitoring",
"description": "Manages your Cloud Monitoring data and configurations.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/monitoring/api/",
"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": "monitoring:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://monitoring.mtls.googleapis.com/",
"name": "monitoring",
"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": {
"locations": {
"resources": {
"global": {
"resources": {
"metricsScopes": {
"methods": {
"get": {
"description": "Returns a specific Metrics Scope, including the list of projects monitored by the specified Metrics Scope.",
"flatPath": "v1/locations/global/metricsScopes/{metricsScopesId}",
"httpMethod": "GET",
"id": "monitoring.locations.global.metricsScopes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Metrics Scope. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}",
"location": "path",
"pattern": "^locations/global/metricsScopes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "MetricsScope"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"listMetricsScopesByMonitoredProject": {
"description": "Returns a list of every Metrics Scope that a specific MonitoredProject has been added to. The metrics scope representing the specified monitored project will always be the first entry in the response.",
"flatPath": "v1/locations/global/metricsScopes:listMetricsScopesByMonitoredProject",
"httpMethod": "GET",
"id": "monitoring.locations.global.metricsScopes.listMetricsScopesByMonitoredProject",
"parameterOrder": [],
"parameters": {
"monitoredResourceContainer": {
"description": "Required. The resource name of the Monitored Project being requested. Example: projects/{MONITORED_PROJECT_ID_OR_NUMBER}",
"location": "query",
"type": "string"
}
},
"path": "v1/locations/global/metricsScopes:listMetricsScopesByMonitoredProject",
"response": {
"$ref": "ListMetricsScopesByMonitoredProjectResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
},
"resources": {
"projects": {
"methods": {
"create": {
"description": "Adds a MonitoredProject with the given project ID to the specified Metrics Scope.",
"flatPath": "v1/locations/global/metricsScopes/{metricsScopesId}/projects",
"httpMethod": "POST",
"id": "monitoring.locations.global.metricsScopes.projects.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}",
"location": "path",
"pattern": "^locations/global/metricsScopes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/projects",
"request": {
"$ref": "MonitoredProject"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
]
},
"delete": {
"description": "Deletes a MonitoredProject from the specified Metrics Scope.",
"flatPath": "v1/locations/global/metricsScopes/{metricsScopesId}/projects/{projectsId}",
"httpMethod": "DELETE",
"id": "monitoring.locations.global.metricsScopes.projects.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the MonitoredProject. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}Authorization requires the following Google IAM (https://cloud.google.com/iam) permissions on both the Metrics Scope and on the MonitoredProject: monitoring.metricsScopes.link",
"location": "path",
"pattern": "^locations/global/metricsScopes/[^/]+/projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
]
}
}
}
}
}
}
}
}
},
"operations": {
"methods": {
"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": "monitoring.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/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
}
},
"projects": {
"resources": {
"dashboards": {
"methods": {
"create": {
"description": "Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API (https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management (https://cloud.google.com/iam).",
"flatPath": "v1/projects/{projectsId}/dashboards",
"httpMethod": "POST",
"id": "monitoring.projects.dashboards.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] The [PROJECT_ID_OR_NUMBER] must match the dashboard resource name.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "If set, validate the request and preview the review, but do not actually save it.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/dashboards",
"request": {
"$ref": "Dashboard"
},
"response": {
"$ref": "Dashboard"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
]
},
"delete": {
"description": "Deletes an existing custom dashboard.This method requires the monitoring.dashboards.delete permission on the specified dashboard. For more information, see Cloud Identity and Access Management (https://cloud.google.com/iam).",
"flatPath": "v1/projects/{projectsId}/dashboards/{dashboardsId}",
"httpMethod": "DELETE",
"id": "monitoring.projects.dashboards.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Dashboard. The format is: projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] ",
"location": "path",
"pattern": "^projects/[^/]+/dashboards/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
]
},
"get": {
"description": "Fetches a specific dashboard.This method requires the monitoring.dashboards.get permission on the specified dashboard. For more information, see Cloud Identity and Access Management (https://cloud.google.com/iam).",
"flatPath": "v1/projects/{projectsId}/dashboards/{dashboardsId}",
"httpMethod": "GET",
"id": "monitoring.projects.dashboards.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Dashboard. The format is one of: dashboards/[DASHBOARD_ID] (for system dashboards) projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] (for custom dashboards).",
"location": "path",
"pattern": "^projects/[^/]+/dashboards/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Dashboard"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"list": {
"description": "Lists the existing dashboards.This method requires the monitoring.dashboards.list permission on the specified project. For more information, see Cloud Identity and Access Management (https://cloud.google.com/iam).",
"flatPath": "v1/projects/{projectsId}/dashboards",
"httpMethod": "GET",
"id": "monitoring.projects.dashboards.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The scope of the dashboards to list. The format is: projects/[PROJECT_ID_OR_NUMBER] ",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dashboards",
"response": {
"$ref": "ListDashboardsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"patch": {
"description": "Replaces an existing custom dashboard with a new definition.This method requires the monitoring.dashboards.update permission on the specified dashboard. For more information, see Cloud Identity and Access Management (https://cloud.google.com/iam).",
"flatPath": "v1/projects/{projectsId}/dashboards/{dashboardsId}",
"httpMethod": "PATCH",
"id": "monitoring.projects.dashboards.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. The resource name of the dashboard.",
"location": "path",
"pattern": "^projects/[^/]+/dashboards/[^/]+$",
"required": true,
"type": "string"
},
"validateOnly": {
"description": "If set, validate the request and preview the review, but do not actually save it.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Dashboard"
},
"response": {
"$ref": "Dashboard"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
]
}
}
},
"location": {
"resources": {
"prometheus": {
"resources": {
"api": {
"resources": {
"v1": {
"methods": {
"labels": {
"description": "Lists labels for metrics.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/labels",
"httpMethod": "POST",
"id": "monitoring.projects.location.prometheus.api.v1.labels",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"location": {
"description": "Location of the resource information. Has to be \"global\" now.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/labels",
"request": {
"$ref": "ListLabelsRequest"
},
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"query": {
"description": "Evaluate a PromQL query at a single point in time.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/query",
"httpMethod": "POST",
"id": "monitoring.projects.location.prometheus.api.v1.query",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"location": {
"description": "Location of the resource information. Has to be \"global\" now.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/query",
"request": {
"$ref": "QueryInstantRequest"
},
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"query_exemplars": {
"description": "Lists exemplars relevant to a given PromQL query,",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/query_exemplars",
"httpMethod": "POST",
"id": "monitoring.projects.location.prometheus.api.v1.query_exemplars",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"location": {
"description": "Location of the resource information. Has to be \"global\" now.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/query_exemplars",
"request": {
"$ref": "QueryExemplarsRequest"
},
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"query_range": {
"description": "Evaluate a PromQL query with start, end time range.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/query_range",
"httpMethod": "POST",
"id": "monitoring.projects.location.prometheus.api.v1.query_range",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"location": {
"description": "Location of the resource information. Has to be \"global\" now.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/query_range",
"request": {
"$ref": "QueryRangeRequest"
},
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
},
"series": {
"description": "Lists metadata for metrics.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/series",
"httpMethod": "POST",
"id": "monitoring.projects.location.prometheus.api.v1.series",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"location": {
"description": "Location of the resource information. Has to be \"global\" for now.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/series",
"request": {
"$ref": "QuerySeriesRequest"
},
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
},
"resources": {
"label": {
"methods": {
"values": {
"description": "Lists possible values for a given label name.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/label/{label}/values",
"httpMethod": "GET",
"id": "monitoring.projects.location.prometheus.api.v1.label.values",
"parameterOrder": [
"name",
"location",
"label"
],
"parameters": {
"end": {
"description": "The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"location": "query",
"type": "string"
},
"label": {
"description": "The label name for which values are queried.",
"location": "path",
"required": true,
"type": "string"
},
"location": {
"description": "Location of the resource information. Has to be \"global\" now.",
"location": "path",
"required": true,
"type": "string"
},
"match": {
"description": "A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them.",
"location": "query",
"type": "string"
},
"name": {
"description": "The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"start": {
"description": "The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/label/{label}/values",
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
}
},
"labels": {
"methods": {
"list": {
"description": "Lists labels for metrics.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/labels",
"httpMethod": "GET",
"id": "monitoring.projects.location.prometheus.api.v1.labels.list",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"end": {
"description": "The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"location": "query",
"type": "string"
},
"location": {
"description": "Location of the resource information. Has to be \"global\" now.",
"location": "path",
"required": true,
"type": "string"
},
"match": {
"description": "A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them.",
"location": "query",
"type": "string"
},
"name": {
"description": "The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"start": {
"description": "The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/labels",
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
}
},
"metadata": {
"methods": {
"list": {
"description": "Lists metadata for metrics.",
"flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/metadata",
"httpMethod": "GET",
"id": "monitoring.projects.location.prometheus.api.v1.metadata.list",
"parameterOrder": [
"name",
"location"
],
"parameters": {
"limit": {
"description": "Maximum number of metrics to return.",
"format": "int64",
"location": "query",
"type": "string"
},
"location": {
"description": "Location of the resource information. Has to be \"global\" for now.",
"location": "path",
"required": true,
"type": "string"
},
"metric": {
"description": "The metric name for which to query metadata. If unset, all metric metadata is returned.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/location/{location}/prometheus/api/v1/metadata",
"response": {
"$ref": "HttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
]
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"revision": "20230130",
"rootUrl": "https://monitoring.googleapis.com/",
"schemas": {
"Aggregation": {
"description": "Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example \"the 95% latency across the average of all tasks in a cluster\". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation).",
"id": "Aggregation",
"properties": {
"alignmentPeriod": {
"description": "The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks.",
"format": "google-duration",
"type": "string"
},
"crossSeriesReducer": {
"description": "The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned.",
"enum": [
"REDUCE_NONE",
"REDUCE_MEAN",
"REDUCE_MIN",
"REDUCE_MAX",
"REDUCE_SUM",
"REDUCE_STDDEV",
"REDUCE_COUNT",
"REDUCE_COUNT_TRUE",
"REDUCE_COUNT_FALSE",
"REDUCE_FRACTION_TRUE",
"REDUCE_PERCENTILE_99",
"REDUCE_PERCENTILE_95",
"REDUCE_PERCENTILE_50",
"REDUCE_PERCENTILE_05"
],
"enumDescriptions": [
"No cross-time series reduction. The output of the Aligner is returned.",
"Reduce by computing the mean value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.",
"Reduce by computing the minimum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.",
"Reduce by computing the maximum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.",
"Reduce by computing the sum across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric and distribution values. The value_type of the output is the same as the value_type of the input.",
"Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.",
"Reduce by computing the number of data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of numeric, Boolean, distribution, and string value_type. The value_type of the output is INT64.",
"Reduce by computing the number of True-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.",
"Reduce by computing the number of False-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.",
"Reduce by computing the ratio of the number of True-valued data points to the total number of data points for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.",
"Reduce by computing the 99th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.",
"Reduce by computing the 95th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.",
"Reduce by computing the 50th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.",
"Reduce by computing the 5th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE."
],
"type": "string"
},
"groupByFields": {
"description": "The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.",
"items": {
"type": "string"
},
"type": "array"
},
"perSeriesAligner": {
"description": "An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.",
"enum": [
"ALIGN_NONE",
"ALIGN_DELTA",
"ALIGN_RATE",
"ALIGN_INTERPOLATE",
"ALIGN_NEXT_OLDER",
"ALIGN_MIN",
"ALIGN_MAX",
"ALIGN_MEAN",
"ALIGN_COUNT",
"ALIGN_SUM",
"ALIGN_STDDEV",
"ALIGN_COUNT_TRUE",
"ALIGN_COUNT_FALSE",
"ALIGN_FRACTION_TRUE",
"ALIGN_PERCENTILE_99",
"ALIGN_PERCENTILE_95",
"ALIGN_PERCENTILE_50",
"ALIGN_PERCENTILE_05",
"ALIGN_PERCENT_CHANGE"
],
"enumDescriptions": [
"No alignment. Raw data is returned. Not valid if cross-series reduction is requested. The value_type of the result is the same as the value_type of the input.",
"Align and convert to DELTA. The output is delta = y1 - y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The value_type of the aligned result is the same as the value_type of the input.",
"Align and convert to a rate. The result is computed as rate = (y1 - y0)/(t1 - t0), or \"delta over time\". Think of this aligner as providing the slope of the line that passes through the value at the start and at the end of the alignment_period.This aligner is valid for CUMULATIVE and DELTA metrics with numeric values. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The output is a GAUGE metric with value_type DOUBLE.If, by \"rate\", you mean \"percentage change\", see the ALIGN_PERCENT_CHANGE aligner instead.",
"Align by interpolating between adjacent points around the alignment period boundary. This aligner is valid for GAUGE metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.",
"Align by moving the most recent data point before the end of the alignment period to the boundary at the end of the alignment period. This aligner is valid for GAUGE metrics. The value_type of the aligned result is the same as the value_type of the input.",
"Align the time series by returning the minimum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.",
"Align the time series by returning the maximum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.",
"Align the time series by returning the mean value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is DOUBLE.",
"Align the time series by returning the number of values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric or Boolean values. The value_type of the aligned result is INT64.",
"Align the time series by returning the sum of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric and distribution values. The value_type of the aligned result is the same as the value_type of the input.",
"Align the time series by returning the standard deviation of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the output is DOUBLE.",
"Align the time series by returning the number of True values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.",
"Align the time series by returning the number of False values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.",
"Align the time series by returning the ratio of the number of True values to the total number of values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.",
"Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 99th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.",
"Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 95th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.",
"Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 50th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.",
"Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 5th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.",
"Align and convert to a percentage change. This aligner is valid for GAUGE and DELTA metrics with numeric values. This alignment returns ((current - previous)/previous) * 100, where the value of previous is determined based on the alignment_period.If the values of current and previous are both 0, then the returned value is 0. If only previous is 0, the returned value is infinity.A 10-minute moving mean is computed at each point of the alignment period prior to the above calculation to smooth the metric and prevent false positives from very short-lived spikes. The moving mean is only applicable for data whose values are >= 0. Any values < 0 are treated as a missing datapoint, and are ignored. While DELTA metrics are accepted by this alignment, special care should be taken that the values for the metric will always be positive. The output is a GAUGE metric with value_type DOUBLE."
],
"type": "string"
}
},
"type": "object"
},
"AlertChart": {
"description": "A chart that displays alert policy data.",
"id": "AlertChart",
"properties": {
"name": {
"description": "Required. The resource name of the alert policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] ",
"type": "string"
}
},
"type": "object"
},
"Axis": {
"description": "A chart axis.",
"id": "Axis",
"properties": {
"label": {
"description": "The label of the axis.",
"type": "string"
},
"scale": {
"description": "The axis scale. By default, a linear scale is used.",
"enum": [
"SCALE_UNSPECIFIED",
"LINEAR",
"LOG10"
],
"enumDescriptions": [
"Scale is unspecified. The view will default to LINEAR.",
"Linear scale.",
"Logarithmic scale (base 10)."
],
"type": "string"
}
},
"type": "object"
},
"ChartOptions": {
"description": "Options to control visual rendering of a chart.",
"id": "ChartOptions",
"properties": {
"mode": {
"description": "The chart mode.",
"enum": [
"MODE_UNSPECIFIED",
"COLOR",
"X_RAY",
"STATS"
],
"enumDescriptions": [
"Mode is unspecified. The view will default to COLOR.",
"The chart distinguishes data series using different color. Line colors may get reused when there are many lines in the chart.",
"The chart uses the Stackdriver x-ray mode, in which each data set is plotted using the same semi-transparent color.",
"The chart displays statistics such as average, median, 95th percentile, and more."
],
"type": "string"
}
},
"type": "object"
},
"CollapsibleGroup": {
"description": "A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.",
"id": "CollapsibleGroup",
"properties": {
"collapsed": {
"description": "The collapsed state of the widget on first page load.",
"type": "boolean"
}
},
"type": "object"
},
"Column": {
"description": "Defines the layout properties and content for a column.",
"id": "Column",
"properties": {
"weight": {
"description": "The relative weight of this column. The column weight is used to adjust the width of columns on the screen (relative to peers). Greater the weight, greater the width of the column on the screen. If omitted, a value of 1 is used while rendering.",
"format": "int64",
"type": "string"
},
"widgets": {
"description": "The display widgets arranged vertically in this column.",
"items": {
"$ref": "Widget"
},
"type": "array"
}
},
"type": "object"