1446 lines
51 KiB
HTML
Executable File
1446 lines
51 KiB
HTML
Executable File
---
|
|
title: federation/v1beta1 Operations
|
|
notitle: true
|
|
---
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="generator" content="Asciidoctor 0.1.4">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Operations</title>
|
|
</head>
|
|
<body class="article">
|
|
<div id="header">
|
|
</div>
|
|
<div id="content">
|
|
<div class="sect1">
|
|
<h2 id="_operations">Operations</h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="_get_available_resources">get available resources</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /apis/federation/v1beta1</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">default</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_apiresourcelist">v1.APIResourceList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_cluster">list or watch objects of kind Cluster</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /apis/federation/v1beta1/clusters</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters">Parameters</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Type</th>
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">pretty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If <em>true</em>, then the output is pretty printed.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">labelSelector</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A selector to restrict the list of returned objects by their labels. Defaults to everything.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">fieldSelector</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A selector to restrict the list of returned objects by their fields. Defaults to everything.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">watch</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">resourceVersion</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">timeoutSeconds</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout for the list/watch call.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_2">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_clusterlist">v1beta1.ClusterList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_2">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_2">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
<li>
|
|
<p>application/json;stream=watch</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf;stream=watch</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_2">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_cluster">delete collection of Cluster</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /apis/federation/v1beta1/clusters</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_2">Parameters</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Type</th>
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">pretty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If <em>true</em>, then the output is pretty printed.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">labelSelector</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A selector to restrict the list of returned objects by their labels. Defaults to everything.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">fieldSelector</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A selector to restrict the list of returned objects by their fields. Defaults to everything.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">watch</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">resourceVersion</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">timeoutSeconds</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout for the list/watch call.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_3">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_status">v1.Status</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_3">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_3">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_3">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_cluster">create a Cluster</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /apis/federation/v1beta1/clusters</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_3">Parameters</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Type</th>
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">pretty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If <em>true</em>, then the output is pretty printed.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">BodyParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">body</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_cluster">v1beta1.Cluster</a></p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_4">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_cluster">v1beta1.Cluster</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_4">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_4">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_4">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_cluster">read the specified Cluster</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /apis/federation/v1beta1/clusters/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_4">Parameters</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Type</th>
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">pretty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If <em>true</em>, then the output is pretty printed.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">export</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Should this value be exported. Export strips fields that a user can not specify.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">exact</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Should the export be exact. Exact export maintains cluster-specific fields like <em>Namespace</em>.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name of the Cluster</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_5">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_cluster">v1beta1.Cluster</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_5">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_5">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_5">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_cluster">replace the specified Cluster</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /apis/federation/v1beta1/clusters/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_5">Parameters</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Type</th>
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">pretty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If <em>true</em>, then the output is pretty printed.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">BodyParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">body</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_cluster">v1beta1.Cluster</a></p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name of the Cluster</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_6">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_cluster">v1beta1.Cluster</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_6">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_6">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_6">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_cluster">delete a Cluster</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /apis/federation/v1beta1/clusters/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_6">Parameters</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Type</th>
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">pretty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If <em>true</em>, then the output is pretty printed.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">BodyParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">body</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_deleteoptions">v1.DeleteOptions</a></p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">gracePeriodSeconds</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">orphanDependents</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">propagationPolicy</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Whether and how garbage collection will be performed. Defaults to Default. Either this field or OrphanDependents may be set, but not both.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name of the Cluster</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_7">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_status">v1.Status</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_7">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_7">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_7">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_cluster">partially update the specified Cluster</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /apis/federation/v1beta1/clusters/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_7">Parameters</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Type</th>
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">pretty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If <em>true</em>, then the output is pretty printed.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">BodyParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">body</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_patch">v1.Patch</a></p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name of the Cluster</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_8">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_cluster">v1beta1.Cluster</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_8">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json-patch+json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/merge-patch+json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/strategic-merge-patch+json</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_8">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_8">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_status_of_the_specified_cluster">replace status of the specified Cluster</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /apis/federation/v1beta1/clusters/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_8">Parameters</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Type</th>
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">pretty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If <em>true</em>, then the output is pretty printed.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">BodyParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">body</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_cluster">v1beta1.Cluster</a></p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name of the Cluster</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_9">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_cluster">v1beta1.Cluster</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_9">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_9">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_9">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_cluster">watch individual changes to a list of Cluster</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /apis/federation/v1beta1/watch/clusters</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_9">Parameters</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Type</th>
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">pretty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If <em>true</em>, then the output is pretty printed.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">labelSelector</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A selector to restrict the list of returned objects by their labels. Defaults to everything.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">fieldSelector</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A selector to restrict the list of returned objects by their fields. Defaults to everything.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">watch</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">resourceVersion</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">timeoutSeconds</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout for the list/watch call.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_10">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_watchevent">v1.WatchEvent</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_10">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_10">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
<li>
|
|
<p>application/json;stream=watch</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf;stream=watch</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_10">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_cluster">watch changes to an object of kind Cluster</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /apis/federation/v1beta1/watch/clusters/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_10">Parameters</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
<col style="width:16%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Type</th>
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">pretty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If <em>true</em>, then the output is pretty printed.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">labelSelector</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A selector to restrict the list of returned objects by their labels. Defaults to everything.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">fieldSelector</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A selector to restrict the list of returned objects by their fields. Defaults to everything.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">watch</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">resourceVersion</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">QueryParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">timeoutSeconds</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout for the list/watch call.</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name of the Cluster</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_11">Responses</h4>
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
|
<colgroup>
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
<col style="width:33%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">HTTP Code</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">success</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_watchevent">v1.WatchEvent</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_11">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_11">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>application/json</p>
|
|
</li>
|
|
<li>
|
|
<p>application/yaml</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf</p>
|
|
</li>
|
|
<li>
|
|
<p>application/json;stream=watch</p>
|
|
</li>
|
|
<li>
|
|
<p>application/vnd.kubernetes.protobuf;stream=watch</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_11">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apisfederationv1beta1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="footer">
|
|
<div id="footer-text">
|
|
Last updated 2017-03-02 02:55:11 UTC
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |