REST Resource: services

Resource: Service

AService is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia). In Cloud Monitoring, aService acts as the root resource under which operational aspects of the service are accessible.

JSON representation

JSON representation
{"name":string,"displayName":string,"basicService":{object (`BasicService`)},"telemetry":{object (`Telemetry`)},"userLabels":{string:string,...},// Union field`identifier` can be only one of the following:"custom":{object (`Custom`)},"appEngine":{object (`AppEngine`)},"clusterIstio":{object (`ClusterIstio`)},"meshIstio":{object (`MeshIstio`)},"istioCanonicalService":{object (`IstioCanonicalService`)},"cloudRun":{object (`CloudRun`)},"gkeNamespace":{object (`GkeNamespace`)},"gkeWorkload":{object (`GkeWorkload`)},"gkeService":{object (`GkeService`)}// End of list of possible types for union field`identifier`.}

{"name":string,"displayName":string,"basicService":{object (BasicService)},"telemetry":{object (Telemetry)},"userLabels":{string:string,...},// Union fieldidentifier can be only one of the following:"custom":{object (Custom)},"appEngine":{object (AppEngine)},"clusterIstio":{object (ClusterIstio)},"meshIstio":{object (MeshIstio)},"istioCanonicalService":{object (IstioCanonicalService)},"cloudRun":{object (CloudRun)},"gkeNamespace":{object (GkeNamespace)},"gkeWorkload":{object (GkeWorkload)},"gkeService":{object (GkeService)}// End of list of possible types for union fieldidentifier.}

Fields
`name`	`string` Identifier. Resource name for this Service. The format is: `projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]`
`displayName`	`string` Name used for UI elements listing this Service.
`basicService`	`object (BasicService)` Message that contains the service type and service labels of this service if it is a basic service. Documentation and exampleshere.
`telemetry`	`object (Telemetry)` Configuration for how to query telemetry on a Service.
`userLabels`	`map (key: string, value: string)` Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
Union field`identifier`. REQUIRED. Service-identifying atoms specifying the underlying service.`identifier` can be only one of the following:
`custom`	`object (Custom)` Custom service type.
`appEngine`	`object (AppEngine)` Type used for App Engine services.
`clusterIstio`	`object (ClusterIstio)` Type used for Istio services that live in a Kubernetes cluster.
`meshIstio`	`object (MeshIstio)` Type used for Istio services scoped to an Istio mesh.
`istioCanonicalService`	`object (IstioCanonicalService)` Type used for canonical services scoped to an Istio mesh. Metrics for Istio aredocumented here
`cloudRun`	`object (CloudRun)` Type used for Cloud Run services.
`gkeNamespace`	`object (GkeNamespace)` Type used for GKE Namespaces.
`gkeWorkload`	`object (GkeWorkload)` Type used for GKE Workloads.
`gkeService`	`object (GkeService)` Type used for GKE Services (the Kubernetes concept of a service).

Custom

This type has no fields.

Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service.

AppEngine

App Engine service. Learn more athttps://cloud.google.com/appengine.

JSON representation
{"moduleId":string}

Fields

Fields
`moduleId`	`string` The ID of the App Engine module underlying this service. Corresponds to the`module_id` resource label in the`gae_app` monitored resource.

moduleId

string

The ID of the App Engine module underlying this service. Corresponds to themodule_id resource label in thegae_app monitored resource.

ClusterIstio

Istio service scoped to a single Kubernetes cluster. Learn more athttps://istio.io. Clusters running OSS Istio will have their services ingested as this type.

JSON representation
{"location":string,"clusterName":string,"serviceNamespace":string,"serviceName":string}

Fields
`location`	`string` The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the`location` resource label in`k8s_cluster` resources.
`clusterName`	`string` The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the`cluster_name` resource label in`k8s_cluster` resources.
`serviceNamespace`	`string` The namespace of the Istio service underlying this service. Corresponds to the`destination_service_namespace` metric label in Istio metrics.
`serviceName`	`string` The name of the Istio service underlying this service. Corresponds to the`destination_service_name` metric label in Istio metrics.

MeshIstio

Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type.

JSON representation
{"meshUid":string,"serviceNamespace":string,"serviceName":string}

Fields

Fields
`meshUid`	`string` Identifier for the mesh in which this Istio service is defined. Corresponds to the`meshUid` metric label in Istio metrics.
`serviceNamespace`	`string` The namespace of the Istio service underlying this service. Corresponds to the`destination_service_namespace` metric label in Istio metrics.
`serviceName`	`string` The name of the Istio service underlying this service. Corresponds to the`destination_service_name` metric label in Istio metrics.

meshUid

string

Identifier for the mesh in which this Istio service is defined. Corresponds to themeshUid metric label in Istio metrics.

serviceNamespace

string

The namespace of the Istio service underlying this service. Corresponds to thedestination_service_namespace metric label in Istio metrics.

serviceName

string

The name of the Istio service underlying this service. Corresponds to thedestination_service_name metric label in Istio metrics.

IstioCanonicalService

Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type.

JSON representation
{"meshUid":string,"canonicalServiceNamespace":string,"canonicalService":string}

Fields

Fields
`meshUid`	`string` Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the`meshUid` metric label inIstio metrics.
`canonicalServiceNamespace`	`string` The namespace of the canonical service underlying this service. Corresponds to the`destination_canonical_service_namespace` metric label inIstio metrics.
`canonicalService`	`string` The name of the canonical service underlying this service. Corresponds to the`destination_canonical_service_name` metric label in label inIstio metrics.

meshUid

string

Identifier for the Istio mesh in which this canonical service is defined. Corresponds to themeshUid metric label inIstio metrics.

canonicalServiceNamespace

string

The namespace of the canonical service underlying this service. Corresponds to thedestination_canonical_service_namespace metric label inIstio metrics.

canonicalService

string

The name of the canonical service underlying this service. Corresponds to thedestination_canonical_service_name metric label in label inIstio metrics.

CloudRun

Cloud Run service. Learn more athttps://cloud.google.com/run.

JSON representation
{"serviceName":string,"location":string}

Fields

Fields
`serviceName`	`string` The name of the Cloud Run service. Corresponds to the`service_name` resource label in the`cloud_run_revision` monitored resource.
`location`	`string` The location the service is run. Corresponds to the`location` resource label in the`cloud_run_revision` monitored resource.

serviceName

string

The name of the Cloud Run service. Corresponds to theservice_name resource label in thecloud_run_revision monitored resource.

location

string

The location the service is run. Corresponds to thelocation resource label in thecloud_run_revision monitored resource.

GkeNamespace

GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example,k8s_container ork8s_pod).

JSON representation
{"projectId":string,"location":string,"clusterName":string,"namespaceName":string}

Fields
`projectId`	`string` Output only. The project this resource lives in. For legacy services migrated from the`Custom` type, this may be a distinct project from the one parenting the service itself.
`location`	`string` The location of the parent cluster. This may be a zone or region.
`clusterName`	`string` The name of the parent cluster.
`namespaceName`	`string` The name of this namespace.

GkeWorkload

A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example,k8s_container ork8s_pod).

JSON representation
{"projectId":string,"location":string,"clusterName":string,"namespaceName":string,"topLevelControllerType":string,"topLevelControllerName":string}

Fields
`projectId`	`string` Output only. The project this resource lives in. For legacy services migrated from the`Custom` type, this may be a distinct project from the one parenting the service itself.
`location`	`string` The location of the parent cluster. This may be a zone or region.
`clusterName`	`string` The name of the parent cluster.
`namespaceName`	`string` The name of the parent namespace.
`topLevelControllerType`	`string` The type of this workload (for example, "Deployment" or "DaemonSet")
`topLevelControllerName`	`string` The name of this workload.

GkeService

GKE Service. The "service" here represents aKubernetes service object. The field names correspond to the resource labels onk8s_service monitored resources.

JSON representation
{"projectId":string,"location":string,"clusterName":string,"namespaceName":string,"serviceName":string}

Fields
`projectId`	`string` Output only. The project this resource lives in. For legacy services migrated from the`Custom` type, this may be a distinct project from the one parenting the service itself.
`location`	`string` The location of the parent cluster. This may be a zone or region.
`clusterName`	`string` The name of the parent cluster.
`namespaceName`	`string` The name of the parent namespace.
`serviceName`	`string` The name of this service.

BasicService

A well-known service type, defined by its service type and service labels. Documentation and exampleshere.

JSON representation
{"serviceType":string,"serviceLabels":{string:string,...}}

Fields

Fields
`serviceType`	`string` The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid valueshere.
`serviceLabels`	`map (key: string, value: string)` Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this`Service`. Documentation and valid values for given service typeshere.

serviceType

string

The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid valueshere.

serviceLabels

map (key: string, value: string)

Labels that specify the resource that emits the monitoring data which is used for SLO reporting of thisService. Documentation and valid values for given service typeshere.

Telemetry

Configuration for how to query telemetry on a Service.

JSON representation
{"resourceName":string}

Fields

Fields
`resourceName`	`string` The full name of the resource that defines this service. Formatted as described inhttps://cloud.google.com/apis/design/resourceNames.

resourceName

string

The full name of the resource that defines this service. Formatted as described inhttps://cloud.google.com/apis/design/resourceNames.

Methods
`create`	Create a`Service`.
`delete`	Soft delete this`Service`.
`get`	Get the named`Service`.
`list`	List`Service`s for this Metrics Scope.
`patch`	Update this`Service`.

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.

Movatterモバイル変換

REST Resource: services

Resource: Service

Custom

AppEngine

ClusterIstio

MeshIstio

IstioCanonicalService

CloudRun

GkeNamespace

GkeWorkload

GkeService

BasicService

Telemetry

Methods

`create`

`delete`

`get`

`list`

`patch`

Movatterモバイル変換

REST Resource: services Stay organized with collections Save and categorize content based on your preferences.

Resource: Service

Custom

AppEngine

ClusterIstio

MeshIstio

IstioCanonicalService

CloudRun

GkeNamespace

GkeWorkload

GkeService

BasicService

Telemetry

Methods

create

delete

get

list

patch

REST Resource: services

`create`

`delete`

`get`

`list`

`patch`