REST Resource: projects.monitoredResourceDescriptors

Resource: MonitoredResourceDescriptor

An object that describes the schema of aMonitoredResource 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"instance_id" and"zone" to identify particular VM instances.

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

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

string

Optional. The resource name of the monitored resource descriptor:"projects/{projectId}/monitoredResourceDescriptors/{type}" where {type} is the value of thetype 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. For a list of types, seeMonitored resource types andLogging resource types.

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"database_id" and"zone".

launchStage

enum (LaunchStage)

Optional. The launch stage of the monitored resource definition.

Methods

get

 Gets a single monitored resource descriptor.

list

 Lists monitored resource descriptors that match a filter.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-23 UTC.