Method: monitoredResourceDescriptors.list

Lists the descriptors for monitored resource types used by Stackdriver Logging.

HTTP request

GET https://logging.googleapis.com/v2/monitoredResourceDescriptors

The URL uses Google API HTTP annotation syntax.

Query parameters

Parameters
pageSize

number

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

pageToken

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

Request body

The request body must be empty.

Response body

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

Result returned from monitoredResourceDescriptors.list.

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

object(MonitoredResourceDescriptor)

A list of resource descriptors.

nextPageToken

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/logging.read
  • https://www.googleapis.com/auth/logging.admin
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

MonitoredResourceDescriptor

An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instanceId" and "zone" to identify particular VM instances.

Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.

JSON representation
{
  "name": string,
  "type": string,
  "displayName": string,
  "description": string,
  "labels": [
    {
      object(LabelDescriptor)
    }
  ],
}
Fields
name

string

Optional. The resource name of the monitored resource descriptor: "projects/{projectId}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {projectId} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".

type

string

Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.

displayName

string

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".

description

string

Optional. A detailed description of the monitored resource type that might be used in documentation.

labels[]

object(LabelDescriptor)

Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "databaseId" and "zone".

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Stackdriver Logging