mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 04:10:02 +01:00
384 lines
19 KiB
HTML
384 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-monitoring3-cli/projects_groups-list/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Groups List - Monitoring v5.0.4+20240225</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Groups List";
|
|
var mkdocs_page_input_path = "projects_groups-list.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-monitoring3-cli/projects_groups-list/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Monitoring v5.0.4+20240225
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Folders</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_time-series-list/">Time Series List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Organizations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_time-series-list/">Time Series List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_alert-policies-create/">Alert Policies Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_alert-policies-delete/">Alert Policies Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_alert-policies-get/">Alert Policies Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_alert-policies-list/">Alert Policies List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_alert-policies-patch/">Alert Policies Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_collectd-time-series-create/">Collectd Time Series Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-create/">Groups Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-delete/">Groups Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-get/">Groups Get</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Groups List</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-members-list/">Groups Members List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-update/">Groups Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_metric-descriptors-create/">Metric Descriptors Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_metric-descriptors-delete/">Metric Descriptors Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_metric-descriptors-get/">Metric Descriptors Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_metric-descriptors-list/">Metric Descriptors List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_monitored-resource-descriptors-get/">Monitored Resource Descriptors Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_monitored-resource-descriptors-list/">Monitored Resource Descriptors List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channel-descriptors-get/">Notification Channel Descriptors Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channel-descriptors-list/">Notification Channel Descriptors List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-create/">Notification Channels Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-delete/">Notification Channels Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-get/">Notification Channels Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-get-verification-code/">Notification Channels Get Verification Code</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-list/">Notification Channels List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-patch/">Notification Channels Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-send-verification-code/">Notification Channels Send Verification Code</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-verify/">Notification Channels Verify</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_snoozes-create/">Snoozes Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_snoozes-get/">Snoozes Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_snoozes-list/">Snoozes List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_snoozes-patch/">Snoozes Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_time-series-create/">Time Series Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_time-series-create-service/">Time Series Create Service</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_time-series-list/">Time Series List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_time-series-query/">Time Series Query</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_uptime-check-configs-create/">Uptime Check Configs Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_uptime-check-configs-delete/">Uptime Check Configs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_uptime-check-configs-get/">Uptime Check Configs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_uptime-check-configs-list/">Uptime Check Configs List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_uptime-check-configs-patch/">Uptime Check Configs Patch</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Services</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_service-level-objectives-create/">Service Level Objectives Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_service-level-objectives-delete/">Service Level Objectives Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_service-level-objectives-get/">Service Level Objectives Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_service-level-objectives-list/">Service Level Objectives List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_service-level-objectives-patch/">Service Level Objectives Patch</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Uptime Check Ips</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../uptime-check-ips_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Monitoring v5.0.4+20240225</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Projects »</li>
|
|
<li>Groups List</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/monitoring3-cli/edit/master/docs/projects_groups-list.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Lists the existing groups.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
|
<li><em>https://www.googleapis.com/auth/monitoring</em></li>
|
|
<li><em>https://www.googleapis.com/auth/monitoring.read</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>monitoring3 --scope <scope> projects groups-list ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p ancestors-of-group=string</strong></p>
|
|
<ul>
|
|
<li>A group name. The format is: 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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p children-of-group=string</strong></p>
|
|
<ul>
|
|
<li>A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p descendants-of-group=string</strong></p>
|
|
<ul>
|
|
<li>A group name. The format is: 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 children_of_group filter, and includes children-of-children, and so forth.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p page-size=integer</strong></p>
|
|
<ul>
|
|
<li>A positive number that is the maximum number of results to return.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p page-token=string</strong></p>
|
|
<ul>
|
|
<li>If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../projects_groups-get/" class="btn btn-neutral float-left" title="Groups Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_groups-members-list/" class="btn btn-neutral float-right" title="Groups Members List">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/monitoring3-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_groups-get/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_groups-members-list/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|