{ "basePath": "", "id": "monitoring:v1", "resources": { "projects": { "resources": { "location": { "resources": { "prometheus": { "resources": { "api": { "resources": { "v1": { "resources": { "label": { "methods": { "values": { "parameters": { "label": { "location": "path", "required": true, "type": "string", "description": "The label name for which values are queried." }, "match": { "description": "A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them. ", "type": "string", "location": "query" }, "location": { "description": "Location of the resource information. Has to be \"global\" now.", "required": true, "type": "string", "location": "path" }, "name": { "pattern": "^projects/[^/]+$", "required": true, "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", "type": "string" }, "end": { "description": "The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.", "type": "string", "location": "query" }, "start": { "location": "query", "type": "string", "description": "The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp." } }, "id": "monitoring.projects.location.prometheus.api.v1.label.values", "flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/label/{label}/values", "response": { "$ref": "HttpBody" }, "parameterOrder": [ "name", "location", "label" ], "path": "v1/{+name}/location/{location}/prometheus/api/v1/label/{label}/values", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/monitoring", "https://www.googleapis.com/auth/monitoring.read" ], "description": "The google.monitoring.prometheus.v1.PrometheusUpstream.LabelValues method is not available in this (s3nsapis.fr) universe.", "httpMethod": "GET" } } }, "metadata": { "methods": { "list": { "id": "monitoring.projects.location.prometheus.api.v1.metadata.list", "parameters": { "location": { "location": "path", "required": true, "type": "string", "description": "Location of the resource information. Has to be \"global\" for now." }, "limit": { "type": "string", "description": "Maximum number of metrics to return.", "format": "int64", "location": "query" }, "metric": { "location": "query", "description": "The metric name for which to query metadata. If unset, all metric metadata is returned.", "type": "string" }, "name": { "pattern": "^projects/[^/]+$", "required": true, "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", "type": "string" } }, "httpMethod": "GET", "description": "The google.monitoring.prometheus.v1.PrometheusUpstream.ListMetricMetadata method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+name}/location/{location}/prometheus/api/v1/metadata", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/monitoring", "https://www.googleapis.com/auth/monitoring.read" ], "parameterOrder": [ "name", "location" ], "flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/metadata", "response": { "$ref": "HttpBody" } } } } }, "methods": { "labels": { "request": { "$ref": "QueryLabelsRequest" }, "flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/labels", "response": { "$ref": "HttpBody" }, "parameterOrder": [ "name", "location" ], "httpMethod": "POST", "path": "v1/{+name}/location/{location}/prometheus/api/v1/labels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/monitoring", "https://www.googleapis.com/auth/monitoring.read" ], "description": "The google.monitoring.prometheus.v1.PrometheusUpstream.QueryLabels method is not available in this (s3nsapis.fr) universe.", "parameters": { "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].", "pattern": "^projects/[^/]+$", "required": true, "location": "path", "type": "string" }, "location": { "location": "path", "required": true, "type": "string", "description": "Location of the resource information. Has to be \"global\" now." } }, "id": "monitoring.projects.location.prometheus.api.v1.labels" }, "query": { "parameters": { "name": { "description": "Required. 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.", "pattern": "^projects/[^/]+$", "required": true, "type": "string", "location": "path" }, "location": { "required": true, "type": "string", "description": "Location of the resource information. Has to be \"global\" now.", "location": "path" } }, "id": "monitoring.projects.location.prometheus.api.v1.query", "parameterOrder": [ "name", "location" ], "flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/query", "response": { "$ref": "HttpBody" }, "request": { "$ref": "QueryInstantRequest" }, "description": "The google.monitoring.prometheus.v1.PrometheusUpstream.QueryInstant method is not available in this (s3nsapis.fr) universe.", "path": "v1/{+name}/location/{location}/prometheus/api/v1/query", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/monitoring", "https://www.googleapis.com/auth/monitoring.read" ], "httpMethod": "POST" }, "query_exemplars": { "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "description": "Required. 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": { "location": "path", "description": "Location of the resource information. Has to be \"global\" now.", "required": true, "type": "string" } }, "id": "monitoring.projects.location.prometheus.api.v1.query_exemplars", "flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/query_exemplars", "response": { "$ref": "HttpBody" }, "parameterOrder": [ "name", "location" ], "request": { "$ref": "QueryExemplarsRequest" }, "path": "v1/{+name}/location/{location}/prometheus/api/v1/query_exemplars", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/monitoring", "https://www.googleapis.com/auth/monitoring.read" ], "description": "The google.monitoring.prometheus.v1.PrometheusUpstream.QueryExemplars method is not available in this (s3nsapis.fr) universe.", "httpMethod": "POST" }, "query_range": { "id": "monitoring.projects.location.prometheus.api.v1.query_range", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "description": "Required. 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": { "required": true, "type": "string", "description": "Location of the resource information. Has to be \"global\" now.", "location": "path" } }, "path": "v1/{+name}/location/{location}/prometheus/api/v1/query_range", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/monitoring", "https://www.googleapis.com/auth/monitoring.read" ], "description": "The google.monitoring.prometheus.v1.PrometheusUpstream.QueryRange method is not available in this (s3nsapis.fr) universe.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/query_range", "response": { "$ref": "HttpBody" }, "parameterOrder": [ "name", "location" ], "request": { "$ref": "QueryRangeRequest" } }, "series": { "id": "monitoring.projects.location.prometheus.api.v1.series", "parameters": { "name": { "type": "string", "location": "path", "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].", "pattern": "^projects/[^/]+$", "required": true }, "location": { "location": "path", "description": "Location of the resource information. Has to be \"global\" for now.", "required": true, "type": "string" } }, "httpMethod": "POST", "path": "v1/{+name}/location/{location}/prometheus/api/v1/series", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/monitoring", "https://www.googleapis.com/auth/monitoring.read" ], "description": "The google.monitoring.prometheus.v1.PrometheusUpstream.QuerySeries method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "QuerySeriesRequest" }, "flatPath": "v1/projects/{projectsId}/location/{location}/prometheus/api/v1/series", "response": { "$ref": "HttpBody" }, "parameterOrder": [ "name", "location" ] } } } } } } } } } } } }, "name": "monitoring", "description": "", "baseUrl": "https://monitoring.s3nsapis.fr/", "version_module": true, "ownerDomain": "google.com", "parameters": { "quotaUser": { "location": "query", "type": "string", "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." }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "location": "query", "type": "string", "enum": [ "1", "2" ] }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "alt": { "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "type": "string", "enum": [ "json", "media", "proto" ], "location": "query" }, "key": { "location": "query", "type": "string", "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." }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" } }, "documentationLink": "https://documentation.s3ns.fr/monitoring", "schemas": { "DroppedLabels": { "type": "object", "properties": { "label": { "description": "Map from label to its value, for all labels dropped in any aggregation.", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "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." }, "QueryRangeRequest": { "id": "QueryRangeRequest", "description": "QueryRangeRequest holds all parameters of the Prometheus upstream range query API plus GCM specific parameters.", "type": "object", "properties": { "query": { "type": "string", "description": "A PromQL query string. Query language documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/." }, "start": { "type": "string", "description": "The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp." }, "end": { "type": "string", "description": "The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp." }, "timeout": { "type": "string", "description": "An upper bound timeout for the query. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field." }, "step": { "description": "The resolution of query result. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field.", "type": "string" } } }, "QueryInstantRequest": { "type": "object", "properties": { "time": { "description": "The single point in time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.", "type": "string" }, "query": { "description": "A PromQL query string. Query language documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/.", "type": "string" }, "timeout": { "type": "string", "description": "An upper bound timeout for the query. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field." } }, "id": "QueryInstantRequest", "description": "QueryInstantRequest holds all parameters of the Prometheus upstream instant query API plus GCM specific parameters." }, "OperationMetadata": { "type": "object", "properties": { "updateTime": { "description": "The time when the operation result was last updated.", "format": "google-datetime", "type": "string" }, "createTime": { "type": "string", "description": "The time when the batch request was received.", "format": "google-datetime" }, "state": { "description": "Current state of the batch operation.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ], "enumDescriptions": [ "Invalid.", "Request has been received.", "Request is actively being processed.", "The batch processing is done.", "The batch processing was cancelled." ] } }, "id": "OperationMetadata", "description": "Contains metadata for longrunning operation for the edit Metrics Scope endpoints." }, "Type": { "id": "Type", "description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "type": "object", "properties": { "name": { "type": "string", "description": "The fully qualified message name." }, "fields": { "description": "The list of fields.", "type": "array", "items": { "$ref": "Field" } }, "sourceContext": { "description": "The source context.", "$ref": "SourceContext" }, "options": { "type": "array", "items": { "$ref": "Option" }, "description": "The protocol buffer options." }, "edition": { "description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", "type": "string" }, "syntax": { "enumDescriptions": [ "Syntax `proto2`.", "Syntax `proto3`.", "Syntax `editions`." ], "type": "string", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", "SYNTAX_EDITIONS" ], "description": "The source syntax." }, "oneofs": { "description": "The list of types appearing in `oneof` definitions in this type.", "type": "array", "items": { "type": "string" } } } }, "Field": { "type": "object", "properties": { "cardinality": { "type": "string", "enum": [ "CARDINALITY_UNKNOWN", "CARDINALITY_OPTIONAL", "CARDINALITY_REQUIRED", "CARDINALITY_REPEATED" ], "description": "The field cardinality.", "enumDescriptions": [ "For fields with unknown cardinality.", "For optional fields.", "For required fields. Proto2 syntax only.", "For repeated fields." ] }, "oneofIndex": { "type": "integer", "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" }, "packed": { "description": "Whether to use alternative packed wire representation.", "type": "boolean" }, "number": { "type": "integer", "description": "The field number.", "format": "int32" }, "options": { "description": "The protocol buffer options.", "type": "array", "items": { "$ref": "Option" } }, "typeUrl": { "description": "The field type URL, without the scheme, for message or enumeration types. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.", "type": "string" }, "jsonName": { "description": "The field JSON name.", "type": "string" }, "defaultValue": { "type": "string", "description": "The string value of the default value of this field. Proto2 syntax only." }, "name": { "type": "string", "description": "The field name." }, "kind": { "description": "The field type.", "type": "string", "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" ], "enumDescriptions": [ "Field type unknown.", "Field type double.", "Field type float.", "Field type int64.", "Field type uint64.", "Field type int32.", "Field type fixed64.", "Field type fixed32.", "Field type bool.", "Field type string.", "Field type group. Proto2 syntax only, and deprecated.", "Field type message.", "Field type bytes.", "Field type uint32.", "Field type enum.", "Field type sfixed32.", "Field type sfixed64.", "Field type sint32.", "Field type sint64." ] } }, "id": "Field", "description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information." }, "HttpBody": { "type": "object", "properties": { "data": { "type": "string", "description": "The HTTP request/response body as raw binary.", "format": "byte" }, "contentType": { "description": "The HTTP Content-Type header value specifying the content type of the body.", "type": "string" }, "extensions": { "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "id": "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 google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged." }, "Option": { "id": "Option", "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "type": "object", "properties": { "value": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type." }, "name": { "description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `\"map_entry\"`. For custom options, it should be the fully-qualified name. For example, `\"google.api.http\"`.", "type": "string" } } }, "QueryLabelsRequest": { "id": "QueryLabelsRequest", "description": "QueryLabelsRequest holds all parameters of the Prometheus upstream API for returning a list of label names.", "type": "object", "properties": { "end": { "type": "string", "description": "The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp." }, "match": { "description": "A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them.", "type": "string" }, "start": { "type": "string", "description": "The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp." } } }, "SpanContext": { "type": "object", "properties": { "spanName": { "type": "string", "description": "The resource name of the span. The format is: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array." } }, "id": "SpanContext", "description": "The context of a span. This is attached to an Exemplar in Distribution values during aggregation. It contains the name of a span with format: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]" }, "QueryExemplarsRequest": { "type": "object", "properties": { "end": { "description": "The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.", "type": "string" }, "query": { "description": "A PromQL query string. Query language documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/.", "type": "string" }, "start": { "description": "The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.", "type": "string" } }, "id": "QueryExemplarsRequest", "description": "QueryExemplarsRequest holds all parameters of the Prometheus upstream API for querying exemplars." }, "QuerySeriesRequest": { "id": "QuerySeriesRequest", "description": "QuerySeries holds all parameters of the Prometheus upstream API for querying series.", "type": "object", "properties": { "end": { "type": "string", "description": "The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp." }, "start": { "type": "string", "description": "The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp." } } }, "SourceContext": { "id": "SourceContext", "description": "`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.", "type": "object", "properties": { "fileName": { "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: `\"google/protobuf/source_context.proto\"`.", "type": "string" } } } }, "rootUrl": "https://monitoring.s3nsapis.fr/", "fullyEncodeReservedExpansion": true, "kind": "discovery#restDescription", "batchPath": "batch", "icons": { "x16": "", "x32": "" }, "auth": { "oauth2": { "scopes": { "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/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.read": { "description": "View monitoring data for all of your Google Cloud and third-party projects" } } } }, "ownerName": "Google", "version": "v1", "servicePath": "", "discoveryVersion": "v1", "revision": "20260402", "canonicalName": "Monitoring", "title": "Cloud Monitoring API", "protocol": "rest" }