mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-12-25 22:40:21 +00:00
33846 lines
1.5 MiB
Executable File
Generated
33846 lines
1.5 MiB
Executable File
Generated
<!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>
|
|
<style>
|
|
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
|
|
article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { display: block; }
|
|
audio, canvas, video { display: inline-block; }
|
|
audio:not([controls]) { display: none; height: 0; }
|
|
[hidden] { display: none; }
|
|
html { background: #fff; color: #000; font-family: sans-serif; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%; }
|
|
body { margin: 0; }
|
|
a:focus { outline: thin dotted; }
|
|
a:active, a:hover { outline: 0; }
|
|
h1 { font-size: 2em; margin: 0.67em 0; }
|
|
abbr[title] { border-bottom: 1px dotted; }
|
|
b, strong { font-weight: bold; }
|
|
dfn { font-style: italic; }
|
|
hr { -moz-box-sizing: content-box; box-sizing: content-box; height: 0; }
|
|
mark { background: #ff0; color: #000; }
|
|
code, kbd, pre, samp { font-family: monospace, serif; font-size: 1em; }
|
|
pre { white-space: pre-wrap; }
|
|
q { quotes: "\201C" "\201D" "\2018" "\2019"; }
|
|
small { font-size: 80%; }
|
|
sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; }
|
|
sup { top: -0.5em; }
|
|
sub { bottom: -0.25em; }
|
|
img { border: 0; }
|
|
svg:not(:root) { overflow: hidden; }
|
|
figure { margin: 0; }
|
|
fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; }
|
|
legend { border: 0; padding: 0; }
|
|
button, input, select, textarea { font-family: inherit; font-size: 100%; margin: 0; }
|
|
button, input { line-height: normal; }
|
|
button, select { text-transform: none; }
|
|
button, html input[type="button"], input[type="reset"], input[type="submit"] { -webkit-appearance: button; cursor: pointer; }
|
|
button[disabled], html input[disabled] { cursor: default; }
|
|
input[type="checkbox"], input[type="radio"] { box-sizing: border-box; padding: 0; }
|
|
input[type="search"] { -webkit-appearance: textfield; -moz-box-sizing: content-box; -webkit-box-sizing: content-box; box-sizing: content-box; }
|
|
input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { -webkit-appearance: none; }
|
|
button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0; }
|
|
textarea { overflow: auto; vertical-align: top; }
|
|
table { border-collapse: collapse; border-spacing: 0; }
|
|
*, *:before, *:after { -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; }
|
|
html, body { font-size: 100%; }
|
|
body { background: white; color: #222222; padding: 0; margin: 0; font-family: "Helvetica Neue", "Helvetica", Helvetica, Arial, sans-serif; font-weight: normal; font-style: normal; line-height: 1; position: relative; cursor: auto; }
|
|
a:hover { cursor: pointer; }
|
|
a:focus { outline: none; }
|
|
img, object, embed { max-width: 100%; height: auto; }
|
|
object, embed { height: 100%; }
|
|
img { -ms-interpolation-mode: bicubic; }
|
|
#map_canvas img, #map_canvas embed, #map_canvas object, .map_canvas img, .map_canvas embed, .map_canvas object { max-width: none !important; }
|
|
.left { float: left !important; }
|
|
.right { float: right !important; }
|
|
.text-left { text-align: left !important; }
|
|
.text-right { text-align: right !important; }
|
|
.text-center { text-align: center !important; }
|
|
.text-justify { text-align: justify !important; }
|
|
.hide { display: none; }
|
|
.antialiased, body { -webkit-font-smoothing: antialiased; }
|
|
img { display: inline-block; vertical-align: middle; }
|
|
textarea { height: auto; min-height: 50px; }
|
|
select { width: 100%; }
|
|
p.lead, .paragraph.lead > p, #preamble > .sectionbody > .paragraph:first-of-type p { font-size: 1.21875em; line-height: 1.6; }
|
|
.subheader, #content #toctitle, .admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .videoblock > .title, .listingblock > .title, .literalblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .sidebarblock > .title, .tableblock > .title, .verseblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title, .tableblock > caption { line-height: 1.4; color: #7a2518; font-weight: 300; margin-top: 0.2em; margin-bottom: 0.5em; }
|
|
div, dl, dt, dd, ul, ol, li, h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6, pre, form, p, blockquote, th, td { margin: 0; padding: 0; direction: ltr; }
|
|
a { color: #005498; text-decoration: underline; line-height: inherit; }
|
|
a:hover, a:focus { color: #00467f; }
|
|
a img { border: none; }
|
|
p { font-family: inherit; font-weight: normal; font-size: 1em; line-height: 1.6; margin-bottom: 1.25em; text-rendering: optimizeLegibility; }
|
|
p aside { font-size: 0.875em; line-height: 1.35; font-style: italic; }
|
|
h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6 { font-family: Georgia, "URW Bookman L", Helvetica, Arial, sans-serif; font-weight: normal; font-style: normal; color: #ba3925; text-rendering: optimizeLegibility; margin-top: 1em; margin-bottom: 0.5em; line-height: 1.2125em; }
|
|
h1 small, h2 small, h3 small, #toctitle small, .sidebarblock > .content > .title small, h4 small, h5 small, h6 small { font-size: 60%; color: #e99b8f; line-height: 0; }
|
|
h1 { font-size: 2.125em; }
|
|
h2 { font-size: 1.6875em; }
|
|
h3, #toctitle, .sidebarblock > .content > .title { font-size: 1.375em; }
|
|
h4 { font-size: 1.125em; }
|
|
h5 { font-size: 1.125em; }
|
|
h6 { font-size: 1em; }
|
|
hr { border: solid #dddddd; border-width: 1px 0 0; clear: both; margin: 1.25em 0 1.1875em; height: 0; }
|
|
em, i { font-style: italic; line-height: inherit; }
|
|
strong, b { font-weight: bold; line-height: inherit; }
|
|
small { font-size: 60%; line-height: inherit; }
|
|
code { font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; color: #6d180b; }
|
|
ul, ol, dl { font-size: 1em; line-height: 1.6; margin-bottom: 1.25em; list-style-position: outside; font-family: inherit; }
|
|
ul, ol { margin-left: 1.5em; }
|
|
ul li ul, ul li ol { margin-left: 1.25em; margin-bottom: 0; font-size: 1em; }
|
|
ul.square li ul, ul.circle li ul, ul.disc li ul { list-style: inherit; }
|
|
ul.square { list-style-type: square; }
|
|
ul.circle { list-style-type: circle; }
|
|
ul.disc { list-style-type: disc; }
|
|
ul.no-bullet { list-style: none; }
|
|
ol li ul, ol li ol { margin-left: 1.25em; margin-bottom: 0; }
|
|
dl dt { margin-bottom: 0.3125em; font-weight: bold; }
|
|
dl dd { margin-bottom: 1.25em; }
|
|
abbr, acronym { text-transform: uppercase; font-size: 90%; color: #222222; border-bottom: 1px dotted #dddddd; cursor: help; }
|
|
abbr { text-transform: none; }
|
|
blockquote { margin: 0 0 1.25em; padding: 0.5625em 1.25em 0 1.1875em; border-left: 1px solid #dddddd; }
|
|
blockquote cite { display: block; font-size: inherit; color: #555555; }
|
|
blockquote cite:before { content: "\2014 \0020"; }
|
|
blockquote cite a, blockquote cite a:visited { color: #555555; }
|
|
blockquote, blockquote p { line-height: 1.6; color: #6f6f6f; }
|
|
.vcard { display: inline-block; margin: 0 0 1.25em 0; border: 1px solid #dddddd; padding: 0.625em 0.75em; }
|
|
.vcard li { margin: 0; display: block; }
|
|
.vcard .fn { font-weight: bold; font-size: 0.9375em; }
|
|
.vevent .summary { font-weight: bold; }
|
|
.vevent abbr { cursor: auto; text-decoration: none; font-weight: bold; border: none; padding: 0 0.0625em; }
|
|
@media only screen and (min-width: 768px) { h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6 { line-height: 1.4; }
|
|
h1 { font-size: 2.75em; }
|
|
h2 { font-size: 2.3125em; }
|
|
h3, #toctitle, .sidebarblock > .content > .title { font-size: 1.6875em; }
|
|
h4 { font-size: 1.4375em; } }
|
|
.print-only { display: none !important; }
|
|
@media print { * { background: transparent !important; color: #000 !important; box-shadow: none !important; text-shadow: none !important; }
|
|
a, a:visited { text-decoration: underline; }
|
|
a[href]:after { content: " (" attr(href) ")"; }
|
|
abbr[title]:after { content: " (" attr(title) ")"; }
|
|
.ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { content: ""; }
|
|
pre, blockquote { border: 1px solid #999; page-break-inside: avoid; }
|
|
thead { display: table-header-group; }
|
|
tr, img { page-break-inside: avoid; }
|
|
img { max-width: 100% !important; }
|
|
@page { margin: 0.5cm; }
|
|
p, h2, h3, #toctitle, .sidebarblock > .content > .title { orphans: 3; widows: 3; }
|
|
h2, h3, #toctitle, .sidebarblock > .content > .title { page-break-after: avoid; }
|
|
.hide-on-print { display: none !important; }
|
|
.print-only { display: block !important; }
|
|
.hide-for-print { display: none !important; }
|
|
.show-for-print { display: inherit !important; } }
|
|
table { background: white; margin-bottom: 1.25em; border: solid 1px #dddddd; }
|
|
table thead, table tfoot { background: whitesmoke; font-weight: bold; }
|
|
table thead tr th, table thead tr td, table tfoot tr th, table tfoot tr td { padding: 0.5em 0.625em 0.625em; font-size: inherit; color: #222222; text-align: left; }
|
|
table tr th, table tr td { padding: 0.5625em 0.625em; font-size: inherit; color: #222222; }
|
|
table tr.even, table tr.alt, table tr:nth-of-type(even) { background: #f9f9f9; }
|
|
table thead tr th, table tfoot tr th, table tbody tr td, table tr td, table tfoot tr td { display: table-cell; line-height: 1.6; }
|
|
.clearfix:before, .clearfix:after, .float-group:before, .float-group:after { content: " "; display: table; }
|
|
.clearfix:after, .float-group:after { clear: both; }
|
|
*:not(pre) > code { font-size: 0.9375em; padding: 1px 3px 0; white-space: nowrap; background-color: #f2f2f2; border: 1px solid #cccccc; -webkit-border-radius: 4px; border-radius: 4px; text-shadow: none; }
|
|
pre, pre > code { line-height: 1.4; color: inherit; font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; }
|
|
kbd.keyseq { color: #555555; }
|
|
kbd:not(.keyseq) { display: inline-block; color: #222222; font-size: 0.75em; line-height: 1.4; background-color: #F7F7F7; border: 1px solid #ccc; -webkit-border-radius: 3px; border-radius: 3px; -webkit-box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 0 0 2px white inset; box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 0 0 2px white inset; margin: -0.15em 0.15em 0 0.15em; padding: 0.2em 0.6em 0.2em 0.5em; vertical-align: middle; white-space: nowrap; }
|
|
kbd kbd:first-child { margin-left: 0; }
|
|
kbd kbd:last-child { margin-right: 0; }
|
|
.menuseq, .menu { color: #090909; }
|
|
p a > code:hover { color: #561309; }
|
|
#header, #content, #footnotes, #footer { width: 100%; margin-left: auto; margin-right: auto; margin-top: 0; margin-bottom: 0; max-width: 62.5em; *zoom: 1; position: relative; padding-left: 0.9375em; padding-right: 0.9375em; }
|
|
#header:before, #header:after, #content:before, #content:after, #footnotes:before, #footnotes:after, #footer:before, #footer:after { content: " "; display: table; }
|
|
#header:after, #content:after, #footnotes:after, #footer:after { clear: both; }
|
|
#header { margin-bottom: 2.5em; }
|
|
#header > h1 { color: black; font-weight: normal; border-bottom: 1px solid #dddddd; margin-bottom: -28px; padding-bottom: 32px; }
|
|
#header span { color: #6f6f6f; }
|
|
#header #revnumber { text-transform: capitalize; }
|
|
#header br { display: none; }
|
|
#header br + span { padding-left: 3px; }
|
|
#header br + span:before { content: "\2013 \0020"; }
|
|
#header br + span.author { padding-left: 0; }
|
|
#header br + span.author:before { content: ", "; }
|
|
#toc { border-bottom: 3px double #ebebeb; padding-bottom: 1.25em; }
|
|
#toc > ul { margin-left: 0.25em; }
|
|
#toc ul.sectlevel0 > li > a { font-style: italic; }
|
|
#toc ul.sectlevel0 ul.sectlevel1 { margin-left: 0; margin-top: 0.5em; margin-bottom: 0.5em; }
|
|
#toc ul { list-style-type: none; }
|
|
#toctitle { color: #7a2518; }
|
|
@media only screen and (min-width: 1280px) { body.toc2 { padding-left: 20em; }
|
|
#toc.toc2 { position: fixed; width: 20em; left: 0; top: 0; border-right: 1px solid #ebebeb; border-bottom: 0; z-index: 1000; padding: 1em; height: 100%; overflow: auto; }
|
|
#toc.toc2 #toctitle { margin-top: 0; }
|
|
#toc.toc2 > ul { font-size: .95em; }
|
|
#toc.toc2 ul ul { margin-left: 0; padding-left: 1.25em; }
|
|
#toc.toc2 ul.sectlevel0 ul.sectlevel1 { padding-left: 0; margin-top: 0.5em; margin-bottom: 0.5em; }
|
|
body.toc2.toc-right { padding-left: 0; padding-right: 20em; }
|
|
body.toc2.toc-right #toc.toc2 { border-right: 0; border-left: 1px solid #ebebeb; left: auto; right: 0; } }
|
|
#content #toc { border-style: solid; border-width: 1px; border-color: #d9d9d9; margin-bottom: 1.25em; padding: 1.25em; background: #f2f2f2; border-width: 0; -webkit-border-radius: 4px; border-radius: 4px; }
|
|
#content #toc > :first-child { margin-top: 0; }
|
|
#content #toc > :last-child { margin-bottom: 0; }
|
|
#content #toc a { text-decoration: none; }
|
|
#content #toctitle { font-weight: bold; font-family: "Helvetica Neue", "Helvetica", Helvetica, Arial, sans-serif; font-size: 1em; padding-left: 0.125em; }
|
|
#footer { max-width: 100%; background-color: #222222; padding: 1.25em; }
|
|
#footer-text { color: #dddddd; line-height: 1.44; }
|
|
.sect1 { padding-bottom: 1.25em; }
|
|
.sect1 + .sect1 { border-top: 3px double #ebebeb; }
|
|
#content h1 > a.anchor, h2 > a.anchor, h3 > a.anchor, #toctitle > a.anchor, .sidebarblock > .content > .title > a.anchor, h4 > a.anchor, h5 > a.anchor, h6 > a.anchor { position: absolute; width: 1em; margin-left: -1em; display: block; text-decoration: none; visibility: hidden; text-align: center; font-weight: normal; }
|
|
#content h1 > a.anchor:before, h2 > a.anchor:before, h3 > a.anchor:before, #toctitle > a.anchor:before, .sidebarblock > .content > .title > a.anchor:before, h4 > a.anchor:before, h5 > a.anchor:before, h6 > a.anchor:before { content: '\00A7'; font-size: .85em; vertical-align: text-top; display: block; margin-top: 0.05em; }
|
|
#content h1:hover > a.anchor, #content h1 > a.anchor:hover, h2:hover > a.anchor, h2 > a.anchor:hover, h3:hover > a.anchor, #toctitle:hover > a.anchor, .sidebarblock > .content > .title:hover > a.anchor, h3 > a.anchor:hover, #toctitle > a.anchor:hover, .sidebarblock > .content > .title > a.anchor:hover, h4:hover > a.anchor, h4 > a.anchor:hover, h5:hover > a.anchor, h5 > a.anchor:hover, h6:hover > a.anchor, h6 > a.anchor:hover { visibility: visible; }
|
|
#content h1 > a.link, h2 > a.link, h3 > a.link, #toctitle > a.link, .sidebarblock > .content > .title > a.link, h4 > a.link, h5 > a.link, h6 > a.link { color: #ba3925; text-decoration: none; }
|
|
#content h1 > a.link:hover, h2 > a.link:hover, h3 > a.link:hover, #toctitle > a.link:hover, .sidebarblock > .content > .title > a.link:hover, h4 > a.link:hover, h5 > a.link:hover, h6 > a.link:hover { color: #a53221; }
|
|
.imageblock, .literalblock, .listingblock, .verseblock, .videoblock { margin-bottom: 1.25em; }
|
|
.admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .videoblock > .title, .listingblock > .title, .literalblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .sidebarblock > .title, .tableblock > .title, .verseblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title { text-align: left; font-weight: bold; }
|
|
.tableblock > caption { text-align: left; font-weight: bold; white-space: nowrap; overflow: visible; max-width: 0; }
|
|
table.tableblock #preamble > .sectionbody > .paragraph:first-of-type p { font-size: inherit; }
|
|
.admonitionblock > table { border: 0; background: none; width: 100%; }
|
|
.admonitionblock > table td.icon { text-align: center; width: 80px; }
|
|
.admonitionblock > table td.icon img { max-width: none; }
|
|
.admonitionblock > table td.icon .title { font-weight: bold; text-transform: uppercase; }
|
|
.admonitionblock > table td.content { padding-left: 1.125em; padding-right: 1.25em; border-left: 1px solid #dddddd; color: #6f6f6f; }
|
|
.admonitionblock > table td.content > :last-child > :last-child { margin-bottom: 0; }
|
|
.exampleblock > .content { border-style: solid; border-width: 1px; border-color: #e6e6e6; margin-bottom: 1.25em; padding: 1.25em; background: white; -webkit-border-radius: 4px; border-radius: 4px; }
|
|
.exampleblock > .content > :first-child { margin-top: 0; }
|
|
.exampleblock > .content > :last-child { margin-bottom: 0; }
|
|
.exampleblock > .content h1, .exampleblock > .content h2, .exampleblock > .content h3, .exampleblock > .content #toctitle, .sidebarblock.exampleblock > .content > .title, .exampleblock > .content h4, .exampleblock > .content h5, .exampleblock > .content h6, .exampleblock > .content p { color: #333333; }
|
|
.exampleblock > .content h1, .exampleblock > .content h2, .exampleblock > .content h3, .exampleblock > .content #toctitle, .sidebarblock.exampleblock > .content > .title, .exampleblock > .content h4, .exampleblock > .content h5, .exampleblock > .content h6 { line-height: 1; margin-bottom: 0.625em; }
|
|
.exampleblock > .content h1.subheader, .exampleblock > .content h2.subheader, .exampleblock > .content h3.subheader, .exampleblock > .content .subheader#toctitle, .sidebarblock.exampleblock > .content > .subheader.title, .exampleblock > .content h4.subheader, .exampleblock > .content h5.subheader, .exampleblock > .content h6.subheader { line-height: 1.4; }
|
|
.exampleblock.result > .content { -webkit-box-shadow: 0 1px 8px #d9d9d9; box-shadow: 0 1px 8px #d9d9d9; }
|
|
.sidebarblock { border-style: solid; border-width: 1px; border-color: #d9d9d9; margin-bottom: 1.25em; padding: 1.25em; background: #f2f2f2; -webkit-border-radius: 4px; border-radius: 4px; }
|
|
.sidebarblock > :first-child { margin-top: 0; }
|
|
.sidebarblock > :last-child { margin-bottom: 0; }
|
|
.sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6, .sidebarblock p { color: #333333; }
|
|
.sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6 { line-height: 1; margin-bottom: 0.625em; }
|
|
.sidebarblock h1.subheader, .sidebarblock h2.subheader, .sidebarblock h3.subheader, .sidebarblock .subheader#toctitle, .sidebarblock > .content > .subheader.title, .sidebarblock h4.subheader, .sidebarblock h5.subheader, .sidebarblock h6.subheader { line-height: 1.4; }
|
|
.sidebarblock > .content > .title { color: #7a2518; margin-top: 0; line-height: 1.6; }
|
|
.exampleblock > .content > :last-child > :last-child, .exampleblock > .content .olist > ol > li:last-child > :last-child, .exampleblock > .content .ulist > ul > li:last-child > :last-child, .exampleblock > .content .qlist > ol > li:last-child > :last-child, .sidebarblock > .content > :last-child > :last-child, .sidebarblock > .content .olist > ol > li:last-child > :last-child, .sidebarblock > .content .ulist > ul > li:last-child > :last-child, .sidebarblock > .content .qlist > ol > li:last-child > :last-child { margin-bottom: 0; }
|
|
.literalblock > .content pre, .listingblock > .content pre { background: none; border-width: 1px 0; border-style: dotted; border-color: #bfbfbf; -webkit-border-radius: 4px; border-radius: 4px; padding: 0.75em 0.75em 0.5em 0.75em; word-wrap: break-word; }
|
|
.literalblock > .content pre.nowrap, .listingblock > .content pre.nowrap { overflow-x: auto; white-space: pre; word-wrap: normal; }
|
|
.literalblock > .content pre > code, .listingblock > .content pre > code { display: block; }
|
|
@media only screen { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.8em; } }
|
|
@media only screen and (min-width: 768px) { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.9em; } }
|
|
@media only screen and (min-width: 1280px) { .literalblock > .content pre, .listingblock > .content pre { font-size: 1em; } }
|
|
.listingblock > .content { position: relative; }
|
|
.listingblock:hover code[class*=" language-"]:before { text-transform: uppercase; font-size: 0.9em; color: #999; position: absolute; top: 0.375em; right: 0.375em; }
|
|
.listingblock:hover code.asciidoc:before { content: "asciidoc"; }
|
|
.listingblock:hover code.clojure:before { content: "clojure"; }
|
|
.listingblock:hover code.css:before { content: "css"; }
|
|
.listingblock:hover code.groovy:before { content: "groovy"; }
|
|
.listingblock:hover code.html:before { content: "html"; }
|
|
.listingblock:hover code.java:before { content: "java"; }
|
|
.listingblock:hover code.javascript:before { content: "javascript"; }
|
|
.listingblock:hover code.python:before { content: "python"; }
|
|
.listingblock:hover code.ruby:before { content: "ruby"; }
|
|
.listingblock:hover code.scss:before { content: "scss"; }
|
|
.listingblock:hover code.xml:before { content: "xml"; }
|
|
.listingblock:hover code.yaml:before { content: "yaml"; }
|
|
.listingblock.terminal pre .command:before { content: attr(data-prompt); padding-right: 0.5em; color: #999; }
|
|
.listingblock.terminal pre .command:not([data-prompt]):before { content: '$'; }
|
|
table.pyhltable { border: 0; margin-bottom: 0; }
|
|
table.pyhltable td { vertical-align: top; padding-top: 0; padding-bottom: 0; }
|
|
table.pyhltable td.code { padding-left: .75em; padding-right: 0; }
|
|
.highlight.pygments .lineno, table.pyhltable td:not(.code) { color: #999; padding-left: 0; padding-right: .5em; border-right: 1px solid #dddddd; }
|
|
.highlight.pygments .lineno { display: inline-block; margin-right: .25em; }
|
|
table.pyhltable .linenodiv { background-color: transparent !important; padding-right: 0 !important; }
|
|
.quoteblock { margin: 0 0 1.25em; padding: 0.5625em 1.25em 0 1.1875em; border-left: 1px solid #dddddd; }
|
|
.quoteblock blockquote { margin: 0 0 1.25em 0; padding: 0 0 0.5625em 0; border: 0; }
|
|
.quoteblock blockquote > .paragraph:last-child p { margin-bottom: 0; }
|
|
.quoteblock .attribution { margin-top: -.25em; padding-bottom: 0.5625em; font-size: inherit; color: #555555; }
|
|
.quoteblock .attribution br { display: none; }
|
|
.quoteblock .attribution cite { display: block; margin-bottom: 0.625em; }
|
|
table thead th, table tfoot th { font-weight: bold; }
|
|
table.tableblock.grid-all { border-collapse: separate; border-spacing: 1px; -webkit-border-radius: 4px; border-radius: 4px; border-top: 1px solid #dddddd; border-bottom: 1px solid #dddddd; }
|
|
table.tableblock.frame-topbot, table.tableblock.frame-none { border-left: 0; border-right: 0; }
|
|
table.tableblock.frame-sides, table.tableblock.frame-none { border-top: 0; border-bottom: 0; }
|
|
table.tableblock td .paragraph:last-child p, table.tableblock td > p:last-child { margin-bottom: 0; }
|
|
th.tableblock.halign-left, td.tableblock.halign-left { text-align: left; }
|
|
th.tableblock.halign-right, td.tableblock.halign-right { text-align: right; }
|
|
th.tableblock.halign-center, td.tableblock.halign-center { text-align: center; }
|
|
th.tableblock.valign-top, td.tableblock.valign-top { vertical-align: top; }
|
|
th.tableblock.valign-bottom, td.tableblock.valign-bottom { vertical-align: bottom; }
|
|
th.tableblock.valign-middle, td.tableblock.valign-middle { vertical-align: middle; }
|
|
p.tableblock.header { color: #222222; font-weight: bold; }
|
|
td > div.verse { white-space: pre; }
|
|
ol { margin-left: 1.75em; }
|
|
ul li ol { margin-left: 1.5em; }
|
|
dl dd { margin-left: 1.125em; }
|
|
dl dd:last-child, dl dd:last-child > :last-child { margin-bottom: 0; }
|
|
ol > li p, ul > li p, ul dd, ol dd, .olist .olist, .ulist .ulist, .ulist .olist, .olist .ulist { margin-bottom: 0.625em; }
|
|
ul.unstyled, ol.unnumbered, ul.checklist, ul.none { list-style-type: none; }
|
|
ul.unstyled, ol.unnumbered, ul.checklist { margin-left: 0.625em; }
|
|
ul.checklist li > p:first-child > i[class^="icon-check"]:first-child, ul.checklist li > p:first-child > input[type="checkbox"]:first-child { margin-right: 0.25em; }
|
|
ul.checklist li > p:first-child > input[type="checkbox"]:first-child { position: relative; top: 1px; }
|
|
ul.inline { margin: 0 auto 0.625em auto; margin-left: -1.375em; margin-right: 0; padding: 0; list-style: none; overflow: hidden; }
|
|
ul.inline > li { list-style: none; float: left; margin-left: 1.375em; display: block; }
|
|
ul.inline > li > * { display: block; }
|
|
.unstyled dl dt { font-weight: normal; font-style: normal; }
|
|
ol.arabic { list-style-type: decimal; }
|
|
ol.decimal { list-style-type: decimal-leading-zero; }
|
|
ol.loweralpha { list-style-type: lower-alpha; }
|
|
ol.upperalpha { list-style-type: upper-alpha; }
|
|
ol.lowerroman { list-style-type: lower-roman; }
|
|
ol.upperroman { list-style-type: upper-roman; }
|
|
ol.lowergreek { list-style-type: lower-greek; }
|
|
.hdlist > table, .colist > table { border: 0; background: none; }
|
|
.hdlist > table > tbody > tr, .colist > table > tbody > tr { background: none; }
|
|
td.hdlist1 { padding-right: .8em; font-weight: bold; }
|
|
td.hdlist1, td.hdlist2 { vertical-align: top; }
|
|
.literalblock + .colist, .listingblock + .colist { margin-top: -0.5em; }
|
|
.colist > table tr > td:first-of-type { padding: 0 .8em; line-height: 1; }
|
|
.colist > table tr > td:last-of-type { padding: 0.25em 0; }
|
|
.qanda > ol > li > p > em:only-child { color: #00467f; }
|
|
.thumb, .th { line-height: 0; display: inline-block; border: solid 4px white; -webkit-box-shadow: 0 0 0 1px #dddddd; box-shadow: 0 0 0 1px #dddddd; }
|
|
.imageblock.left, .imageblock[style*="float: left"] { margin: 0.25em 0.625em 1.25em 0; }
|
|
.imageblock.right, .imageblock[style*="float: right"] { margin: 0.25em 0 1.25em 0.625em; }
|
|
.imageblock > .title { margin-bottom: 0; }
|
|
.imageblock.thumb, .imageblock.th { border-width: 6px; }
|
|
.imageblock.thumb > .title, .imageblock.th > .title { padding: 0 0.125em; }
|
|
.image.left, .image.right { margin-top: 0.25em; margin-bottom: 0.25em; display: inline-block; line-height: 0; }
|
|
.image.left { margin-right: 0.625em; }
|
|
.image.right { margin-left: 0.625em; }
|
|
a.image { text-decoration: none; }
|
|
span.footnote, span.footnoteref { vertical-align: super; font-size: 0.875em; }
|
|
span.footnote a, span.footnoteref a { text-decoration: none; }
|
|
#footnotes { padding-top: 0.75em; padding-bottom: 0.75em; margin-bottom: 0.625em; }
|
|
#footnotes hr { width: 20%; min-width: 6.25em; margin: -.25em 0 .75em 0; border-width: 1px 0 0 0; }
|
|
#footnotes .footnote { padding: 0 0.375em; line-height: 1.3; font-size: 0.875em; margin-left: 1.2em; text-indent: -1.2em; margin-bottom: .2em; }
|
|
#footnotes .footnote a:first-of-type { font-weight: bold; text-decoration: none; }
|
|
#footnotes .footnote:last-of-type { margin-bottom: 0; }
|
|
#content #footnotes { margin-top: -0.625em; margin-bottom: 0; padding: 0.75em 0; }
|
|
.gist .file-data > table { border: none; background: #fff; width: 100%; margin-bottom: 0; }
|
|
.gist .file-data > table td.line-data { width: 99%; }
|
|
div.unbreakable { page-break-inside: avoid; }
|
|
.big { font-size: larger; }
|
|
.small { font-size: smaller; }
|
|
.underline { text-decoration: underline; }
|
|
.overline { text-decoration: overline; }
|
|
.line-through { text-decoration: line-through; }
|
|
.aqua { color: #00bfbf; }
|
|
.aqua-background { background-color: #00fafa; }
|
|
.black { color: black; }
|
|
.black-background { background-color: black; }
|
|
.blue { color: #0000bf; }
|
|
.blue-background { background-color: #0000fa; }
|
|
.fuchsia { color: #bf00bf; }
|
|
.fuchsia-background { background-color: #fa00fa; }
|
|
.gray { color: #606060; }
|
|
.gray-background { background-color: #7d7d7d; }
|
|
.green { color: #006000; }
|
|
.green-background { background-color: #007d00; }
|
|
.lime { color: #00bf00; }
|
|
.lime-background { background-color: #00fa00; }
|
|
.maroon { color: #600000; }
|
|
.maroon-background { background-color: #7d0000; }
|
|
.navy { color: #000060; }
|
|
.navy-background { background-color: #00007d; }
|
|
.olive { color: #606000; }
|
|
.olive-background { background-color: #7d7d00; }
|
|
.purple { color: #600060; }
|
|
.purple-background { background-color: #7d007d; }
|
|
.red { color: #bf0000; }
|
|
.red-background { background-color: #fa0000; }
|
|
.silver { color: #909090; }
|
|
.silver-background { background-color: #bcbcbc; }
|
|
.teal { color: #006060; }
|
|
.teal-background { background-color: #007d7d; }
|
|
.white { color: #bfbfbf; }
|
|
.white-background { background-color: #fafafa; }
|
|
.yellow { color: #bfbf00; }
|
|
.yellow-background { background-color: #fafa00; }
|
|
span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
|
|
.admonitionblock td.icon [class^="icon-"]:before { font-size: 2.5em; text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.5); cursor: default; }
|
|
.admonitionblock td.icon .icon-note:before { content: "\f05a"; color: #005498; color: #003f72; }
|
|
.admonitionblock td.icon .icon-tip:before { content: "\f0eb"; text-shadow: 1px 1px 2px rgba(155, 155, 0, 0.8); color: #111; }
|
|
.admonitionblock td.icon .icon-warning:before { content: "\f071"; color: #bf6900; }
|
|
.admonitionblock td.icon .icon-caution:before { content: "\f06d"; color: #bf3400; }
|
|
.admonitionblock td.icon .icon-important:before { content: "\f06a"; color: #bf0000; }
|
|
.conum { display: inline-block; color: white !important; background-color: #222222; -webkit-border-radius: 100px; border-radius: 100px; text-align: center; width: 20px; height: 20px; font-size: 12px; font-weight: bold; line-height: 20px; font-family: Arial, sans-serif; font-style: normal; position: relative; top: -2px; letter-spacing: -1px; }
|
|
.conum * { color: white !important; }
|
|
.conum + b { display: none; }
|
|
.conum:after { content: attr(data-value); }
|
|
.conum:not([data-value]):empty { display: none; }
|
|
.literalblock > .content > pre, .listingblock > .content > pre { -webkit-border-radius: 0; border-radius: 0; }
|
|
|
|
</style>
|
|
</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 /api/v1</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>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_objects_of_kind_componentstatus">list objects of kind ComponentStatus</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/componentstatuses</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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</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#_v1_componentstatuslist">v1.ComponentStatusList</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>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_componentstatus">read the specified ComponentStatus</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/componentstatuses/{name}</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">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 ComponentStatus</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_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_componentstatus">v1.ComponentStatus</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>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_configmap">list or watch objects of kind ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/configmaps</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">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</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#_v1_configmaplist">v1.ConfigMapList</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>
|
|
<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_4">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_endpoints">list or watch objects of kind Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/endpoints</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">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</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#_v1_endpointslist">v1.EndpointsList</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>
|
|
<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_5">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_event">list or watch objects of kind Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/events</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">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</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#_v1_eventlist">v1.EventList</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>
|
|
<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_6">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_limitrange">list or watch objects of kind LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/limitranges</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">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</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_limitrangelist">v1.LimitRangeList</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>
|
|
<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_7">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_namespace">list or watch objects of kind Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces</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">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</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#_v1_namespacelist">v1.NamespaceList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_8">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></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>
|
|
<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_8">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_namespace">create a Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces</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#_v1_namespace">v1.Namespace</a></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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
<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_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_namespace">v1.Namespace</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>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_binding">create a Binding</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/bindings</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">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_binding">v1.Binding</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_binding">v1.Binding</a></p></td>
|
|
</tr>
|
|
<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_binding">v1.Binding</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_binding">v1.Binding</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>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_10">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_configmap_2">list or watch objects of kind ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/configmaps</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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_configmaplist">v1.ConfigMapList</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>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_configmap">delete collection of ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/configmaps</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_11">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_12">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_12">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_12">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_12">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_configmap">create a ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/configmaps</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_12">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_configmap">v1.ConfigMap</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_13">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_configmap">v1.ConfigMap</a></p></td>
|
|
</tr>
|
|
<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_configmap">v1.ConfigMap</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_configmap">v1.ConfigMap</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_13">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_13">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_13">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_configmap">read the specified ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/configmaps/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_13">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ConfigMap</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_14">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_configmap">v1.ConfigMap</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_14">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_14">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_14">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_configmap">replace the specified ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/configmaps/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_14">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_configmap">v1.ConfigMap</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ConfigMap</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_15">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_configmap">v1.ConfigMap</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_configmap">v1.ConfigMap</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_15">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_15">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_15">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_configmap">delete a ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/configmaps/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_15">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ConfigMap</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_16">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_16">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_16">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_16">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_configmap">partially update the specified ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/configmaps/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_16">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ConfigMap</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_17">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_configmap">v1.ConfigMap</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_17">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_17">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_17">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_endpoints_2">list or watch objects of kind Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/endpoints</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_17">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_18">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_endpointslist">v1.EndpointsList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_18">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_18">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_18">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_endpoints">delete collection of Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/endpoints</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_18">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_19">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_19">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_19">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_19">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_endpoints">create Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/endpoints</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_19">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_endpoints">v1.Endpoints</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_20">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_endpoints">v1.Endpoints</a></p></td>
|
|
</tr>
|
|
<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_endpoints">v1.Endpoints</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_endpoints">v1.Endpoints</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_20">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_20">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_20">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_endpoints">read the specified Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/endpoints/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_20">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Endpoints</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_21">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_endpoints">v1.Endpoints</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_21">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_21">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_21">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_endpoints">replace the specified Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/endpoints/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_21">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_endpoints">v1.Endpoints</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Endpoints</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_22">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_endpoints">v1.Endpoints</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_endpoints">v1.Endpoints</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_22">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_22">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_22">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_endpoints">delete Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/endpoints/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_22">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Endpoints</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_23">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_23">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_23">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_23">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_endpoints">partially update the specified Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/endpoints/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_23">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Endpoints</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_24">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_endpoints">v1.Endpoints</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_24">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_24">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_24">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_event_2">list or watch objects of kind Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/events</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_24">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_25">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_eventlist">v1.EventList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_25">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_25">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_25">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_event">delete collection of Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/events</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_25">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_26">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_26">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_26">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_26">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_an_event">create an Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/events</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_26">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_event">v1.Event</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_27">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_event">v1.Event</a></p></td>
|
|
</tr>
|
|
<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_event">v1.Event</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_event">v1.Event</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_27">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_27">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_27">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_event">read the specified Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/events/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_27">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Event</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_28">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_event">v1.Event</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_28">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_28">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_28">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_event">replace the specified Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/events/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_28">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_event">v1.Event</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Event</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_29">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_event">v1.Event</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_event">v1.Event</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_29">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_29">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_29">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_an_event">delete an Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/events/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_29">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Event</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_30">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_30">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_30">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_30">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_event">partially update the specified Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/events/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_30">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Event</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_31">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_event">v1.Event</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_31">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_31">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_31">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_limitrange_2">list or watch objects of kind LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/limitranges</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_31">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_32">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_limitrangelist">v1.LimitRangeList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_32">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_32">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_32">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_limitrange">delete collection of LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/limitranges</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_32">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_33">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_33">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_33">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_33">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_limitrange">create a LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/limitranges</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_33">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_limitrange">v1.LimitRange</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_34">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_limitrange">v1.LimitRange</a></p></td>
|
|
</tr>
|
|
<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_limitrange">v1.LimitRange</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_limitrange">v1.LimitRange</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_34">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_34">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_34">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_limitrange">read the specified LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/limitranges/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_34">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 LimitRange</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_35">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_limitrange">v1.LimitRange</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_35">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_35">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_35">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_limitrange">replace the specified LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/limitranges/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_35">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_limitrange">v1.LimitRange</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 LimitRange</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_36">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_limitrange">v1.LimitRange</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_limitrange">v1.LimitRange</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_36">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_36">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_36">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_limitrange">delete a LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/limitranges/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_36">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 LimitRange</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_37">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_37">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_37">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_37">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_limitrange">partially update the specified LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/limitranges/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_37">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 LimitRange</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_38">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_limitrange">v1.LimitRange</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_38">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_38">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_38">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_persistentvolumeclaim">list or watch objects of kind PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/persistentvolumeclaims</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_38">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_39">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_persistentvolumeclaimlist">v1.PersistentVolumeClaimList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_39">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_39">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_39">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_persistentvolumeclaim">delete collection of PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_39">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_40">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_40">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_40">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_40">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_persistentvolumeclaim">create a PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/persistentvolumeclaims</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_40">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_persistentvolumeclaim">v1.PersistentVolumeClaim</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_41">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
<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_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_41">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_41">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_41">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_persistentvolumeclaim">read the specified PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_41">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PersistentVolumeClaim</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_42">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_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_42">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_42">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_42">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_persistentvolumeclaim">replace the specified PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_42">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_persistentvolumeclaim">v1.PersistentVolumeClaim</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PersistentVolumeClaim</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_43">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_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_43">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_43">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_43">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_persistentvolumeclaim">delete a PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_43">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PersistentVolumeClaim</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_44">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_44">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_44">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_44">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_persistentvolumeclaim">partially update the specified PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_44">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PersistentVolumeClaim</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_45">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_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_45">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_45">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_45">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_status_of_the_specified_persistentvolumeclaim">read status of the specified PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_45">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">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PersistentVolumeClaim</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_46">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_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_46">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_46">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_46">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_status_of_the_specified_persistentvolumeclaim">replace status of the specified PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_46">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_persistentvolumeclaim">v1.PersistentVolumeClaim</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PersistentVolumeClaim</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_47">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_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_47">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_47">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_47">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_status_of_the_specified_persistentvolumeclaim">partially update status of the specified PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_47">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PersistentVolumeClaim</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_48">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_persistentvolumeclaim">v1.PersistentVolumeClaim</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_48">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_48">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_48">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_pod">list or watch objects of kind Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/pods</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_48">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_49">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_podlist">v1.PodList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_49">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_49">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_49">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_pod">delete collection of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/pods</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_49">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_50">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_50">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_50">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_50">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_pod">create a Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/pods</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_50">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_pod">v1.Pod</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_51">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
<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_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_51">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_51">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_51">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_pod">read the specified Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/pods/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_51">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_52">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_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_52">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_52">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_52">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_pod">replace the specified Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/pods/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_52">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_pod">v1.Pod</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_53">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_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_53">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_53">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_53">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_pod">delete a Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/pods/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_53">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_54">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_54">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_54">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_54">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_pod">partially update the specified Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/pods/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_54">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_55">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_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_55">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_55">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_55">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_get_requests_to_attach_of_pod">connect GET requests to attach of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/pods/{name}/attach</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_55">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">stdin</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.</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">stdout</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.</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">stderr</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.</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">tty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.</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">container</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The container in which to execute the command. Defaults to only container if there is only one container in the pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_56">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_56">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_56">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_56">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_post_requests_to_attach_of_pod">connect POST requests to attach of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/pods/{name}/attach</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_56">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">stdin</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.</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">stdout</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.</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">stderr</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.</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">tty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.</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">container</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The container in which to execute the command. Defaults to only container if there is only one container in the pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_57">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_57">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_57">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_57">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_binding_of_a_pod">create binding of a Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/pods/{name}/binding</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_57">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_binding">v1.Binding</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Binding</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_58">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_binding">v1.Binding</a></p></td>
|
|
</tr>
|
|
<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_binding">v1.Binding</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_binding">v1.Binding</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_58">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_58">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_58">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_eviction_of_a_pod">create eviction of a Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/pods/{name}/eviction</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_58">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_eviction">v1beta1.Eviction</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Eviction</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_59">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_eviction">v1beta1.Eviction</a></p></td>
|
|
</tr>
|
|
<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_eviction">v1beta1.Eviction</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1beta1_eviction">v1beta1.Eviction</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_59">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_59">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_59">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_get_requests_to_exec_of_pod">connect GET requests to exec of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/pods/{name}/exec</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_59">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">stdin</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Redirect the standard input stream of the pod for this call. Defaults to false.</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">stdout</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Redirect the standard output stream of the pod for this call. Defaults to true.</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">stderr</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Redirect the standard error stream of the pod for this call. Defaults to true.</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">tty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.</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">container</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Container in which to execute the command. Defaults to only container if there is only one container in the pod.</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">command</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Command is the remote command to execute. argv array. Not executed within a shell.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_60">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_60">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_60">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_60">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_post_requests_to_exec_of_pod">connect POST requests to exec of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/pods/{name}/exec</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_60">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">stdin</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Redirect the standard input stream of the pod for this call. Defaults to false.</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">stdout</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Redirect the standard output stream of the pod for this call. Defaults to true.</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">stderr</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Redirect the standard error stream of the pod for this call. Defaults to true.</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">tty</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.</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">container</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Container in which to execute the command. Defaults to only container if there is only one container in the pod.</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">command</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Command is the remote command to execute. argv array. Not executed within a shell.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_61">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_61">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_61">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_61">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_log_of_the_specified_pod">read log of the specified Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/pods/{name}/log</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_61">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">container</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The container for which to stream logs. Defaults to only container if there is one container in the pod.</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">follow</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Follow the log stream of the pod. Defaults to false.</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">previous</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Return previous terminated container logs. Defaults to false.</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">sinceSeconds</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.</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">timestamps</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.</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">tailLines</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime</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">limitBytes</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_62">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_62">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_62">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>text/plain</p>
|
|
</li>
|
|
<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_62">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_get_requests_to_portforward_of_pod">connect GET requests to portforward of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/pods/{name}/portforward</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_62">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">ports</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">List of ports to forward Required when using WebSockets</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_63">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_63">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_63">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_63">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_post_requests_to_portforward_of_pod">connect POST requests to portforward of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/pods/{name}/portforward</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_63">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">ports</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">List of ports to forward Required when using WebSockets</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_64">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_64">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_64">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_64">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_get_requests_to_proxy_of_pod">connect GET requests to proxy of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/pods/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_64">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_65">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_65">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_65">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_65">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_put_requests_to_proxy_of_pod">connect PUT requests to proxy of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_65">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_66">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_66">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_66">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_66">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_delete_requests_to_proxy_of_pod">connect DELETE requests to proxy of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_66">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_67">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_67">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_67">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_67">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_post_requests_to_proxy_of_pod">connect POST requests to proxy of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/pods/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_67">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_68">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_68">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_68">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_68">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_patch_requests_to_proxy_of_pod">connect PATCH requests to proxy of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/pods/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_68">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_69">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_69">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_69">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_69">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_get_requests_to_proxy_of_pod_2">connect GET requests to proxy of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_69">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_70">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_70">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_70">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_70">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_put_requests_to_proxy_of_pod_2">connect PUT requests to proxy of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_70">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_71">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_71">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_71">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_71">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_delete_requests_to_proxy_of_pod_2">connect DELETE requests to proxy of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_71">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_72">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_72">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_72">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_72">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_post_requests_to_proxy_of_pod_2">connect POST requests to proxy of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_72">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_73">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_73">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_73">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_73">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_patch_requests_to_proxy_of_pod_2">connect PATCH requests to proxy of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_73">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to pod.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_74">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_74">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_74">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_74">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_status_of_the_specified_pod">read status of the specified Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/pods/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_74">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">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_75">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_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_75">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_75">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_75">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_status_of_the_specified_pod">replace status of the specified Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/pods/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_75">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_pod">v1.Pod</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_76">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_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_76">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_76">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_76">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_status_of_the_specified_pod">partially update status of the specified Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/pods/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_76">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_77">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_pod">v1.Pod</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_77">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_77">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_77">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_podtemplate">list or watch objects of kind PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/podtemplates</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_77">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_78">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_podtemplatelist">v1.PodTemplateList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_78">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_78">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_78">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_podtemplate">delete collection of PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/podtemplates</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_78">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_79">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_79">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_79">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_79">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_podtemplate">create a PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/podtemplates</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_79">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_podtemplate">v1.PodTemplate</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_80">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_podtemplate">v1.PodTemplate</a></p></td>
|
|
</tr>
|
|
<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_podtemplate">v1.PodTemplate</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_podtemplate">v1.PodTemplate</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_80">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_80">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_80">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_podtemplate">read the specified PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/podtemplates/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_80">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PodTemplate</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_81">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_podtemplate">v1.PodTemplate</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_81">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_81">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_81">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_podtemplate">replace the specified PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/podtemplates/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_81">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_podtemplate">v1.PodTemplate</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PodTemplate</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_82">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_podtemplate">v1.PodTemplate</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_podtemplate">v1.PodTemplate</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_82">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_82">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_82">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_podtemplate">delete a PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_82">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PodTemplate</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_83">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_83">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_83">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_83">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_podtemplate">partially update the specified PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_83">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PodTemplate</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_84">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_podtemplate">v1.PodTemplate</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_84">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_84">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_84">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_replicationcontroller">list or watch objects of kind ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/replicationcontrollers</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_84">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_85">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_replicationcontrollerlist">v1.ReplicationControllerList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_85">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_85">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_85">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_replicationcontroller">delete collection of ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/replicationcontrollers</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_85">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_86">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_86">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_86">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_86">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_replicationcontroller">create a ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/replicationcontrollers</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_86">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_replicationcontroller">v1.ReplicationController</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_87">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
<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_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_87">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_87">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_87">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_replicationcontroller">read the specified ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_87">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ReplicationController</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_88">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_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_88">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_88">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_88">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_replicationcontroller">replace the specified ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_88">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_replicationcontroller">v1.ReplicationController</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ReplicationController</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_89">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_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_89">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_89">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_89">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_replicationcontroller">delete a ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_89">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ReplicationController</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_90">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_90">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_90">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_90">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_replicationcontroller">partially update the specified ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_90">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ReplicationController</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_91">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_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_91">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_91">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_91">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_scale_of_the_specified_replicationcontroller">read scale of the specified ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_91">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">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Scale</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_92">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_scale">v1.Scale</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_92">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_92">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_92">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_scale_of_the_specified_replicationcontroller">replace scale of the specified ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_92">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_scale">v1.Scale</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Scale</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_93">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_scale">v1.Scale</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_scale">v1.Scale</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_93">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_93">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_93">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_scale_of_the_specified_replicationcontroller">partially update scale of the specified ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_93">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Scale</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_94">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_scale">v1.Scale</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_94">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_94">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_94">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_status_of_the_specified_replicationcontroller">read status of the specified ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_94">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">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ReplicationController</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_95">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_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_95">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_95">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_95">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_status_of_the_specified_replicationcontroller">replace status of the specified ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_95">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_replicationcontroller">v1.ReplicationController</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ReplicationController</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_96">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_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_96">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_96">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_96">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_status_of_the_specified_replicationcontroller">partially update status of the specified ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_96">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ReplicationController</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_97">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_replicationcontroller">v1.ReplicationController</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_97">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_97">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_97">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_resourcequota">list or watch objects of kind ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/resourcequotas</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_97">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_98">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_resourcequotalist">v1.ResourceQuotaList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_98">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_98">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_98">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_resourcequota">delete collection of ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/resourcequotas</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_98">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_99">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_99">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_99">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_99">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_resourcequota">create a ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/resourcequotas</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_99">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_resourcequota">v1.ResourceQuota</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_100">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
<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_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_100">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_100">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_100">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_resourcequota">read the specified ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/resourcequotas/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_100">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ResourceQuota</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_101">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_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_101">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_101">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_101">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_resourcequota">replace the specified ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_101">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_resourcequota">v1.ResourceQuota</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ResourceQuota</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_102">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_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_102">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_102">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_102">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_resourcequota">delete a ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_102">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ResourceQuota</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_103">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_103">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_103">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_103">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_resourcequota">partially update the specified ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_103">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ResourceQuota</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_104">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_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_104">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_104">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_104">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_status_of_the_specified_resourcequota">read status of the specified ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_104">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">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ResourceQuota</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_105">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_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_105">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_105">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_105">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_status_of_the_specified_resourcequota">replace status of the specified ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_105">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_resourcequota">v1.ResourceQuota</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ResourceQuota</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_106">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_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_106">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_106">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_106">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_status_of_the_specified_resourcequota">partially update status of the specified ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_106">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ResourceQuota</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_107">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_resourcequota">v1.ResourceQuota</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_107">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_107">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_107">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_secret">list or watch objects of kind Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/secrets</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_107">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_108">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_secretlist">v1.SecretList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_108">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_108">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_108">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_secret">delete collection of Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/secrets</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_108">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_109">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_109">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_109">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_109">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_secret">create a Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/secrets</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_109">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_secret">v1.Secret</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_110">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_secret">v1.Secret</a></p></td>
|
|
</tr>
|
|
<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_secret">v1.Secret</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_secret">v1.Secret</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_110">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_110">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_110">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_secret">read the specified Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/secrets/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_110">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Secret</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_111">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_secret">v1.Secret</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_111">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_111">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_111">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_secret">replace the specified Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/secrets/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_111">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_secret">v1.Secret</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Secret</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_112">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_secret">v1.Secret</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_secret">v1.Secret</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_112">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_112">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_112">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_secret">delete a Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/secrets/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_112">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Secret</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_113">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_113">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_113">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_113">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_secret">partially update the specified Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/secrets/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_113">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Secret</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_114">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_secret">v1.Secret</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_114">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_114">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_114">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_serviceaccount">list or watch objects of kind ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/serviceaccounts</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_114">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_115">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_serviceaccountlist">v1.ServiceAccountList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_115">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_115">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_115">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_serviceaccount">delete collection of ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/serviceaccounts</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_115">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_116">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_116">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_116">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_116">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_serviceaccount">create a ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/serviceaccounts</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_116">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_serviceaccount">v1.ServiceAccount</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_117">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_serviceaccount">v1.ServiceAccount</a></p></td>
|
|
</tr>
|
|
<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_serviceaccount">v1.ServiceAccount</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_serviceaccount">v1.ServiceAccount</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_117">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_117">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_117">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_serviceaccount">read the specified ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_117">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ServiceAccount</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_118">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_serviceaccount">v1.ServiceAccount</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_118">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_118">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_118">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_serviceaccount">replace the specified ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_118">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_serviceaccount">v1.ServiceAccount</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ServiceAccount</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_119">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_serviceaccount">v1.ServiceAccount</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_serviceaccount">v1.ServiceAccount</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_119">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_119">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_119">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_serviceaccount">delete a ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_119">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ServiceAccount</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_120">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_120">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_120">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_120">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_serviceaccount">partially update the specified ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_120">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ServiceAccount</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_121">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_serviceaccount">v1.ServiceAccount</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_121">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_121">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_121">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_service">list or watch objects of kind Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/services</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_121">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_122">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_servicelist">v1.ServiceList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_122">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_122">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_122">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_service">create a Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/services</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_122">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_service">v1.Service</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_123">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_service">v1.Service</a></p></td>
|
|
</tr>
|
|
<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_service">v1.Service</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_service">v1.Service</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_123">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_123">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_123">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_service">read the specified Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/services/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_123">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_124">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_service">v1.Service</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_124">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_124">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_124">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_service">replace the specified Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/services/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_124">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_service">v1.Service</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_125">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_service">v1.Service</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_service">v1.Service</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_125">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_125">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_125">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_service">delete a Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/services/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_125">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_126">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_126">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_126">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_126">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_service">partially update the specified Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/services/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_126">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_127">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_service">v1.Service</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_127">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_127">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_127">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_get_requests_to_proxy_of_service">connect GET requests to proxy of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/services/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_127">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is <a href="http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy">http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy</a>. Path is _search?q=user:kimchy.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_128">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_128">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_128">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_128">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_put_requests_to_proxy_of_service">connect PUT requests to proxy of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/services/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_128">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is <a href="http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy">http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy</a>. Path is _search?q=user:kimchy.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_129">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_129">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_129">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_129">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_delete_requests_to_proxy_of_service">connect DELETE requests to proxy of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_129">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is <a href="http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy">http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy</a>. Path is _search?q=user:kimchy.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_130">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_130">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_130">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_130">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_post_requests_to_proxy_of_service">connect POST requests to proxy of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/services/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_130">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is <a href="http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy">http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy</a>. Path is _search?q=user:kimchy.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_131">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_131">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_131">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_131">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_patch_requests_to_proxy_of_service">connect PATCH requests to proxy of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/services/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_131">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is <a href="http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy">http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy</a>. Path is _search?q=user:kimchy.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_132">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_132">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_132">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_132">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_get_requests_to_proxy_of_service_2">connect GET requests to proxy of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_132">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is <a href="http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy">http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy</a>. Path is _search?q=user:kimchy.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_133">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_133">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_133">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_133">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_put_requests_to_proxy_of_service_2">connect PUT requests to proxy of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_133">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is <a href="http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy">http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy</a>. Path is _search?q=user:kimchy.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_134">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_134">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_134">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_134">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_delete_requests_to_proxy_of_service_2">connect DELETE requests to proxy of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_134">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is <a href="http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy">http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy</a>. Path is _search?q=user:kimchy.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_135">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_135">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_135">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_135">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_post_requests_to_proxy_of_service_2">connect POST requests to proxy of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_135">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is <a href="http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy">http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy</a>. Path is _search?q=user:kimchy.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_136">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_136">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_136">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_136">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_patch_requests_to_proxy_of_service_2">connect PATCH requests to proxy of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_136">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is <a href="http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy">http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy</a>. Path is _search?q=user:kimchy.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_137">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_137">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_137">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_137">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_status_of_the_specified_service">read status of the specified Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{namespace}/services/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_137">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">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_138">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_service">v1.Service</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_138">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_138">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_138">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_status_of_the_specified_service">replace status of the specified Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{namespace}/services/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_138">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_service">v1.Service</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_139">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_service">v1.Service</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_service">v1.Service</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_139">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_139">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_139">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_status_of_the_specified_service">partially update status of the specified Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{namespace}/services/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_139">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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_140">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_service">v1.Service</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_140">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_140">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_140">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_namespace">read the specified Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_140">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 Namespace</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_141">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_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_141">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_141">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_141">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_namespace">replace the specified Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_141">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_namespace">v1.Namespace</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 Namespace</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_142">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_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_142">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_142">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_142">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_namespace">delete a Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/namespaces/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_142">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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 Namespace</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_143">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_143">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_143">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_143">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_namespace">partially update the specified Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_143">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 Namespace</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_144">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_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_144">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_144">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_144">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_finalize_of_the_specified_namespace">replace finalize of the specified Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{name}/finalize</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_144">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_namespace">v1.Namespace</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 Namespace</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_145">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_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_145">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_145">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_145">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_status_of_the_specified_namespace">read status of the specified Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/namespaces/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_145">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">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 Namespace</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_146">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_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_146">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_146">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_146">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_status_of_the_specified_namespace">replace status of the specified Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/namespaces/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_146">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_namespace">v1.Namespace</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 Namespace</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_147">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_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_147">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_147">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_147">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_status_of_the_specified_namespace">partially update status of the specified Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/namespaces/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_147">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 Namespace</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_148">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_namespace">v1.Namespace</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_148">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_148">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_148">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_node">list or watch objects of kind Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/nodes</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_148">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_149">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_nodelist">v1.NodeList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_149">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_149">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_149">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_node">delete collection of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/nodes</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_149">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_150">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_150">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_150">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_150">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_node">create a Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/nodes</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_150">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_node">v1.Node</a></p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_151">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_node">v1.Node</a></p></td>
|
|
</tr>
|
|
<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_node">v1.Node</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_node">v1.Node</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_151">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_151">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_151">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_node">read the specified Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/nodes/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_151">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 Node</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_152">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_node">v1.Node</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_152">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_152">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_152">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_node">replace the specified Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/nodes/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_152">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_node">v1.Node</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 Node</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_153">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_node">v1.Node</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_node">v1.Node</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_153">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_153">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_153">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_node">delete a Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/nodes/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_153">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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 Node</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_154">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_154">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_154">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_154">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_node">partially update the specified Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/nodes/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_154">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 Node</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_155">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_node">v1.Node</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_155">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_155">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_155">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_get_requests_to_proxy_of_node">connect GET requests to proxy of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/nodes/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_155">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to node.</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 Node</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_156">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_156">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_156">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_156">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_put_requests_to_proxy_of_node">connect PUT requests to proxy of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/nodes/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_156">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to node.</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 Node</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_157">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_157">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_157">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_157">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_delete_requests_to_proxy_of_node">connect DELETE requests to proxy of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/nodes/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_157">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to node.</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 Node</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_158">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_158">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_158">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_158">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_post_requests_to_proxy_of_node">connect POST requests to proxy of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/nodes/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_158">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to node.</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 Node</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_159">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_159">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_159">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_159">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_patch_requests_to_proxy_of_node">connect PATCH requests to proxy of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/nodes/{name}/proxy</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_159">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to node.</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 Node</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_160">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_160">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_160">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_160">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_get_requests_to_proxy_of_node_2">connect GET requests to proxy of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/nodes/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_160">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to node.</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 Node</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_161">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_161">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_161">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_161">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_put_requests_to_proxy_of_node_2">connect PUT requests to proxy of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/nodes/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_161">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to node.</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 Node</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_162">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_162">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_162">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_162">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_delete_requests_to_proxy_of_node_2">connect DELETE requests to proxy of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/nodes/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_162">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to node.</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 Node</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_163">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_163">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_163">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_163">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_post_requests_to_proxy_of_node_2">connect POST requests to proxy of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/nodes/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_163">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to node.</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 Node</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_164">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_164">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_164">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_164">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_connect_patch_requests_to_proxy_of_node_2">connect PATCH requests to proxy of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/nodes/{name}/proxy/{path}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_164">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">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Path is the URL path to use for the current proxy request to node.</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 Node</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>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">PathParameter</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">path to the resource</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_165">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">string</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_165">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_165">Produces</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_tags_165">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_status_of_the_specified_node">read status of the specified Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/nodes/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_165">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">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 Node</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_166">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_node">v1.Node</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_166">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_166">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_166">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_status_of_the_specified_node">replace status of the specified Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/nodes/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_166">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_node">v1.Node</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 Node</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_167">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_node">v1.Node</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_node">v1.Node</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_167">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_167">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_167">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_status_of_the_specified_node">partially update status of the specified Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/nodes/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_167">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 Node</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_168">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_node">v1.Node</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_168">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_168">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_168">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_persistentvolumeclaim_2">list or watch objects of kind PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/persistentvolumeclaims</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_168">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_169">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_persistentvolumeclaimlist">v1.PersistentVolumeClaimList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_169">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_169">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_169">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_persistentvolume">list or watch objects of kind PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/persistentvolumes</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_169">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_170">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_persistentvolumelist">v1.PersistentVolumeList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_170">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_170">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_170">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_collection_of_persistentvolume">delete collection of PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/persistentvolumes</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_170">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_171">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_171">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_171">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_171">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_create_a_persistentvolume">create a PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>POST /api/v1/persistentvolumes</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_171">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_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
<td class="tableblock halign-left valign-top"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_172">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">202</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Accepted</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
<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_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_172">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_172">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_172">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_the_specified_persistentvolume">read the specified PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/persistentvolumes/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_172">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 PersistentVolume</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_173">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_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_173">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_173">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_173">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_the_specified_persistentvolume">replace the specified PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/persistentvolumes/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_173">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_persistentvolume">v1.PersistentVolume</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 PersistentVolume</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_174">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_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_174">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_174">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_174">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_delete_a_persistentvolume">delete a PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>DELETE /api/v1/persistentvolumes/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_174">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. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: <em>Orphan</em> - orphan the dependents; <em>Background</em> - allow the garbage collector to delete the dependents in the background; <em>Foreground</em> - a cascading policy that deletes all dependents in the foreground.</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 PersistentVolume</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_175">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_175">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_175">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_175">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_the_specified_persistentvolume">partially update the specified PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/persistentvolumes/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_175">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 PersistentVolume</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_176">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_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_176">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_176">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_176">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_read_status_of_the_specified_persistentvolume">read status of the specified PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/persistentvolumes/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_176">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">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 PersistentVolume</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_177">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_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_177">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_177">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_177">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_replace_status_of_the_specified_persistentvolume">replace status of the specified PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PUT /api/v1/persistentvolumes/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_177">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_persistentvolume">v1.PersistentVolume</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 PersistentVolume</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_178">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_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">201</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Created</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../definitions#_v1_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_178">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_178">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_178">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_partially_update_status_of_the_specified_persistentvolume">partially update status of the specified PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>PATCH /api/v1/persistentvolumes/{name}/status</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_178">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 PersistentVolume</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_179">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_persistentvolume">v1.PersistentVolume</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_179">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_179">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_179">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_pod_2">list or watch objects of kind Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/pods</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_179">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_180">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_podlist">v1.PodList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_180">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_180">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_180">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_podtemplate_2">list or watch objects of kind PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/podtemplates</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_180">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_181">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_podtemplatelist">v1.PodTemplateList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_181">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_181">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_181">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_replicationcontroller_2">list or watch objects of kind ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/replicationcontrollers</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_181">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_182">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_replicationcontrollerlist">v1.ReplicationControllerList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_182">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_182">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_182">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_resourcequota_2">list or watch objects of kind ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/resourcequotas</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_182">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_183">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_resourcequotalist">v1.ResourceQuotaList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_183">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_183">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_183">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_secret_2">list or watch objects of kind Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/secrets</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_183">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_184">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_secretlist">v1.SecretList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_184">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_184">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_184">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_serviceaccount_2">list or watch objects of kind ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/serviceaccounts</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_184">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_185">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_serviceaccountlist">v1.ServiceAccountList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_185">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_185">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_185">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_list_or_watch_objects_of_kind_service_2">list or watch objects of kind Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/services</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_185">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_186">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_servicelist">v1.ServiceList</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_consumes_186">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_186">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_186">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_configmap">watch individual changes to a list of ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/configmaps</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_186">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_187">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_187">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_187">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_187">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_endpoints">watch individual changes to a list of Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/endpoints</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_187">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_188">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_188">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_188">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_188">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_event">watch individual changes to a list of Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/events</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_188">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_189">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_189">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_189">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_189">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_limitrange">watch individual changes to a list of LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/limitranges</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_189">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_190">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_190">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_190">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_190">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_namespace">watch individual changes to a list of Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_190">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_191">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_191">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_191">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_191">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_configmap_2">watch individual changes to a list of ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/configmaps</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_191">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_192">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_192">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_192">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_192">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_configmap">watch changes to an object of kind ConfigMap</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_192">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ConfigMap</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_193">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_193">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_193">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_193">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_endpoints_2">watch individual changes to a list of Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/endpoints</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_193">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_194">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_194">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_194">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_194">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_endpoints">watch changes to an object of kind Endpoints</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_194">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Endpoints</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_195">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_195">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_195">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_195">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_event_2">watch individual changes to a list of Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/events</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_195">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_196">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_196">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_196">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_196">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_event">watch changes to an object of kind Event</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/events/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_196">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Event</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_197">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_197">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_197">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_197">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_limitrange_2">watch individual changes to a list of LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/limitranges</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_197">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_198">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_198">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_198">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_198">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_limitrange">watch changes to an object of kind LimitRange</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_198">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 LimitRange</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_199">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_199">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_199">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_199">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_persistentvolumeclaim">watch individual changes to a list of PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_199">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_200">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_200">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_200">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_200">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_persistentvolumeclaim">watch changes to an object of kind PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_200">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PersistentVolumeClaim</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_201">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_201">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_201">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_201">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_pod">watch individual changes to a list of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/pods</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_201">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_202">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_202">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_202">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_202">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_pod">watch changes to an object of kind Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/pods/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_202">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Pod</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_203">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_203">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_203">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_203">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_podtemplate">watch individual changes to a list of PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/podtemplates</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_203">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_204">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_204">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_204">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_204">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_podtemplate">watch changes to an object of kind PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_204">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 PodTemplate</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_205">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_205">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_205">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_205">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_replicationcontroller">watch individual changes to a list of ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_205">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_206">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_206">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_206">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_206">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_replicationcontroller">watch changes to an object of kind ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_206">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ReplicationController</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_207">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_207">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_207">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_207">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_resourcequota">watch individual changes to a list of ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/resourcequotas</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_207">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_208">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_208">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_208">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_208">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_resourcequota">watch changes to an object of kind ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_208">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ResourceQuota</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_209">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_209">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_209">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_209">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_secret">watch individual changes to a list of Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/secrets</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_209">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_210">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_210">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_210">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_210">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_secret">watch changes to an object of kind Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/secrets/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_210">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Secret</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_211">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_211">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_211">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_211">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_serviceaccount">watch individual changes to a list of ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/serviceaccounts</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_211">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_212">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_212">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_212">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_212">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_serviceaccount">watch changes to an object of kind ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_212">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 ServiceAccount</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_213">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_213">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_213">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_213">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_service">watch individual changes to a list of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/services</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_213">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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_214">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_214">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_214">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_214">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_service">watch changes to an object of kind Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{namespace}/services/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_214">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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">namespace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object name and auth scope, such as for teams and projects</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>
|
|
<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 Service</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_215">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_215">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_215">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_215">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_namespace">watch changes to an object of kind Namespace</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/namespaces/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_215">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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 Namespace</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_216">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_216">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_216">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_216">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_node">watch individual changes to a list of Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/nodes</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_216">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_217">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_217">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_217">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_217">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_node">watch changes to an object of kind Node</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/nodes/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_217">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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 Node</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_218">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_218">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_218">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_218">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_persistentvolumeclaim_2">watch individual changes to a list of PersistentVolumeClaim</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/persistentvolumeclaims</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_218">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_219">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_219">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_219">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_219">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_persistentvolume">watch individual changes to a list of PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/persistentvolumes</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_219">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_220">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_220">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_220">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_220">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_changes_to_an_object_of_kind_persistentvolume">watch changes to an object of kind PersistentVolume</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/persistentvolumes/{name}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_220">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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 PersistentVolume</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_221">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_221">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_221">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_221">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_pod_2">watch individual changes to a list of Pod</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/pods</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_221">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_222">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_222">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_222">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_222">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_podtemplate_2">watch individual changes to a list of PodTemplate</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/podtemplates</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_222">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_223">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_223">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_223">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_223">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_replicationcontroller_2">watch individual changes to a list of ReplicationController</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/replicationcontrollers</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_223">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_224">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_224">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_224">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_224">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_resourcequota_2">watch individual changes to a list of ResourceQuota</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/resourcequotas</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_224">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_225">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_225">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_225">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_225">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_secret_2">watch individual changes to a list of Secret</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/secrets</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_225">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_226">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_226">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_226">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_226">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_serviceaccount_2">watch individual changes to a list of ServiceAccount</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/serviceaccounts</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_226">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_227">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_227">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_227">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_227">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_watch_individual_changes_to_a_list_of_service_2">watch individual changes to a list of Service</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre>GET /api/v1/watch/services</pre>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_parameters_227">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">includeUninitialized</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, partially initialized resources are included in the response.</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">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. This limits the duration of the call, regardless of any activity or inactivity.</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">limit</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">limit is a maximum number of responses to return for a list call. If more items exist, the server will set the <code>continue</code> field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
|
|
</p><p class="tableblock">The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.</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">continue</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_responses_228">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_228">Consumes</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>/</strong></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_produces_228">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_228">Tags</h4>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>apiv1</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="footer">
|
|
<div id="footer-text">
|
|
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |