Google Git
Sign in
code / google-api-go-client / 9e2045da407b8bc1df9bc5c14d4d1a7e7e182e05 / . / monitoring / v3 / monitoring-api.json
blob: 77705e94ce217ada8fd73da3cf9e16df72918319 [file] [log] [blame]
{
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"timeSeries": {
"methods": {
"create": {
"path": "v3/{+name}/timeSeries",
"id": "monitoring.projects.timeSeries.create",
"request": {
"$ref": "CreateTimeSeriesRequest"
},
"description": "Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
],
"flatPath": "v3/projects/{projectsId}/timeSeries"
},
"list": {
"id": "monitoring.projects.timeSeries.list",
"path": "v3/{+name}/timeSeries",
"description": "Lists time series that match a filter. This method does not require a Stackdriver account.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "ListTimeSeriesResponse"
},
"parameters": {
"aggregation.perSeriesAligner": {
"description": "The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
"type": "string",
"location": "query",
"enum": [
"ALIGN_NONE",
"ALIGN_DELTA",
"ALIGN_RATE",
"ALIGN_INTERPOLATE",
"ALIGN_NEXT_OLDER",
"ALIGN_MIN",
"ALIGN_MAX",
"ALIGN_MEAN",
"ALIGN_COUNT",
"ALIGN_SUM",
"ALIGN_STDDEV",
"ALIGN_COUNT_TRUE",
"ALIGN_FRACTION_TRUE",
"ALIGN_PERCENTILE_99",
"ALIGN_PERCENTILE_95",
"ALIGN_PERCENTILE_50",
"ALIGN_PERCENTILE_05"
]
},
"pageToken": {
"location": "query",
"description": "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.",
"type": "string"
},
"interval.startTime": {
"location": "query",
"description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
"format": "google-datetime",
"type": "string"
},
"view": {
"location": "query",
"enum": [
"FULL",
"HEADERS"
],
"description": "Specifies which information is returned about the time series.",
"type": "string"
},
"name": {
"description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
},
"aggregation.groupByFields": {
"repeated": true,
"location": "query",
"description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
"type": "string"
},
"interval.endTime": {
"description": "Required. The end of the time interval.",
"format": "google-datetime",
"type": "string",
"location": "query"
},
"aggregation.alignmentPeriod": {
"description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
"format": "google-duration",
"type": "string",
"location": "query"
},
"pageSize": {
"description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
"format": "int32",
"type": "integer",
"location": "query"
},
"orderBy": {
"location": "query",
"description": "Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.",
"type": "string"
},
"aggregation.crossSeriesReducer": {
"location": "query",
"enum": [
"REDUCE_NONE",
"REDUCE_MEAN",
"REDUCE_MIN",
"REDUCE_MAX",
"REDUCE_SUM",
"REDUCE_STDDEV",
"REDUCE_COUNT",
"REDUCE_COUNT_TRUE",
"REDUCE_FRACTION_TRUE",
"REDUCE_PERCENTILE_99",
"REDUCE_PERCENTILE_95",
"REDUCE_PERCENTILE_50",
"REDUCE_PERCENTILE_05"
],
"description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
"type": "string"
},
"filter": {
"description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
],
"flatPath": "v3/projects/{projectsId}/timeSeries"
}
}
},
"uptimeCheckConfigs": {
"methods": {
"create": {
"response": {
"$ref": "UptimeCheckConfig"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "The project in which to create the uptime check. The format is:projects/[PROJECT_ID].",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring"
],
"flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
"path": "v3/{+parent}/uptimeCheckConfigs",
"id": "monitoring.projects.uptimeCheckConfigs.create",
"request": {
"$ref": "UptimeCheckConfig"
},
"description": "Creates a new uptime check configuration."
},
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
"location": "path",
"description": "The uptime check configuration to delete. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring"
],
"flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
"path": "v3/{+name}",
"id": "monitoring.projects.uptimeCheckConfigs.delete",
"description": "Deletes an uptime check configuration. Note that this method will fail if the uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion."
},
"list": {
"response": {
"$ref": "ListUptimeCheckConfigsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
],
"parameters": {
"pageToken": {
"description": "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 more results from the previous method call.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned.",
"format": "int32",
"type": "integer"
},
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "The project whose uptime check configurations are listed. The format isprojects/[PROJECT_ID].",
"required": true,
"type": "string"
},
"filter": {
"location": "query",
"description": "If provided, specifies the criteria that must be met by uptime check configurations in the provided project to be included in the response. One of the following filters can be provided. uptime_check_config.id = {uptime_check_id} resource.type = gce_instance AND resource.label.instance_id = {instance_id} resource.type = aws_ec2_instance AND resource.label.instance_id = {instance_id} resource.type = aws_elb_load_balancer AND resource.label.name = {name} resource.type = gae_app AND resource.label.module_id = {module_id} resource.type = uptime_url AND resource.label.host = {host} group.id = {group_id}",
"type": "string"
}
},
"flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
"path": "v3/{+parent}/uptimeCheckConfigs",
"id": "monitoring.projects.uptimeCheckConfigs.list",
"description": "Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations."
},
"get": {
"parameters": {
"name": {
"pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
"location": "path",
"description": "The uptime check configuration to retrieve. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
],
"flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
"path": "v3/{+name}",
"id": "monitoring.projects.uptimeCheckConfigs.get",
"description": "Gets a single uptime check configuration.",
"response": {
"$ref": "UptimeCheckConfig"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET"
},
"patch": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring"
],
"parameters": {
"updateMask": {
"location": "query",
"description": "Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.",
"format": "google-fieldmask",
"type": "string"
},
"name1": {
"location": "query",
"description": "The uptime check configuration to update. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
"type": "string"
},
"name": {
"description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
"location": "path"
}
},
"flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
"path": "v3/{+name}",
"id": "monitoring.projects.uptimeCheckConfigs.patch",
"description": "Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via \"updateMask\". Returns the updated configuration.",
"request": {
"$ref": "UptimeCheckConfig"
},
"response": {
"$ref": "UptimeCheckConfig"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH"
}
}
},
"monitoredResourceDescriptors": {
"methods": {
"list": {
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "ListMonitoredResourceDescriptorsResponse"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
"required": true,
"type": "string"
},
"pageToken": {
"description": "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.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"description": "A positive number that is the maximum number of results to return.",
"format": "int32",
"type": "integer"
},
"filter": {
"description": "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:\nresource.type = starts_with(\"gce_\") AND resource.label:id\n",
"type": "string",
"location": "query"
}
},
"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"
],
"flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors",
"id": "monitoring.projects.monitoredResourceDescriptors.list",
"path": "v3/{+name}/monitoredResourceDescriptors",
"description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account."
},
"get": {
"description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "MonitoredResourceDescriptor"
},
"parameters": {
"name": {
"description": "The monitored resource descriptor to get. The format is \"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}\". The {resource_type} is a predefined type, such as cloudsql_database.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/monitoredResourceDescriptors/[^/]+$",
"location": "path"
}
},
"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"
],
"flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}",
"id": "monitoring.projects.monitoredResourceDescriptors.get",
"path": "v3/{+name}"
}
}
},
"groups": {
"methods": {
"create": {
"request": {
"$ref": "Group"
},
"description": "Creates a new group.",
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Group"
},
"parameters": {
"name": {
"description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
},
"validateOnly": {
"description": "If true, validate this request but do not create the group.",
"type": "boolean",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring"
],
"flatPath": "v3/projects/{projectsId}/groups",
"id": "monitoring.projects.groups.create",
"path": "v3/{+name}/groups"
},
"delete": {
"description": "Deletes an existing group.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/groups/[^/]+$",
"location": "path",
"description": "The group to delete. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring"
],
"flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
"path": "v3/{+name}",
"id": "monitoring.projects.groups.delete"
},
"list": {
"response": {
"$ref": "ListGroupsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
],
"parameters": {
"pageToken": {
"location": "query",
"description": "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.",
"type": "string"
},
"pageSize": {
"description": "A positive number that is the maximum number of results to return.",
"format": "int32",
"type": "integer",
"location": "query"
},
"ancestorsOfGroup": {
"location": "query",
"description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.",
"type": "string"
},
"name": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "The project whose groups are to be listed. The format is \"projects/{project_id_or_number}\".",
"required": true,
"type": "string"
},
"childrenOfGroup": {
"description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.",
"type": "string",
"location": "query"
},
"descendantsOfGroup": {
"description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.",
"type": "string",
"location": "query"
}
},
"flatPath": "v3/projects/{projectsId}/groups",
"path": "v3/{+name}/groups",
"id": "monitoring.projects.groups.list",
"description": "Lists the existing groups."
},
"get": {
"parameters": {
"name": {
"pattern": "^projects/[^/]+/groups/[^/]+$",
"location": "path",
"description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
],
"flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
"path": "v3/{+name}",
"id": "monitoring.projects.groups.get",
"description": "Gets a single group.",
"response": {
"$ref": "Group"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET"
},
"update": {
"parameters": {
"name": {
"pattern": "^projects/[^/]+/groups/[^/]+$",
"location": "path",
"description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
"required": true,
"type": "string"
},
"validateOnly": {
"location": "query",
"description": "If true, validate this request but do not update the existing group.",
"type": "boolean"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring"
],
"flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
"id": "monitoring.projects.groups.update",
"path": "v3/{+name}",
"request": {
"$ref": "Group"
},
"description": "Updates an existing group. You can change any group attributes except name.",
"httpMethod": "PUT",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Group"
}
}
},
"resources": {
"members": {
"methods": {
"list": {
"parameters": {
"pageToken": {
"description": "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.",
"type": "string",
"location": "query"
},
"interval.startTime": {
"location": "query",
"description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
"format": "google-datetime",
"type": "string"
},
"pageSize": {
"description": "A positive number that is the maximum number of results to return.",
"format": "int32",
"type": "integer",
"location": "query"
},
"name": {
"description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/groups/[^/]+$",
"location": "path"
},
"interval.endTime": {
"location": "query",
"description": "Required. The end of the time interval.",
"format": "google-datetime",
"type": "string"
},
"filter": {
"location": "query",
"description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
],
"flatPath": "v3/projects/{projectsId}/groups/{groupsId}/members",
"id": "monitoring.projects.groups.members.list",
"path": "v3/{+name}/members",
"description": "Lists the monitored resources that are members of a group.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "ListGroupMembersResponse"
}
}
}
}
}
},
"collectdTimeSeries": {
"methods": {
"create": {
"description": "Stackdriver Monitoring Agent only: Creates a new time series.\u003caside class=\"caution\"\u003eThis method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.\u003c/aside\u003e",
"request": {
"$ref": "CreateCollectdTimeSeriesRequest"
},
"response": {
"$ref": "CreateCollectdTimeSeriesResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".",
"required": true,
"type": "string"
}
},
"flatPath": "v3/projects/{projectsId}/collectdTimeSeries",
"path": "v3/{+name}/collectdTimeSeries",
"id": "monitoring.projects.collectdTimeSeries.create"
}
}
},
"metricDescriptors": {
"methods": {
"create": {
"parameters": {
"name": {
"description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
],
"flatPath": "v3/projects/{projectsId}/metricDescriptors",
"id": "monitoring.projects.metricDescriptors.create",
"path": "v3/{+name}/metricDescriptors",
"request": {
"$ref": "MetricDescriptor"
},
"description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.",
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "MetricDescriptor"
}
},
"delete": {
"id": "monitoring.projects.metricDescriptors.delete",
"path": "v3/{+name}",
"description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+/metricDescriptors/.+$",
"location": "path",
"description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring"
],
"flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}"
},
"list": {
"parameters": {
"filter": {
"location": "query",
"description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:\nmetric.type = starts_with(\"custom.googleapis.com/\")\n",
"type": "string"
},
"name": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
"required": true,
"type": "string"
},
"pageToken": {
"description": "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.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"description": "A positive number that is the maximum number of results to return.",
"format": "int32",
"type": "integer"
}
},
"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"
],
"flatPath": "v3/projects/{projectsId}/metricDescriptors",
"path": "v3/{+name}/metricDescriptors",
"id": "monitoring.projects.metricDescriptors.list",
"description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account.",
"response": {
"$ref": "ListMetricDescriptorsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET"
},
"get": {
"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"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/metricDescriptors/.+$",
"location": "path",
"description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".",
"required": true,
"type": "string"
}
},
"flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
"path": "v3/{+name}",
"id": "monitoring.projects.metricDescriptors.get",
"description": "Gets a single metric descriptor. This method does not require a Stackdriver account.",
"response": {
"$ref": "MetricDescriptor"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET"
}
}
}
}
},
"uptimeCheckIps": {
"methods": {
"list": {
"path": "v3/uptimeCheckIps",
"id": "monitoring.uptimeCheckIps.list",
"description": "Returns the list of IPs that checkers run from",
"response": {
"$ref": "ListUptimeCheckIpsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read"
],
"parameters": {
"pageToken": {
"description": "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 more results from the previous method call. NOTE: this field is not yet implemented",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented",
"format": "int32",
"type": "integer"
}
},
"flatPath": "v3/uptimeCheckIps"
}
}
}
},
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
]
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"pp": {
"location": "query",
"description": "Pretty-print response.",
"type": "boolean",
"default": "true"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
}
},
"version": "v3",
"baseUrl": "https://monitoring.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.",
"servicePath": "",
"basePath": "",
"revision": "20171010",
"documentationLink": "https://cloud.google.com/monitoring/api/",
"id": "monitoring:v3",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"ResourceGroup": {
"id": "ResourceGroup",
"description": "The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.",
"type": "object",
"properties": {
"resourceType": {
"enumDescriptions": [
"Default value (not valid).",
"A group of instances (could be either GCE or AWS_EC2).",
"A group of AWS load balancers."
],
"enum": [
"RESOURCE_TYPE_UNSPECIFIED",
"INSTANCE",
"AWS_ELB_LOAD_BALANCER"
],
"description": "The resource type of the group members.",
"type": "string"
},
"groupId": {
"description": "The group of resources being monitored. Should be only the group_id, not projects/\u003cproject_id\u003e/groups/\u003cgroup_id\u003e.",
"type": "string"
}
}
},
"TypedValue": {
"description": "A single strongly-typed value.",
"type": "object",
"properties": {
"distributionValue": {
"$ref": "Distribution",
"description": "A distribution value."
},
"boolValue": {
"description": "A Boolean value: true or false.",
"type": "boolean"
},
"stringValue": {
"description": "A variable-length string value.",
"type": "string"
},
"doubleValue": {
"description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10\u003csup\u003e±300\u003c/sup\u003e and it has 16 significant digits of precision.",
"format": "double",
"type": "number"
},
"int64Value": {
"description": "A 64-bit integer. Its range is approximately ±9.2x10\u003csup\u003e18\u003c/sup\u003e.",
"format": "int64",
"type": "string"
}
},
"id": "TypedValue"
},
"UptimeCheckIp": {
"description": "Contains the region, location, and list of IP addresses where checkers in the location run from.",
"type": "object",
"properties": {
"ipAddress": {
"description": "The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format.",
"type": "string"
},
"region": {
"description": "A broad region category in which the IP address is located.",
"type": "string",
"enumDescriptions": [
"Default value if no region is specified. Will result in uptime checks running from all regions.",
"Allows checks to run from locations within the United States of America.",
"Allows checks to run from locations within the continent of Europe.",
"Allows checks to run from locations within the continent of South America.",
"Allows checks to run from locations within the Asia Pacific area (ex: Singapore)."
],
"enum": [
"REGION_UNSPECIFIED",
"USA",
"EUROPE",
"SOUTH_AMERICA",
"ASIA_PACIFIC"
]
},
"location": {
"description": "A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.",
"type": "string"
}
},
"id": "UptimeCheckIp"
},
"CollectdValueError": {
"description": "Describes the error status for values that were not written.",
"type": "object",
"properties": {
"index": {
"description": "The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads.",
"format": "int32",
"type": "integer"
},
"error": {
"$ref": "Status",
"description": "Records the error status for the value."
}
},
"id": "CollectdValueError"
},
"CollectdPayload": {
"id": "CollectdPayload",
"description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
"type": "object",
"properties": {
"typeInstance": {
"description": "The measurement type instance. Example: \"used\".",
"type": "string"
},
"metadata": {
"additionalProperties": {
"$ref": "TypedValue"
},
"description": "The measurement metadata. Example: \"process_id\" -\u003e 12345",
"type": "object"
},
"type": {
"description": "The measurement type. Example: \"memory\".",
"type": "string"
},
"plugin": {
"description": "The name of the plugin. Example: \"disk\".",
"type": "string"
},
"pluginInstance": {
"description": "The instance name of the plugin Example: \"hdcl\".",
"type": "string"
},
"endTime": {
"description": "The end time of the interval.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "The start time of the interval.",
"format": "google-datetime",
"type": "string"
},
"values": {
"description": "The measured values during this time interval. Each value must have a different dataSourceName.",
"type": "array",
"items": {
"$ref": "CollectdValue"
}
}
}
},
"CreateCollectdTimeSeriesResponse": {
"description": "The CreateCollectdTimeSeries response.",
"type": "object",
"properties": {
"payloadErrors": {
"description": "Records the error status for points that were not written due to an error.Failed requests for which nothing is written will return an error response instead.",
"type": "array",
"items": {
"$ref": "CollectdPayloadError"
}
}
},
"id": "CreateCollectdTimeSeriesResponse"
},
"Linear": {
"id": "Linear",
"description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
"type": "object",
"properties": {
"offset": {
"description": "Lower bound of the first bucket.",
"format": "double",
"type": "number"
},
"numFiniteBuckets": {
"description": "Must be greater than 0.",
"format": "int32",
"type": "integer"
},
"width": {
"description": "Must be greater than 0.",
"format": "double",
"type": "number"
}
}
},
"Option": {
"id": "Option",
"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
"type": "object",
"properties": {
"name": {
"description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, \"map_entry\". For custom options, it should be the fully-qualified name. For example, \"google.api.http\".",
"type": "string"
},
"value": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.",
"type": "object"
}
}
},
"ContentMatcher": {
"id": "ContentMatcher",
"description": "Used to perform string matching. Currently, this matches on the exact content. In the future, it can be expanded to allow for regular expressions and more complex matching.",
"type": "object",
"properties": {
"content": {
"description": "String content to match",
"type": "string"
}
}
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
"type": "object",
"properties": {},
"id": "Empty"
},
"TcpCheck": {
"description": "Information required for a TCP uptime check request.",
"type": "object",
"properties": {
"port": {
"description": "The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL. Required.",
"format": "int32",
"type": "integer"
}
},
"id": "TcpCheck"
},
"Explicit": {
"id": "Explicit",
"description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
"type": "object",
"properties": {
"bounds": {
"description": "The values must be monotonically increasing.",
"type": "array",
"items": {
"format": "double",
"type": "number"
}
}
}
},
"TimeInterval": {
"description": "A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.",
"type": "object",
"properties": {
"endTime": {
"description": "Required. The end of the time interval.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
"format": "google-datetime",
"type": "string"
}
},
"id": "TimeInterval"
},
"ListUptimeCheckIpsResponse": {
"description": "The protocol for the ListUptimeCheckIps response.",
"type": "object",
"properties": {
"uptimeCheckIps": {
"description": "The returned list of IP addresses (including region and location) that the checkers run from.",
"type": "array",
"items": {
"$ref": "UptimeCheckIp"
}
},
"nextPageToken": {
"description": "This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). NOTE: this field is not yet implemented",
"type": "string"
}
},
"id": "ListUptimeCheckIpsResponse"
},
"Exponential": {
"id": "Exponential",
"description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
"type": "object",
"properties": {
"numFiniteBuckets": {
"description": "Must be greater than 0.",
"format": "int32",
"type": "integer"
},
"growthFactor": {
"description": "Must be greater than 1.",
"format": "double",
"type": "number"
},
"scale": {
"description": "Must be greater than 0.",
"format": "double",
"type": "number"
}
}
},
"Point": {
"description": "A single data point in a time series.",
"type": "object",
"properties": {
"interval": {
"$ref": "TimeInterval",
"description": "The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
},
"value": {
"description": "The value of the data point.",
"$ref": "TypedValue"
}
},
"id": "Point"
},
"Metric": {
"id": "Metric",
"description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.",
"type": "object",
"properties": {
"labels": {
"description": "The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"type": {
"description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
"type": "string"
}
}
},
"ListUptimeCheckConfigsResponse": {
"description": "The protocol for the ListUptimeCheckConfigs response.",
"type": "object",
"properties": {
"uptimeCheckConfigs": {
"description": "The returned uptime check configurations.",
"type": "array",
"items": {
"$ref": "UptimeCheckConfig"
}
},
"nextPageToken": {
"description": "This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).",
"type": "string"
}
},
"id": "ListUptimeCheckConfigsResponse"
},
"Field": {
"description": "A single field of a message type.",
"type": "object",
"properties": {
"kind": {
"enumDescriptions": [
"Field type unknown.",
"Field type double.",
"Field type float.",
"Field type int64.",
"Field type uint64.",
"Field type int32.",
"Field type fixed64.",
"Field type fixed32.",
"Field type bool.",
"Field type string.",
"Field type group. Proto2 syntax only, and deprecated.",
"Field type message.",
"Field type bytes.",
"Field type uint32.",
"Field type enum.",
"Field type sfixed32.",
"Field type sfixed64.",
"Field type sint32.",
"Field type sint64."
],
"enum": [
"TYPE_UNKNOWN",
"TYPE_DOUBLE",
"TYPE_FLOAT",
"TYPE_INT64",
"TYPE_UINT64",
"TYPE_INT32",
"TYPE_FIXED64",
"TYPE_FIXED32",
"TYPE_BOOL",
"TYPE_STRING",
"TYPE_GROUP",
"TYPE_MESSAGE",
"TYPE_BYTES",
"TYPE_UINT32",
"TYPE_ENUM",
"TYPE_SFIXED32",
"TYPE_SFIXED64",
"TYPE_SINT32",
"TYPE_SINT64"
],
"description": "The field type.",
"type": "string"
},
"jsonName": {
"description": "The field JSON name.",
"type": "string"
},
"options": {
"description": "The protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
}
},
"oneofIndex": {
"description": "The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.",
"format": "int32",
"type": "integer"
},
"cardinality": {
"enumDescriptions": [
"For fields with unknown cardinality.",
"For optional fields.",
"For required fields. Proto2 syntax only.",
"For repeated fields."
],
"enum": [
"CARDINALITY_UNKNOWN",
"CARDINALITY_OPTIONAL",
"CARDINALITY_REQUIRED",
"CARDINALITY_REPEATED"
],
"description": "The field cardinality.",
"type": "string"
},
"packed": {
"description": "Whether to use alternative packed wire representation.",
"type": "boolean"
},
"defaultValue": {
"description": "The string value of the default value of this field. Proto2 syntax only.",
"type": "string"
},
"name": {
"description": "The field name.",
"type": "string"
},
"typeUrl": {
"description": "The field type URL, without the scheme, for message or enumeration types. Example: \"type.googleapis.com/google.protobuf.Timestamp\".",
"type": "string"
},
"number": {
"description": "The field number.",
"format": "int32",
"type": "integer"
}
},
"id": "Field"
},
"LabelDescriptor": {
"description": "A description of a label.",
"type": "object",
"properties": {
"key": {
"description": "The label key.",
"type": "string"
},
"description": {
"description": "A human-readable description for the label.",
"type": "string"
},
"valueType": {
"enumDescriptions": [
"A variable-length string. This is the default.",
"Boolean; true or false.",
"A 64-bit signed integer."
],
"enum": [
"STRING",
"BOOL",
"INT64"
],
"description": "The type of data that can be assigned to the label.",
"type": "string"
}
},
"id": "LabelDescriptor"
},
"ListTimeSeriesResponse": {
"description": "The ListTimeSeries response.",
"type": "object",
"properties": {
"timeSeries": {
"description": "One or more time series that match the filter included in the request.",
"type": "array",
"items": {
"$ref": "TimeSeries"
}
},
"nextPageToken": {
"description": "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.",
"type": "string"
}
},
"id": "ListTimeSeriesResponse"
},
"Group": {
"description": "The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: \"environment\" and \"role\". A parent group has a filter, environment=\"production\". A child of that parent group has a filter, role=\"transcoder\". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.",
"type": "object",
"properties": {
"name": {
"description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
"type": "string"
},
"parentName": {
"description": "The name of the group's parent, if it has one. The format is \"projects/{project_id_or_number}/groups/{group_id}\". For groups with no parent, parentName is the empty string, \"\".",
"type": "string"
},
"displayName": {
"description": "A user-assigned name for this group, used only for display purposes.",
"type": "string"
},
"isCluster": {
"description": "If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.",
"type": "boolean"
},
"filter": {
"description": "The filter used to determine which monitored resources belong to this group.",
"type": "string"
}
},
"id": "Group"
},
"Type": {
"description": "A protocol buffer message type.",
"type": "object",
"properties": {
"fields": {
"description": "The list of fields.",
"type": "array",
"items": {
"$ref": "Field"
}
},
"name": {
"description": "The fully qualified message name.",
"type": "string"
},
"oneofs": {
"description": "The list of types appearing in oneof definitions in this type.",
"type": "array",
"items": {
"type": "string"
}
},
"syntax": {
"description": "The source syntax.",
"type": "string",
"enumDescriptions": [
"Syntax proto2.",
"Syntax proto3."
],
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
]
},
"sourceContext": {
"description": "The source context.",
"$ref": "SourceContext"
},
"options": {
"description": "The protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
}
}
},
"id": "Type"
},
"BasicAuthentication": {
"description": "A type of authentication to perform against the specified resource or URL that uses username and password. Currently, only Basic authentication is supported in Uptime Monitoring.",
"type": "object",
"properties": {
"password": {
"description": "The password to authenticate.",
"type": "string"
},
"username": {
"description": "The username to authenticate.",
"type": "string"
}
},
"id": "BasicAuthentication"
},
"BucketOptions": {
"description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
"type": "object",
"properties": {
"exponentialBuckets": {
"description": "The exponential buckets.",
"$ref": "Exponential"
},
"linearBuckets": {
"$ref": "Linear",
"description": "The linear bucket."
},
"explicitBuckets": {
"$ref": "Explicit",
"description": "The explicit buckets."
}
},
"id": "BucketOptions"
},
"HttpCheck": {
"description": "Information involved in an HTTP/HTTPS uptime check request.",
"type": "object",
"properties": {
"useSsl": {
"description": "If true, use HTTPS instead of HTTP to run the check.",
"type": "boolean"
},
"maskHeaders": {
"description": "Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.",
"type": "boolean"
},
"authInfo": {
"description": "The authentication information. Optional when creating an HTTP check; defaults to empty.",
"$ref": "BasicAuthentication"
},
"headers": {
"description": "The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"path": {
"description": "The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to \"/\").",
"type": "string"
},
"port": {
"description": "The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).",
"format": "int32",
"type": "integer"
}
},
"id": "HttpCheck"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"type": "array",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
}
},
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
}
},
"id": "Status"
},
"CollectdValue": {
"id": "CollectdValue",
"description": "A single data point from a collectd-based plugin.",
"type": "object",
"properties": {
"value": {
"description": "The measurement value.",
"$ref": "TypedValue"
},
"dataSourceType": {
"description": "The type of measurement.",
"type": "string",
"enumDescriptions": [
"An unspecified data source type. This corresponds to google.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.",
"An instantaneous measurement of a varying quantity. This corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.",
"A cumulative value over time. This corresponds to google.api.MetricDescriptor.MetricKind.CUMULATIVE.",
"A rate of change of the measurement.",
"An amount of change since the last measurement interval. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA."
],
"enum": [
"UNSPECIFIED_DATA_SOURCE_TYPE",
"GAUGE",
"COUNTER",
"DERIVE",
"ABSOLUTE"
]
},
"dataSourceName": {
"description": "The data source for the collectd value. For example there are two data sources for network measurements: \"rx\" and \"tx\".",
"type": "string"
}
}
},
"MetricDescriptor": {
"description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
"type": "object",
"properties": {
"name": {
"description": "The resource name of the metric descriptor.",
"type": "string"
},
"type": {
"description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
"type": "string"
},
"valueType": {
"description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
"type": "string",
"enumDescriptions": [
"Do not use this default value.",
"The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
"The value is a signed 64-bit integer.",
"The value is a double precision floating point number.",
"The value is a text string. This value type can be used only if the metric kind is GAUGE.",
"The value is a Distribution.",
"The value is money."
],
"enum": [
"VALUE_TYPE_UNSPECIFIED",
"BOOL",
"INT64",
"DOUBLE",
"STRING",
"DISTRIBUTION",
"MONEY"
]
},
"metricKind": {
"description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.",
"type": "string",
"enumDescriptions": [
"Do not use this default value.",
"An instantaneous measurement of a value.",
"The change in a value during a time interval.",
"A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
],
"enum": [
"METRIC_KIND_UNSPECIFIED",
"GAUGE",
"DELTA",
"CUMULATIVE"
]
},
"description": {
"description": "A detailed description of the metric, which can be used in documentation.",
"type": "string"
},
"displayName": {
"description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.",
"type": "string"
},
"unit": {
"description": "The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (10**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto (10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:\nExpression = Component { \".\" Component } { \"/\" Component } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.",
"type": "string"
},
"labels": {
"description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.",
"type": "array",
"items": {
"$ref": "LabelDescriptor"
}
}
},
"id": "MetricDescriptor"
},
"SourceContext": {
"id": "SourceContext",
"description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
"type": "object",
"properties": {
"fileName": {
"description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\".",
"type": "string"
}
}
},
"Range": {
"id": "Range",
"description": "The range of the population values.",
"type": "object",
"properties": {
"min": {
"description": "The minimum of the population values.",
"format": "double",
"type": "number"
},
"max": {
"description": "The maximum of the population values.",
"format": "double",
"type": "number"
}
}
},
"UptimeCheckConfig": {
"id": "UptimeCheckConfig",
"description": "This message configures which resources and services to monitor for availability.",
"type": "object",
"properties": {
"tcpCheck": {
"description": "Contains information needed to make a TCP check.",
"$ref": "TcpCheck"
},
"selectedRegions": {
"description": "The list of regions from which the check will be run. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.",
"type": "array",
"items": {
"enum": [
"REGION_UNSPECIFIED",
"USA",
"EUROPE",
"SOUTH_AMERICA",
"ASIA_PACIFIC"
],
"type": "string"
},
"enumDescriptions": [
"Default value if no region is specified. Will result in uptime checks running from all regions.",
"Allows checks to run from locations within the United States of America.",
"Allows checks to run from locations within the continent of Europe.",
"Allows checks to run from locations within the continent of South America.",
"Allows checks to run from locations within the Asia Pacific area (ex: Singapore)."
]
},
"displayName": {
"description": "A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account in order to make it easier to identify; however, uniqueness is not enforced. Required.",
"type": "string"
},
"contentMatchers": {
"description": "The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.",
"type": "array",
"items": {
"$ref": "ContentMatcher"
}
},
"monitoredResource": {
"$ref": "MonitoredResource",
"description": "The monitored resource associated with the configuration."
},
"timeout": {
"description": "The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.",
"format": "google-duration",
"type": "string"
},
"period": {
"description": "How often the uptime check is performed. Currently, only 1, 5, 10, and 15 minutes are supported. Required.",
"format": "google-duration",
"type": "string"
},
"httpCheck": {
"description": "Contains information needed to make an HTTP or HTTPS check.",
"$ref": "HttpCheck"
},
"name": {
"description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.",
"type": "string"
},
"resourceGroup": {
"$ref": "ResourceGroup",
"description": "The group resource associated with the configuration."
}
}
},
"ListGroupsResponse": {
"description": "The ListGroups response.",
"type": "object",
"properties": {
"group": {
"description": "The groups that match the specified filters.",
"type": "array",
"items": {
"$ref": "Group"
}
},
"nextPageToken": {
"description": "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.",
"type": "string"
}
},
"id": "ListGroupsResponse"
},
"CreateCollectdTimeSeriesRequest": {
"description": "The CreateCollectdTimeSeries request.",
"type": "object",
"properties": {
"collectdVersion": {
"description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
"type": "string"
},
"resource": {
"$ref": "MonitoredResource",
"description": "The monitored resource associated with the time series."
},
"collectdPayloads": {
"description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
"type": "array",
"items": {
"$ref": "CollectdPayload"
}
}
},
"id": "CreateCollectdTimeSeriesRequest"
},
"ListGroupMembersResponse": {
"description": "The ListGroupMembers response.",
"type": "object",
"properties": {
"totalSize": {
"description": "The total number of elements matching this request.",
"format": "int32",
"type": "integer"
},
"members": {
"description": "A set of monitored resources in the group.",
"type": "array",
"items": {
"$ref": "MonitoredResource"
}
},
"nextPageToken": {
"description": "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.",
"type": "string"
}
},
"id": "ListGroupMembersResponse"
},
"ListMonitoredResourceDescriptorsResponse": {
"id": "ListMonitoredResourceDescriptorsResponse",
"description": "The ListMonitoredResourceDescriptors response.",
"type": "object",
"properties": {
"resourceDescriptors": {
"description": "The monitored resource descriptors that are available to this project and that match filter, if present.",
"type": "array",
"items": {
"$ref": "MonitoredResourceDescriptor"
}
},
"nextPageToken": {
"description": "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.",
"type": "string"
}
}
},
"TimeSeries": {
"description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.",
"type": "object",
"properties": {
"resource": {
"description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data.",
"$ref": "MonitoredResource"
},
"metricKind": {
"enumDescriptions": [
"Do not use this default value.",
"An instantaneous measurement of a value.",
"The change in a value during a time interval.",
"A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
],
"enum": [
"METRIC_KIND_UNSPECIFIED",
"GAUGE",
"DELTA",
"CUMULATIVE"
],
"description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.",
"type": "string"
},
"metric": {
"$ref": "Metric",
"description": "The associated metric. A fully-specified metric used to identify the time series."
},
"points": {
"description": "The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.",
"type": "array",
"items": {
"$ref": "Point"
}
},
"valueType": {
"enumDescriptions": [
"Do not use this default value.",
"The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
"The value is a signed 64-bit integer.",
"The value is a double precision floating point number.",
"The value is a text string. This value type can be used only if the metric kind is GAUGE.",
"The value is a Distribution.",
"The value is money."
],
"enum": [
"VALUE_TYPE_UNSPECIFIED",
"BOOL",
"INT64",
"DOUBLE",
"STRING",
"DISTRIBUTION",
"MONEY"
],
"description": "The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.",
"type": "string"
}
},
"id": "TimeSeries"
},
"CreateTimeSeriesRequest": {
"id": "CreateTimeSeriesRequest",
"description": "The CreateTimeSeries request.",
"type": "object",
"properties": {
"timeSeries": {
"description": "The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.",
"type": "array",
"items": {
"$ref": "TimeSeries"
}
}
}
},
"Distribution": {
"id": "Distribution",
"description": "Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.",
"type": "object",
"properties": {
"sumOfSquaredDeviation": {
"description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is:\nSum[i=1..n]((x_i - mean)^2)\nKnuth, \"The Art of Computer Programming\", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.",
"format": "double",
"type": "number"
},
"range": {
"description": "If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.",
"$ref": "Range"
},
"count": {
"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided.",
"format": "int64",
"type": "string"
},
"mean": {
"description": "The arithmetic mean of the values in the population. If count is zero then this field must be zero.",
"format": "double",
"type": "number"
},
"bucketCounts": {
"description": "Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.",
"type": "array",
"items": {
"format": "int64",
"type": "string"
}
},
"bucketOptions": {
"description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.",
"$ref": "BucketOptions"
}
}
},
"MonitoredResource": {
"description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
"type": "object",
"properties": {
"labels": {
"description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"type": {
"description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
"type": "string"
}
},
"id": "MonitoredResource"
},
"ListMetricDescriptorsResponse": {
"description": "The ListMetricDescriptors response.",
"type": "object",
"properties": {
"metricDescriptors": {
"description": "The metric descriptors that are available to the project and that match the value of filter, if present.",
"type": "array",
"items": {
"$ref": "MetricDescriptor"
}
},
"nextPageToken": {
"description": "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.",
"type": "string"
}
},
"id": "ListMetricDescriptorsResponse"
},
"CollectdPayloadError": {
"id": "CollectdPayloadError",
"description": "Describes the error status for payloads that were not written.",
"type": "object",
"properties": {
"index": {
"description": "The zero-based index in CreateCollectdTimeSeriesRequest.collectd_payloads.",
"format": "int32",
"type": "integer"
},
"error": {
"$ref": "Status",
"description": "Records the error status for the payload. If this field is present, the partial errors for nested values won't be populated."
},
"valueErrors": {
"description": "Records the error status for values that were not written due to an error.Failed payloads for which nothing is written will not include partial value errors.",
"type": "array",
"items": {
"$ref": "CollectdValueError"
}
}
}
},
"MonitoredResourceDescriptor": {
"description": "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 \"instance_id\" 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.",
"type": "object",
"properties": {
"labels": {
"description": "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\".",
"type": "array",
"items": {
"$ref": "LabelDescriptor"
}
},
"name": {
"description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} 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"
},
"displayName": {
"description": "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\".",
"type": "string"
},
"description": {
"description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
"type": "string"
},
"type": {
"description": "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.",
"type": "string"
}
},
"id": "MonitoredResourceDescriptor"
}
},
"protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"canonicalName": "Monitoring",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/monitoring.write": {
"description": "Publish metric data to your Google Cloud projects"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/monitoring.read": {
"description": "View monitoring data for all of your Google Cloud and third-party projects"
},
"https://www.googleapis.com/auth/monitoring": {
"description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
}
}
}
},
"rootUrl": "https://monitoring.googleapis.com/",
"ownerDomain": "google.com",
"name": "monitoring",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Stackdriver Monitoring API"
}