forked from docs/doc-exports
Dong, Qiu Jian
f5c28c856a
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com> Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com> Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
174 lines
14 KiB
HTML
174 lines
14 KiB
HTML
<a name="swr_02_0032"></a><a name="swr_02_0032"></a>
|
|
|
|
<h1 class="topictitle1">Updating the Brief Information on an Image Repository</h1>
|
|
<div id="body1531798197430"><div class="section" id="swr_02_0032__section14905762191056"><h4 class="sectiontitle">Function</h4><p id="swr_02_0032__p38546794191926">Update the brief information on an image repository in an organization, including the <strong id="swr_02_0032__b15435520531">category</strong>, <strong id="swr_02_0032__b1154315545318">is_public</strong>, and <strong id="swr_02_0032__b954435175313">description</strong>.</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0032__section10482810165331"><h4 class="sectiontitle">URI</h4><p id="swr_02_0032__p67361389312">PATCH /v2/manage/namespaces/{<em id="swr_02_0032__i13551239543">namespace</em>}/repos/{<em id="swr_02_0032__i151698433416">repository</em>}</p>
|
|
<p id="swr_02_0032__p15912737141515">For details about parameters, see <a href="#swr_02_0032__table16521054337">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="swr_02_0032__table16521054337"></a><a name="table16521054337"></a><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0032__table16521054337" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="swr_02_0032__en-us_topic_0000001231113969_row14188145613435"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="swr_02_0032__en-us_topic_0000001231113969_p1318910561434">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="swr_02_0032__en-us_topic_0000001231113969_p91891356154316">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="swr_02_0032__en-us_topic_0000001231113969_p8189456104318">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="swr_02_0032__en-us_topic_0000001231113969_p181891456174312">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0032__en-us_topic_0000001231113969_row111883562439"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="swr_02_0032__en-us_topic_0000001231113969_p13189356194312">namespace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="swr_02_0032__en-us_topic_0000001231113969_p13190356124313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="swr_02_0032__en-us_topic_0000001231113969_p6190135615434">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="swr_02_0032__en-us_topic_0000001231113969_p119055617432">Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0032__en-us_topic_0000001231113969_row20188105618435"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="swr_02_0032__en-us_topic_0000001231113969_p6190105694310">repository</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="swr_02_0032__en-us_topic_0000001231113969_p319017561436">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="swr_02_0032__en-us_topic_0000001231113969_p1419118564433">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="swr_02_0032__en-us_topic_0000001231113969_p159671338184410">Image repository name. Enter 1 to 128 characters. It must start and end with a lowercase letter or digit. Only lowercase letters, digits, periods (.), slashes (/), underscores (_), and hyphens (-) are allowed. Periods, slashes, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. Replace a slash (/) with a dollar sign ($) before you send the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0032__section1340953141615"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0032__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="swr_02_0032__row12341125321610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="swr_02_0032__p16343165315163">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="swr_02_0032__p4343105312166">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="swr_02_0032__p934475341617">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="swr_02_0032__p1934513539166">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0032__row23421853161618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="swr_02_0032__p0345205331616">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="swr_02_0032__p334675314160">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="swr_02_0032__p934625331614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="swr_02_0032__p113471653161615">Message body type (format). The value can be <strong id="swr_02_0032__b14317671887958">application/json</strong> or <strong id="swr_02_0032__b12174376587958">charset=utf-8 application/json</strong>.</p>
|
|
<p id="swr_02_0032__p23471053151619">The default value is <strong id="swr_02_0032__b8689228677143">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0032__row234212533163"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="swr_02_0032__p173481539167">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="swr_02_0032__p1634855341613">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="swr_02_0032__p2349195361618">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="swr_02_0032__p1934918539168">User token.</p>
|
|
<p id="swr_02_0032__p8350205351616">The token can be obtained by calling an IAM API. The value of <strong id="swr_02_0032__b156962163571413">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0032__request_UpdateRepoRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="swr_02_0032__row1035325317164"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="swr_02_0032__p135575381613">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="swr_02_0032__p113551753161615">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="swr_02_0032__p143567533161">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="swr_02_0032__p7356115315163">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0032__row133539538169"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="swr_02_0032__p1535715534161">is_public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="swr_02_0032__p13357753191610">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="swr_02_0032__p15357185391617">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="swr_02_0032__p173581653171613">Whether the repository is public. <strong id="swr_02_0032__b22301337371745">true</strong> indicates that the repository is public. <strong id="swr_02_0032__b40157442071745">false</strong> indicates that the repository is private.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0032__row0353195311162"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="swr_02_0032__p1935817531165">category</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="swr_02_0032__p235916535166">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="swr_02_0032__p20359453141617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="swr_02_0032__p1360105310169">Repository type. The value can be <strong id="swr_02_0032__b1219824092316">app_server</strong>, <strong id="swr_02_0032__b19199154018232">linux</strong>, <strong id="swr_02_0032__b12199540152319">framework_app</strong>, <strong id="swr_02_0032__b1019911407234">database</strong>, <strong id="swr_02_0032__b719918401234">lang</strong>, <strong id="swr_02_0032__b17200184012316">arm</strong>, or <strong id="swr_02_0032__b13200134020231">other</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0032__row43541953151614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="swr_02_0032__p173601253171616">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="swr_02_0032__p19361135331619">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="swr_02_0032__p03611553101618">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="swr_02_0032__p63621453141613">Brief description of the image repository.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0032__section17362195391612"><h4 class="sectiontitle">Response Parameters</h4><p id="swr_02_0032__p1836345320162">None</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0032__section636316530167"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="swr_02_0032__screen13364115314164">PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}
|
|
|
|
{
|
|
"category" : "database",
|
|
"description" : "this is a busybox repository",
|
|
"is_public" : false
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="swr_02_0032__section1636717535168"><h4 class="sectiontitle">Example Response</h4><p id="swr_02_0032__p103671053111612">None</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0032__section5365169104253"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0032__table69017321572" frame="border" border="1" rules="all"><thead align="left"><tr id="swr_02_0032__row13902732879"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.7.2.1.3.1.1"><p id="swr_02_0032__p189029321477">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.7.2.1.3.1.2"><p id="swr_02_0032__p8902532779">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0032__row1190213320715"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.1 "><p id="swr_02_0032__p179026321175">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.2 "><p id="swr_02_0032__p1890233210713">The brief information about the image repository is successfully updated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0032__row179029321470"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.1 "><p id="swr_02_0032__p490220329714">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.2 "><p id="swr_02_0032__p4902143218720">Request error. Error information is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0032__row156697155718"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.1 "><p id="swr_02_0032__p195672711578">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.2 "><p id="swr_02_0032__p125673745714">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0032__row1990243213715"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.1 "><p id="swr_02_0032__p490263216714">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.2 "><p id="swr_02_0032__p690263216716">The repository does not exist.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0032__row2090313216713"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.1 "><p id="swr_02_0032__p129030329719">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.2 "><p id="swr_02_0032__p090314328715">Internal error. Error information is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0032__section134071631161117"><h4 class="sectiontitle">Error Codes</h4><p id="swr_02_0032__p15408431161114">For details, see <a href="swr_02_0024.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0000001420528490.html">Image Repository Management</a></div>
|
|
</div>
|
|
</div>
|
|
|