Method: projects.monitoredResourceDescriptors.list

Lists monitored resource descriptors that match a filter.

HTTP request

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

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

An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:

resource.type = starts_with("gce_") AND resource.label:id
pageSize

integer

A positive number that is the maximum number of results to return.
pageToken

string

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.

Request body

The request body must be empty.

Response body

The monitoredResourceDescriptors.list response.

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

JSON representation 
{
  "resourceDescriptors": [
    {
      object (MonitoredResourceDescriptor)
    }
  ],
  "nextPageToken": string
}
Fields
resourceDescriptors[]

object (MonitoredResourceDescriptor)

The monitored resource descriptors that are available to this project and that match 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.