openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 92 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://monitoring.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"Manages your Cloud Monitoring data and configurations.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Cloud Monitoring API","version":"v1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"format":"google","url":"https://monitoring.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"monitoring"},"externalDocs":{"url":"https://cloud.google.com/monitoring/api/"},"tags":[{"name":"locations"},{"name":"operations"},{"name":"projects"}],"paths":{"/v1/locations/global/metricsScopes:listMetricsScopesByMonitoredProject":{"get":{"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.","operationId":"monitoring.locations.global.metricsScopes.listMetricsScopesByMonitoredProject","parameters":[{"description":"Required. The resource name of the Monitored Project being requested. Example: projects/{MONITORED_PROJECT_ID_OR_NUMBER}","in":"query","name":"monitoredResourceContainer","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMetricsScopesByMonitoredProjectResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.read"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.read"]}],"tags":["locations"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{name}":{"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).","operationId":"monitoring.projects.dashboards.delete","parameters":[{"description":"Required. The resource name of the Dashboard. The format is: projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] ","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.write"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.write"]}],"tags":["projects"]},"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).","operationId":"monitoring.projects.dashboards.get","parameters":[{"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).","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.read"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.read"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"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).","operationId":"monitoring.projects.dashboards.patch","parameters":[{"description":"Identifier. The resource name of the dashboard.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"If set, validate the request and preview the review, but do not actually save it.","in":"query","name":"validateOnly","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.write"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.write"]}],"tags":["projects"]}},"/v1/{name}/location/{location}/prometheus/api/v1/label/{label}/values":{"get":{"description":"Lists possible values for a given label name.","operationId":"monitoring.projects.location.prometheus.api.v1.label.values","parameters":[{"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Location of the resource information. Has to be \"global\" now.","in":"path","name":"location","required":true,"schema":{"type":"string"}},{"description":"The label name for which values are queried.","in":"path","name":"label","required":true,"schema":{"type":"string"}},{"description":"The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.","in":"query","name":"end","schema":{"type":"string"}},{"description":"A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them.","in":"query","name":"match","schema":{"type":"string"}},{"description":"The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.","in":"query","name":"start","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpBody"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.read"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.read"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{name}/location/{location}/prometheus/api/v1/labels":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Lists labels for metrics.","operationId":"monitoring.projects.location.prometheus.api.v1.labels","parameters":[{"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Location of the resource information. Has to be \"global\" now.","in":"path","name":"location","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryLabelsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpBody"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.read"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.read"]}],"tags":["projects"]}},"/v1/{name}/location/{location}/prometheus/api/v1/metadata":{"get":{"description":"Lists metadata for metrics.","operationId":"monitoring.projects.location.prometheus.api.v1.metadata.list","parameters":[{"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Location of the resource information. Has to be \"global\" for now.","in":"path","name":"location","required":true,"schema":{"type":"string"}},{"description":"Maximum number of metrics to return.","in":"query","name":"limit","schema":{"type":"string"}},{"description":"The metric name for which to query metadata. If unset, all metric metadata is returned.","in":"query","name":"metric","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpBody"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.read"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.read"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{name}/location/{location}/prometheus/api/v1/query":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Evaluate a PromQL query at a single point in time.","operationId":"monitoring.projects.location.prometheus.api.v1.query","parameters":[{"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Location of the resource information. Has to be \"global\" now.","in":"path","name":"location","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryInstantRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpBody"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.read"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.read"]}],"tags":["projects"]}},"/v1/{name}/location/{location}/prometheus/api/v1/query_exemplars":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Lists exemplars relevant to a given PromQL query,","operationId":"monitoring.projects.location.prometheus.api.v1.query_exemplars","parameters":[{"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Location of the resource information. Has to be \"global\" now.","in":"path","name":"location","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryExemplarsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpBody"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.read"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.read"]}],"tags":["projects"]}},"/v1/{name}/location/{location}/prometheus/api/v1/query_range":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Evaluate a PromQL query with start, end time range.","operationId":"monitoring.projects.location.prometheus.api.v1.query_range","parameters":[{"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Location of the resource information. Has to be \"global\" now.","in":"path","name":"location","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRangeRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpBody"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.read"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.read"]}],"tags":["projects"]}},"/v1/{name}/location/{location}/prometheus/api/v1/series":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Lists metadata for metrics.","operationId":"monitoring.projects.location.prometheus.api.v1.series","parameters":[{"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Location of the resource information. Has to be \"global\" for now.","in":"path","name":"location","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySeriesRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpBody"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.read"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.read"]}],"tags":["projects"]}},"/v1/{parent}/dashboards":{"get":{"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).","operationId":"monitoring.projects.dashboards.list","parameters":[{"description":"Required. The scope of the dashboards to list. The format is: projects/[PROJECT_ID_OR_NUMBER] ","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. 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.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDashboardsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.read"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.read"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"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).","operationId":"monitoring.projects.dashboards.create","parameters":[{"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.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"If set, validate the request and preview the review, but do not actually save it.","in":"query","name":"validateOnly","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.write"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.write"]}],"tags":["projects"]}},"/v1/{parent}/projects":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Adds a MonitoredProject with the given project ID to the specified Metrics Scope.","operationId":"monitoring.locations.global.metricsScopes.projects.create","parameters":[{"description":"Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoredProject"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring"],"Oauth2c":["https://www.googleapis.com/auth/monitoring"]},{"Oauth2":["https://www.googleapis.com/auth/monitoring.write"],"Oauth2c":["https://www.googleapis.com/auth/monitoring.write"]}],"tags":["locations"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"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.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"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.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"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).","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"],"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"],"type":"string"}},"type":"object"},"AggregationFunction":{"description":"Preview: An identifier for an aggregation function. Aggregation functions are SQL functions that group or transform data from multiple points to a single point. This is a preview feature and may be subject to change before final release.","properties":{"parameters":{"description":"Optional. Parameters applied to the aggregation function. Only used for functions that require them.","items":{"$ref":"#/components/schemas/Parameter"},"type":"array"},"type":{"description":"Required. The type of aggregation function, must be one of the following: \"none\" - no function. \"percentile\" - APPROX_QUANTILES() - 1 parameter numeric value \"average\" - AVG() \"count\" - COUNT() \"count-distinct\" - COUNT(DISTINCT) \"count-distinct-approx\" - APPROX_COUNT_DISTINCT() \"max\" - MAX() \"min\" - MIN() \"sum\" - SUM()","type":"string"}},"type":"object"},"AlertChart":{"description":"A chart that displays alert policy data.","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.","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"],"type":"string"}},"type":"object"},"Breakdown":{"description":"Preview: A breakdown is an aggregation applied to the measures over a specified column. A breakdown can result in multiple series across a category for the provided measure. This is a preview feature and may be subject to change before final release.","properties":{"aggregationFunction":{"$ref":"#/components/schemas/AggregationFunction","description":"Required. The Aggregation function is applied across all data in each breakdown created."},"column":{"description":"Required. The name of the column in the dataset containing the breakdown values.","type":"string"},"limit":{"description":"Required. A limit to the number of breakdowns. If set to zero then all possible breakdowns are applied. The list of breakdowns is dependent on the value of the sort_order field.","format":"int32","type":"integer"},"sortOrder":{"description":"Required. The sort order is applied to the values of the breakdown column.","enum":["SORT_ORDER_UNSPECIFIED","SORT_ORDER_NONE","SORT_ORDER_ASCENDING","SORT_ORDER_DESCENDING"],"type":"string"}},"type":"object"},"ChartOptions":{"description":"Options to control visual rendering of a chart.","properties":{"displayHorizontal":{"description":"Preview: Configures whether the charted values are shown on the horizontal or vertical axis. By default, values are represented the vertical axis. This is a preview feature and may be subject to change before final release.","type":"boolean"},"mode":{"description":"The chart mode.","enum":["MODE_UNSPECIFIED","COLOR","X_RAY","STATS"],"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.","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.","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":"#/components/schemas/Widget"},"type":"array"}},"type":"object"},"ColumnLayout":{"description":"A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.","properties":{"columns":{"description":"The columns of content to display.","items":{"$ref":"#/components/schemas/Column"},"type":"array"}},"type":"object"},"ColumnSettings":{"description":"The persistent settings for a table's columns.","properties":{"column":{"description":"Required. The id of the column.","type":"string"},"visible":{"description":"Required. Whether the column should be visible on page load.","type":"boolean"}},"type":"object"},"Dashboard":{"description":"A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.","properties":{"columnLayout":{"$ref":"#/components/schemas/ColumnLayout","description":"The content is divided into equally spaced columns and the widgets are arranged vertically."},"dashboardFilters":{"description":"Filters to reduce the amount of data charted based on the filter criteria.","items":{"$ref":"#/components/schemas/DashboardFilter"},"type":"array"},"displayName":{"description":"Required. The mutable, human-readable name.","type":"string"},"etag":{"description":"etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. An etag is returned in the response to GetDashboard, and users are expected to put that etag in the request to UpdateDashboard to ensure that their change will be applied to the same version of the Dashboard configuration. The field should not be passed during dashboard creation.","type":"string"},"gridLayout":{"$ref":"#/components/schemas/GridLayout","description":"Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles."},"labels":{"additionalProperties":{"type":"string"},"description":"Labels applied to the dashboard","type":"object"},"mosaicLayout":{"$ref":"#/components/schemas/MosaicLayout","description":"The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks."},"name":{"description":"Identifier. The resource name of the dashboard.","type":"string"},"rowLayout":{"$ref":"#/components/schemas/RowLayout","description":"The content is divided into equally spaced rows and the widgets are arranged horizontally."}},"type":"object"},"DashboardFilter":{"description":"A filter to reduce the amount of data charted in relevant widgets.","properties":{"filterType":{"description":"The specified filter type","enum":["FILTER_TYPE_UNSPECIFIED","RESOURCE_LABEL","METRIC_LABEL","USER_METADATA_LABEL","SYSTEM_METADATA_LABEL","GROUP"],"type":"string"},"labelKey":{"description":"Required. The key for the label","type":"string"},"stringValue":{"description":"A variable-length string value.","type":"string"},"templateVariable":{"description":"The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.","type":"string"}},"type":"object"},"DataSet":{"description":"Groups a time series query definition with charting options.","properties":{"breakdowns":{"description":"Optional. The collection of breakdowns to be applied to the dataset.","items":{"$ref":"#/components/schemas/Breakdown"},"type":"array"},"dimensions":{"description":"Optional. A collection of dimension columns.","items":{"$ref":"#/components/schemas/Dimension"},"type":"array"},"legendTemplate":{"description":"A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name}, which will resolve to the label's value.","type":"string"},"measures":{"description":"Optional. A collection of measures.","items":{"$ref":"#/components/schemas/Measure"},"type":"array"},"minAlignmentPeriod":{"description":"Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.","format":"google-duration","type":"string"},"plotType":{"description":"How this data should be plotted on the chart.","enum":["PLOT_TYPE_UNSPECIFIED","LINE","STACKED_AREA","STACKED_BAR","HEATMAP"],"type":"string"},"targetAxis":{"description":"Optional. The target axis to use for plotting the metric.","enum":["TARGET_AXIS_UNSPECIFIED","Y1","Y2"],"type":"string"},"timeSeriesQuery":{"$ref":"#/components/schemas/TimeSeriesQuery","description":"Required. Fields for querying time series data from the Stackdriver metrics API."}},"type":"object"},"Dimension":{"description":"A chart dimension. Dimensions are a structured label, class, or category for a set of measurements in your data.","properties":{"column":{"description":"Required. The name of the column in the source SQL query that is used to chart the dimension.","type":"string"},"columnType":{"description":"Optional. The type of the dimension column. This is relevant only if one of the bin_size fields is set. If it is empty, the type TIMESTAMP or INT64 will be assumed based on which bin_size field is set. If populated, this should be set to one of the following types: DATE, TIME, DATETIME, TIMESTAMP, BIGNUMERIC, INT64, NUMERIC, FLOAT64.","type":"string"},"floatBinSize":{"description":"Optional. float_bin_size is used when the column type used for a dimension is a floating point numeric column.","format":"double","type":"number"},"maxBinCount":{"description":"A limit to the number of bins generated. When 0 is specified, the maximum count is not enforced.","format":"int32","type":"integer"},"numericBinSize":{"description":"numeric_bin_size is used when the column type used for a dimension is numeric or string.","format":"int32","type":"integer"},"sortColumn":{"description":"The column name to sort on for binning. This column can be the same column as this dimension or any other column used as a measure in the results. If sort_order is set to NONE, then this value is not used.","type":"string"},"sortOrder":{"description":"The sort order applied to the sort column.","enum":["SORT_ORDER_UNSPECIFIED","SORT_ORDER_NONE","SORT_ORDER_ASCENDING","SORT_ORDER_DESCENDING"],"type":"string"},"timeBinSize":{"description":"time_bin_size is used when the data type specified by column is a time type and the bin size is determined by a time duration. If column_type is DATE, this must be a whole value multiple of 1 day. If column_type is TIME, this must be less than or equal to 24 hours.","format":"google-duration","type":"string"}},"type":"object"},"DroppedLabels":{"description":"A set of (label, value) pairs that were removed from a Distribution time series during aggregation and then added as an attachment to a Distribution.Exemplar.The full label set for the exemplars is constructed by using the dropped pairs in combination with the label values that remain on the aggregated Distribution time series. The constructed full label set can be used to identify the specific entity, such as the instance or job, which might be contributing to a long-tail. However, with dropped labels, the storage requirements are reduced because only the aggregated distribution values for a large group of time series are stored.Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities.","properties":{"label":{"additionalProperties":{"type":"string"},"description":"Map from label to its value, for all labels dropped in any aggregation.","type":"object"}},"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); } ","properties":{},"type":"object"},"ErrorReportingPanel":{"description":"A widget that displays a list of error groups.","properties":{"projectNames":{"description":"The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234.","items":{"type":"string"},"type":"array"},"services":{"description":"An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version, which can be changed whenever new code is deployed.Contains the service name for error reports extracted from Google App Engine logs or default if the App Engine default service is used.","items":{"type":"string"},"type":"array"},"versions":{"description":"Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app.","items":{"type":"string"},"type":"array"}},"type":"object"},"Field":{"description":"A single field of a message type.","properties":{"cardinality":{"description":"The field cardinality.","enum":["CARDINALITY_UNKNOWN","CARDINALITY_OPTIONAL","CARDINALITY_REQUIRED","CARDINALITY_REPEATED"],"type":"string"},"defaultValue":{"description":"The string value of the default value of this field. Proto2 syntax only.","type":"string"},"jsonName":{"description":"The field JSON name.","type":"string"},"kind":{"description":"The field type.","enum":["TYPE_UNKNOWN","TYPE_DOUBLE","TYPE_FLOAT","TYPE_INT64","TYPE_UINT64","TYPE_INT32","TYPE_FIXED64","TYPE_FIXED32","TYPE_BOOL","TYPE_STRING","TYPE_GROUP","TYPE_MESSAGE","TYPE_BYTES","TYPE_UINT32","TYPE_ENUM","TYPE_SFIXED32","TYPE_SFIXED64","TYPE_SINT32","TYPE_SINT64"],"type":"string"},"name":{"description":"The field name.","type":"string"},"number":{"description":"The field number.","format":"int32","type":"integer"},"oneofIndex":{"description":"The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.","format":"int32","type":"integer"},"options":{"description":"The protocol buffer options.","items":{"$ref":"#/components/schemas/Option"},"type":"array"},"packed":{"description":"Whether to use alternative packed wire representation.","type":"boolean"},"typeUrl":{"description":"The field type URL, without the scheme, for message or enumeration types. Example: \"type.googleapis.com/google.protobuf.Timestamp\".","type":"string"}},"type":"object"},"GaugeView":{"description":"A gauge chart shows where the current value sits within a pre-defined range. The upper and lower bounds should define the possible range of values for the scorecard's query (inclusive).","properties":{"lowerBound":{"description":"The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this.","format":"double","type":"number"},"upperBound":{"description":"The upper bound for this gauge chart. The value of the chart should always be less than or equal to this.","format":"double","type":"number"}},"type":"object"},"GridLayout":{"description":"A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy.","properties":{"columns":{"description":"The number of columns into which the view's width is divided. If omitted or set to zero, a system default will be used while rendering.","format":"int64","type":"string"},"widgets":{"description":"The informational elements that are arranged into the columns row-first.","items":{"$ref":"#/components/schemas/Widget"},"type":"array"}},"type":"object"},"HttpBody":{"description":"Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.This message can be used both in streaming and non-streaming API methods in the request as well as the response.It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream