REST Resource: services

• Resource: Service
  • JSON representation
• Custom
• AppEngine
  • JSON representation
• CloudEndpoints
  • JSON representation
• ClusterIstio
  • JSON representation
• Telemetry
  • JSON representation
• Methods

Resource: Service

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

JSON representation
{ "name": string, "displayName": string, "telemetry": { object (Telemetry) }, // Union field identifier can be only one of the following: "custom": { object (Custom) }, "appEngine": { object (AppEngine) }, "cloudEndpoints": { object (CloudEndpoints) }, "clusterIstio": { object (ClusterIstio) } // End of list of possible types for union field identifier. }

Fields
name	string Resource name for this Service. Of the form projects/{project_id}/services/{serviceId}.
displayName	string Name used for UI elements listing this Service.
telemetry	object (Telemetry) Configuration for how to query telemetry on a Service.
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.
cloudEndpoints	object (CloudEndpoints) Type used for Cloud Endpoints services.
clusterIstio	object (ClusterIstio) Type used for Istio services that live in a Kubernetes cluster.

Custom

Custom view of service telemetry. Currently a place-holder pending final design.

AppEngine

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

JSON representation
{ "moduleId": string }

Fields
moduleId	string The ID of the App Engine module underlying this service. Corresponds to the moduleId resource label in the gae_app monitored resource: https://cloud.google.com/monitoring/api/resources#tag_gae_app

CloudEndpoints

Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints.

JSON representation
{ "service": string }

Fields
service	string The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource: https://cloud.google.com/monitoring/api/resources#tag_api

ClusterIstio

Istio service. Learn more at http://istio.io.

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

Telemetry

Configuration for how to query telemetry on a Service.

JSON representation
{ "resourceName": string }

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

Methods
create	Create a Service.
delete	Soft delete this Service.
get	Get the named Service.
list	List Services for this workspace.
patch	Update this Service.