List
|
|||||
|
|
||||
Lists the monitored resources that are members of a group
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and write monitoring data for all of your Google and third-party Cloud and API projects
- View monitoring data for all of your Google Cloud and third-party projects
Input
This building block consumes 6 input parameters
| Name | Format | Description |
|---|---|---|
name Required |
STRING |
The group whose members are listed. The format is "projects/{project_id_or_number}/groups/{group_id}" |
interval.endTime |
ANY |
Required. The end of the time interval |
filter |
STRING |
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: resource.type = "gce_instance" |
pageToken |
STRING |
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 |
pageSize |
INTEGER |
A positive number that is the maximum number of results to return |
interval.startTime |
ANY |
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 |
= Parameter name
= Format
|
name STRING Required The group whose members are listed. The format is "projects/{project_id_or_number}/groups/{group_id}" |
|
interval.endTime ANY Required. The end of the time interval |
|
filter STRING 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: resource.type = "gce_instance" |
|
pageToken STRING 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 |
|
pageSize INTEGER A positive number that is the maximum number of results to return |
|
interval.startTime ANY 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 |
Output
This building block provides 6 output parameters
| Name | Format | Description |
|---|---|---|
members[] |
OBJECT |
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": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }} |
members[].type |
STRING |
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. For a list of types, see Monitoring resource types and Logging resource types |
members[].labels |
OBJECT |
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" |
members[].labels.customKey.value |
STRING |
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" |
nextPageToken |
STRING |
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 |
totalSize |
INTEGER |
The total number of elements matching this request |
= Parameter name
= Format
|
members[] OBJECT 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": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }} |
|
members[].type STRING 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. For a list of types, see Monitoring resource types and Logging resource types |
|
members[].labels OBJECT 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" |
|
members[].labels.customKey.value STRING 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" |
|
nextPageToken STRING 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 |
|
totalSize INTEGER The total number of elements matching this request |