MetricDescriptors: search

Requires authorization

Search the metric descriptors that match the query. Large responses will be paginated, use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken. Try it now.

Request

HTTP request

GET https://www.googleapis.com/cloudmonitoring/v2beta1/projects/project/metricDescriptors/search

Parameters

Parameter name Value Description
Path parameters
project string The project id. The value can be the numeric project ID or string-based project name.
Optional query parameters
count integer Maximum number of metric descriptors per page. Used for pagination. If not specified, count = 100. Acceptable values are 1 to 1000, inclusive. (Default: 100)
pageToken bytes The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.
query string The query used to search the metric. Keywords in the query are delimited by whitespace. Multiple keywords are joined by Boolean And.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/monitoring

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "cloudmonitoring#searchMetricResponse",
  "metrics": [
    metricDescriptors Resource
  ],
  "nextPageToken": bytes
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#searchMetricResponse".
metrics[] list The returned metric descriptors.
nextPageToken bytes Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set this value to the pageToken query parameter.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Stackdriver Monitoring