Method: projects.metricDescriptors.list

Lists metric descriptors that match a filter.

HTTP request

GET https://monitoring.googleapis.com/v3/{name}/metricDescriptors

Path parameters

Parameters
name

string

Required. The project on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Query parameters

Parameters
filter

string

Optional. If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:

metric.type = starts_with("custom.googleapis.com/")
pageSize

integer

Optional. A positive number that is the maximum number of results to return. The default and maximum value is 10,000. If a pageSize <= 0 or > 10,000 is submitted, will instead return a maximum of 10,000 results.
pageToken

string

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.
activeOnly

boolean

Optional. If true, only metrics and monitored resource types that have recent data (within roughly 25 hours) will be included in the response. - If a metric descriptor enumerates monitored resource types, only the monitored resource types for which the metric type has recent data will be included in the returned metric descriptor, and if none of them have recent data, the metric descriptor will not be returned. - If a metric descriptor does not enumerate the compatible monitored resource types, it will be returned only if the metric type has recent data for some monitored resource type. The returned descriptor will not enumerate any monitored resource types.

Request body

The request body must be empty.

Response body

The metricDescriptors.list response.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "metricDescriptors": [
    {
      object (MetricDescriptor)
    }
  ],
  "nextPageToken": string
}
Fields
metricDescriptors[]

object (MetricDescriptor)

The metric descriptors that are available to the project and that match the value of filter, if present.
nextPageToken

string

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read
  • https://www.googleapis.com/auth/monitoring.write

For more information, see the Authentication Overview.