mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
522 lines
23 KiB
HTML
522 lines
23 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Monitoring v3.0.0+20220218</title>
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="./css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="./css/highlight.css">
|
|
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
|
<script type="text/javascript" src="./js/highlight.pack.js"></script>
|
|
<script src="./js/theme.js"></script>
|
|
|
|
<style>
|
|
body {font-size: 90%;}
|
|
pre, code {font-size: 100%;}
|
|
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
|
</style>
|
|
</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-nav-search">
|
|
<a href="." class="icon icon-home"> Monitoring v3.0.0+20220218</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Folders</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="folders_time-series-list/">Time Series List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Organizations</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="organizations_time-series-list/">Time Series List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Projects</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_alert-policies-create/">Alert Policies Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_alert-policies-delete/">Alert Policies Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_alert-policies-get/">Alert Policies Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_alert-policies-list/">Alert Policies List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_alert-policies-patch/">Alert Policies Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_collectd-time-series-create/">Collectd Time Series Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_groups-create/">Groups Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_groups-delete/">Groups Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_groups-get/">Groups Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_groups-list/">Groups List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_groups-members-list/">Groups Members List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_groups-update/">Groups Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_metric-descriptors-create/">Metric Descriptors Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_metric-descriptors-delete/">Metric Descriptors Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_metric-descriptors-get/">Metric Descriptors Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_metric-descriptors-list/">Metric Descriptors List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_monitored-resource-descriptors-get/">Monitored Resource Descriptors Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_monitored-resource-descriptors-list/">Monitored Resource Descriptors List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_notification-channel-descriptors-get/">Notification Channel Descriptors Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_notification-channel-descriptors-list/">Notification Channel Descriptors List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_notification-channels-create/">Notification Channels Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_notification-channels-delete/">Notification Channels Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_notification-channels-get/">Notification Channels Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_notification-channels-get-verification-code/">Notification Channels Get Verification Code</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_notification-channels-list/">Notification Channels List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_notification-channels-patch/">Notification Channels Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_notification-channels-send-verification-code/">Notification Channels Send Verification Code</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_notification-channels-verify/">Notification Channels Verify</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_time-series-create/">Time Series Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_time-series-create-service/">Time Series Create Service</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_time-series-list/">Time Series List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_time-series-query/">Time Series Query</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_uptime-check-configs-create/">Uptime Check Configs Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_uptime-check-configs-delete/">Uptime Check Configs Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_uptime-check-configs-get/">Uptime Check Configs Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_uptime-check-configs-list/">Uptime Check Configs List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="projects_uptime-check-configs-patch/">Uptime Check Configs Patch</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Services</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="services_create/">Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="services_delete/">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="services_get/">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="services_list/">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="services_patch/">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="services_service-level-objectives-create/">Service Level Objectives Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="services_service-level-objectives-delete/">Service Level Objectives Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="services_service-level-objectives-get/">Service Level Objectives Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="services_service-level-objectives-list/">Service Level Objectives List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="services_service-level-objectives-patch/">Service Level Objectives Patch</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Uptime Check Ips</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="uptime-check-ips_list/">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href="."></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=".">Docs</a> »</li>
|
|
<li>Home</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/monitoring3-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<!---
|
|
DO NOT EDIT !
|
|
This file was generated automatically from 'src/mako/cli/README.md.mako'
|
|
DO NOT EDIT !
|
|
-->
|
|
|
|
<p>The <code>monitoring3</code> command-line interface <em>(CLI)</em> allows to use most features of the <em>Google Monitoring</em> service from the comfort of your terminal.</p>
|
|
<p>By default all output is printed to standard out, but flags can be set to direct it into a file independent of your shell's
|
|
capabilities. Errors will be printed to standard error, and cause the program's exit code to be non-zero.</p>
|
|
<p>If data-structures are requested, these will be returned as pretty-printed JSON, to be useful as input to other tools.</p>
|
|
<p>Everything else about the <em>Monitoring</em> API can be found at the
|
|
<a href="https://cloud.google.com/monitoring/api/">official documentation site</a>.</p>
|
|
<h1 id="installation-and-source-code">Installation and Source Code</h1>
|
|
<p>Install the command-line interface with cargo using:</p>
|
|
<pre><code class="bash">cargo install google-monitoring3-cli
|
|
</code></pre>
|
|
|
|
<p>Find the source code <a href="https://github.com/Byron/google-apis-rs/tree/main/gen/monitoring3-cli">on github</a>.</p>
|
|
<h1 id="usage">Usage</h1>
|
|
<p>This documentation was generated from the <em>Monitoring</em> API at revision <em>20220218</em>. The CLI is at version <em>3.0.0</em>.</p>
|
|
<pre><code class="bash">monitoring3 [options]
|
|
folders
|
|
time-series-list <name> [-p <v>]... [-o <out>]
|
|
organizations
|
|
time-series-list <name> [-p <v>]... [-o <out>]
|
|
projects
|
|
alert-policies-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
alert-policies-delete <name> [-p <v>]... [-o <out>]
|
|
alert-policies-get <name> [-p <v>]... [-o <out>]
|
|
alert-policies-list <name> [-p <v>]... [-o <out>]
|
|
alert-policies-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
collectd-time-series-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
groups-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
groups-delete <name> [-p <v>]... [-o <out>]
|
|
groups-get <name> [-p <v>]... [-o <out>]
|
|
groups-list <name> [-p <v>]... [-o <out>]
|
|
groups-members-list <name> [-p <v>]... [-o <out>]
|
|
groups-update <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
metric-descriptors-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
metric-descriptors-delete <name> [-p <v>]... [-o <out>]
|
|
metric-descriptors-get <name> [-p <v>]... [-o <out>]
|
|
metric-descriptors-list <name> [-p <v>]... [-o <out>]
|
|
monitored-resource-descriptors-get <name> [-p <v>]... [-o <out>]
|
|
monitored-resource-descriptors-list <name> [-p <v>]... [-o <out>]
|
|
notification-channel-descriptors-get <name> [-p <v>]... [-o <out>]
|
|
notification-channel-descriptors-list <name> [-p <v>]... [-o <out>]
|
|
notification-channels-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
notification-channels-delete <name> [-p <v>]... [-o <out>]
|
|
notification-channels-get <name> [-p <v>]... [-o <out>]
|
|
notification-channels-get-verification-code <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
notification-channels-list <name> [-p <v>]... [-o <out>]
|
|
notification-channels-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
notification-channels-send-verification-code <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
notification-channels-verify <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
time-series-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
time-series-create-service <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
time-series-list <name> [-p <v>]... [-o <out>]
|
|
time-series-query <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
uptime-check-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
uptime-check-configs-delete <name> [-p <v>]... [-o <out>]
|
|
uptime-check-configs-get <name> [-p <v>]... [-o <out>]
|
|
uptime-check-configs-list <parent> [-p <v>]... [-o <out>]
|
|
uptime-check-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
services
|
|
create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
delete <name> [-p <v>]... [-o <out>]
|
|
get <name> [-p <v>]... [-o <out>]
|
|
list <parent> [-p <v>]... [-o <out>]
|
|
patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
service-level-objectives-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
service-level-objectives-delete <name> [-p <v>]... [-o <out>]
|
|
service-level-objectives-get <name> [-p <v>]... [-o <out>]
|
|
service-level-objectives-list <parent> [-p <v>]... [-o <out>]
|
|
service-level-objectives-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
uptime-check-ips
|
|
list [-p <v>]... [-o <out>]
|
|
monitoring3 --help
|
|
|
|
Configuration:
|
|
[--scope <url>]...
|
|
Specify the authentication a method should be executed in. Each scope
|
|
requires the user to grant this application permission to use it.
|
|
If unset, it defaults to the shortest scope url for a particular method.
|
|
--config-dir <folder>
|
|
A directory into which we will store our persistent data. Defaults to
|
|
a user-writable directory that we will create during the first invocation.
|
|
[default: ~/.google-service-cli]
|
|
|
|
</code></pre>
|
|
|
|
<h1 id="configuration">Configuration</h1>
|
|
<p>The program will store all persistent data in the <code>~/.google-service-cli</code> directory in <em>JSON</em> files prefixed with <code>monitoring3-</code>. You can change the directory used to store configuration with the <code>--config-dir</code> flag on a per-invocation basis.</p>
|
|
<p>More information about the various kinds of persistent data are given in the following paragraphs.</p>
|
|
<h1 id="authentication">Authentication</h1>
|
|
<p>Most APIs require a user to authenticate any request. If this is the case, the <a href="https://developers.google.com/+/api/oauth#scopes">scope</a> determines the
|
|
set of permissions granted. The granularity of these is usually no more than <em>read-only</em> or <em>full-access</em>.</p>
|
|
<p>If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a
|
|
method that is read-only, it will ask only for a read-only scope.
|
|
You may use the <code>--scope</code> flag to specify a scope directly.
|
|
All applicable scopes are documented in the respective method's CLI documentation.</p>
|
|
<p>The first time a scope is used, the user is asked for permission. Follow the instructions given
|
|
by the CLI to grant permissions, or to decline.</p>
|
|
<p>If a scope was authenticated by the user, the respective information will be stored as <em>JSON</em> in the configuration
|
|
directory, e.g. <code>~/.google-service-cli/monitoring3-token-<scope-hash>.json</code>. No manual management of these tokens
|
|
is necessary.</p>
|
|
<p>To revoke granted authentication, please refer to the <a href="http://webapps.stackexchange.com/a/30849">official documentation</a>.</p>
|
|
<h1 id="application-secrets">Application Secrets</h1>
|
|
<p>In order to allow any application to use Google services, it will need to be registered using the
|
|
<a href="https://console.developers.google.com/">Google Developer Console</a>. APIs the application may use are then enabled for it
|
|
one by one. Most APIs can be used for free and have a daily quota.</p>
|
|
<p>To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI
|
|
comes with a default application secret that is configured accordingly. This also means that heavy usage
|
|
all around the world may deplete the daily quota.</p>
|
|
<p>You can workaround this limitation by putting your own secrets file at this location:
|
|
<code>~/.google-service-cli/monitoring3-secret.json</code>, assuming that the required <em>monitoring</em> API
|
|
was enabled for it. Such a secret file can be downloaded in the <em>Google Developer Console</em> at
|
|
<em>APIs & auth -> Credentials -> Download JSON</em> and used as is.</p>
|
|
<p>Learn more about how to setup Google projects and enable APIs using the <a href="https://developers.google.com/console/help/new/">official documentation</a>.</p>
|
|
<h1 id="debugging">Debugging</h1>
|
|
<p>Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know
|
|
what exactly led to a particular issue. This is done by allowing all client-server communication to be
|
|
output to standard error <em>as-is</em>.</p>
|
|
<p>The <code>--debug</code> flag will print errors using the <code>Debug</code> representation to standard error.</p>
|
|
<p>You may consider redirecting standard error into a file for ease of use, e.g. <code>monitoring3 --debug <resource> <method> [options] 2>debug.txt</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="folders_time-series-list/" class="btn btn-neutral float-right" title="Time Series List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
<!-- Copyright etc -->
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
<span><a href="" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="folders_time-series-list/" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |