list(project, metric, youngest, count=None, timespan=None, labels=None, pageToken=None, oldest=None)
List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.
list_next(previous_request, previous_response)
Retrieves the next page of results.
list(project, metric, youngest, count=None, timespan=None, labels=None, pageToken=None, oldest=None)
List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.
Args:
project: string, The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name. (required)
metric: string, Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count. (required)
youngest: string, End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp. (required)
count: integer, Maximum number of time series descriptors per page. Used for pagination. If not specified, count = 100.
timespan: string, Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units:
- s: second
- m: minute
- h: hour
- d: day
- w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.
If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].
labels: string, A collection of labels for the matching time series, which are represented as:
- key==value: key equals the value
- key=~value: key regex matches the value
- key!=value: key does not equal the value
- key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify:
label=cloud.googleapis.com%2Flocation=~us-central1.* (repeated)
pageToken: string, The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.
oldest: string, Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]
Returns:
An object of the form:
{ # The response of cloudmonitoring.timeseriesDescriptors.list
"nextPageToken": "A String", # Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set this value to the pageToken query parameter.
"youngest": "A String", # The youngest timestamp of the interval of this query, as an RFC 3339 string.
"kind": "cloudmonitoring#listTimeseriesDescriptorsResponse", # Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesDescriptorsResponse".
"oldest": "A String", # The oldest timestamp of the interval of this query, as an RFC 3339 string.
"timeseries": [ # The returned time series descriptors.
{ # TimeseriesDescriptor identifies a single time series.
"project": "A String", # The Developers Console project number to which this time series belongs.
"metric": "A String", # The name of the metric.
"labels": { # The label's name.
"a_key": "A String", # The label's name.
},
},
],
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.