mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
334 lines
19 KiB
HTML
334 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-privateca1-cli/projects_locations-ca-pools-fetch-ca-certs/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Ca Pools Fetch Ca Certs - Certificate Authority Service v5.0.4+20240221</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 = "Locations Ca Pools Fetch Ca Certs";
|
|
var mkdocs_page_input_path = "projects_locations-ca-pools-fetch-ca-certs.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-privateca1-cli/projects_locations-ca-pools-fetch-ca-certs/";
|
|
</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"> Certificate Authority Service v5.0.4+20240221
|
|
</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">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-activate/">Locations Ca Pools Certificate Authorities Activate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-get/">Locations Ca Pools Certificate Authorities Certificate Revocation Lists Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-get-iam-policy/">Locations Ca Pools Certificate Authorities Certificate Revocation Lists Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-list/">Locations Ca Pools Certificate Authorities Certificate Revocation Lists List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-patch/">Locations Ca Pools Certificate Authorities Certificate Revocation Lists Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-set-iam-policy/">Locations Ca Pools Certificate Authorities Certificate Revocation Lists Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-test-iam-permissions/">Locations Ca Pools Certificate Authorities Certificate Revocation Lists Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-create/">Locations Ca Pools Certificate Authorities Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-delete/">Locations Ca Pools Certificate Authorities Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-disable/">Locations Ca Pools Certificate Authorities Disable</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-enable/">Locations Ca Pools Certificate Authorities Enable</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-fetch/">Locations Ca Pools Certificate Authorities Fetch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-get/">Locations Ca Pools Certificate Authorities Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-list/">Locations Ca Pools Certificate Authorities List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-patch/">Locations Ca Pools Certificate Authorities Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificate-authorities-undelete/">Locations Ca Pools Certificate Authorities Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificates-create/">Locations Ca Pools Certificates Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificates-get/">Locations Ca Pools Certificates Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificates-list/">Locations Ca Pools Certificates List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificates-patch/">Locations Ca Pools Certificates Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-certificates-revoke/">Locations Ca Pools Certificates Revoke</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-create/">Locations Ca Pools Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-delete/">Locations Ca Pools Delete</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Ca Pools Fetch Ca Certs</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-get/">Locations Ca Pools Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-get-iam-policy/">Locations Ca Pools Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-list/">Locations Ca Pools List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-patch/">Locations Ca Pools Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-set-iam-policy/">Locations Ca Pools Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-ca-pools-test-iam-permissions/">Locations Ca Pools Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-certificate-templates-create/">Locations Certificate Templates Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-certificate-templates-delete/">Locations Certificate Templates Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-certificate-templates-get/">Locations Certificate Templates Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-certificate-templates-get-iam-policy/">Locations Certificate Templates Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-certificate-templates-list/">Locations Certificate Templates List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-certificate-templates-patch/">Locations Certificate Templates Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-certificate-templates-set-iam-policy/">Locations Certificate Templates Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-certificate-templates-test-iam-permissions/">Locations Certificate Templates Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get/">Locations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-list/">Locations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-cancel/">Locations Operations Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-delete/">Locations Operations Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-list/">Locations Operations 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="..">Certificate Authority Service v5.0.4+20240221</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>Locations Ca Pools Fetch Ca Certs</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/privateca1-cli/edit/master/docs/projects_locations-ca-pools-fetch-ca-certs.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>FetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all Certificate Authorities in the ENABLED, DISABLED, or STAGED states.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<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>privateca1 --scope <scope> projects locations-ca-pools-fetch-ca-certs ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><ca-pool></strong> <em>(string)</em><ul>
|
|
<li>Required. The resource name for the CaPool in the format <code>projects/*/locations/*/caPools/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>FetchCaCertsRequest:
|
|
request-id: string
|
|
|
|
</code></pre>
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r . request-id=nonumy</code><ul>
|
|
<li>Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</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-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_locations-ca-pools-delete/" class="btn btn-neutral float-left" title="Locations Ca Pools Delete"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-ca-pools-get/" class="btn btn-neutral float-right" title="Locations Ca Pools Get">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/privateca1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-ca-pools-delete/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-ca-pools-get/" 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>
|