forked from docs/doc-exports
Chen, Junjie
ef239b7410
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
175 lines
18 KiB
HTML
175 lines
18 KiB
HTML
<a name="kafka-api-180514004"></a><a name="kafka-api-180514004"></a>
|
|
|
|
<h1 class="topictitle1">Modifying an Instance</h1>
|
|
<div id="body1524661275118"><div class="note" id="kafka-api-180514004__note159644115208"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kafka-api-180514004__p0964111132019">This API is out-of-date and may not be maintained in the future. Please use the API described in <a href="UpdateInstance.html">Modifying Instance Information</a>.</p>
|
|
</div></div>
|
|
<div class="section" id="kafka-api-180514004__en-us_topic_0128036897_section16640184612281"><h4 class="sectiontitle">Function</h4><p id="kafka-api-180514004__en-us_topic_0128036897_p10680162813110">This API is used to modify the instance information, including the instance name, description, maintenance window, and security group.</p>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514004__en-us_topic_0128036897_section1333816281512"><h4 class="sectiontitle">URI</h4><p id="kafka-api-180514004__en-us_topic_0128036897_p46808281115">PUT /v1.0/{project_id}/instances/{instance_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514004__en-us_topic_0128036897_table434018282110" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kafka-api-180514004__en-us_topic_0128036897_row46806283114"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.2.5.1.1"><p id="kafka-api-180514004__en-us_topic_0128036897_p1368010288120">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.2.5.1.2"><p id="kafka-api-180514004__en-us_topic_0128036897_p86803283111">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.2.5.1.3"><p id="kafka-api-180514004__en-us_topic_0128036897_p1568018281318">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.2.5.1.4"><p id="kafka-api-180514004__en-us_topic_0128036897_p166801828014">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514004__en-us_topic_0128036897_row186802285111"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.1 "><p id="kafka-api-180514004__en-us_topic_0128036897_p1268012813116">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.2 "><p id="kafka-api-180514004__en-us_topic_0128036897_p86812281319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.3 "><p id="kafka-api-180514004__en-us_topic_0128036897_p1768110283116">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.4 "><p id="kafka-api-180514004__en-us_topic_0128036897_p20681182818117">Indicates the ID of a project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514004__en-us_topic_0128036897_row968112281014"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.1 "><p id="kafka-api-180514004__en-us_topic_0128036897_p868112281017">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.2 "><p id="kafka-api-180514004__en-us_topic_0128036897_p9681328010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.3 "><p id="kafka-api-180514004__en-us_topic_0128036897_p4681192819115">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.4 "><p id="kafka-api-180514004__en-us_topic_0128036897_p96811287114">Indicates the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514004__en-us_topic_0128036897_section1535592810114"><h4 class="sectiontitle">Request</h4><p id="kafka-api-180514004__en-us_topic_0128036897_p19681928510"><strong id="kafka-api-180514004__en-us_topic_0128036897_b16304123124015">Request parameters</strong></p>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p186811289117"><a href="#kafka-api-180514004__en-us_topic_0128036897_table1535615281916">Table 2</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514004__en-us_topic_0128036897_table1535615281916"></a><a name="en-us_topic_0128036897_table1535615281916"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514004__en-us_topic_0128036897_table1535615281916" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kafka-api-180514004__en-us_topic_0128036897_row368114281213"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.4.2.5.1.1"><p id="kafka-api-180514004__en-us_topic_0128036897_p968142814110">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.4.2.5.1.2"><p id="kafka-api-180514004__en-us_topic_0128036897_p268117281614">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9%" id="mcps1.3.4.4.2.5.1.3"><p id="kafka-api-180514004__en-us_topic_0128036897_p56811628914">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.4.2.5.1.4"><p id="kafka-api-180514004__en-us_topic_0128036897_p66814283115">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514004__en-us_topic_0128036897_row76815281815"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514004__en-us_topic_0128036897_p186821628616">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514004__en-us_topic_0128036897_p96821328215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514004__en-us_topic_0128036897_p1668214286117">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514004__en-us_topic_0128036897_p968210281411">Indicates the instance name.</p>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p1968211281517">An instance name consists of 4 to 64 characters including letters, digits, and hyphens (-) and must start with a letter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514004__en-us_topic_0128036897_row19682728211"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514004__en-us_topic_0128036897_p168262813117">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514004__en-us_topic_0128036897_p106825281913">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514004__en-us_topic_0128036897_p36828281414">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514004__en-us_topic_0128036897_p76821928819">Indicates the description of an instance.</p>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p1368213286119">It is a character string containing not more than 1024 characters.</p>
|
|
<div class="note" id="kafka-api-180514004__en-us_topic_0128036897_note23701428716"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="kafka-api-180514004__en-us_topic_0128036897_p26821628212">The backslash (\) and quotation mark (") are special characters for JSON packets. When using these characters in a parameter value, add the escape character (\) before these characters, for example, <strong id="kafka-api-180514004__en-us_topic_0128036897_b143981532181916">\\</strong> and <strong id="kafka-api-180514004__en-us_topic_0128036897_b6398153221915">\"</strong>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514004__en-us_topic_0128036897_row2682152819119"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514004__en-us_topic_0128036897_p86829282112">maintain_begin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514004__en-us_topic_0128036897_p468211281014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514004__en-us_topic_0128036897_p18682142817111">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514004__en-us_topic_0128036897_p16332114212416">Indicates the time at which a maintenance time window starts.</p>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p186430194217">Format: HH:mm:ss</p>
|
|
<ul id="kafka-api-180514004__en-us_topic_0128036897_ul368212281211"><li id="kafka-api-180514004__en-us_topic_0128036897_li11682228717">The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details about how to query the time segments of supported maintenance time windows, see <a href="kafka-api-180514010.html">Querying Maintenance Time Windows</a>.</li><li id="kafka-api-180514004__en-us_topic_0128036897_li1368210281118">The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00.</li><li id="kafka-api-180514004__en-us_topic_0128036897_li186821928813">Parameters <strong id="kafka-api-180514004__en-us_topic_0128036897_b5257195412191">maintain_begin</strong> and <strong id="kafka-api-180514004__en-us_topic_0128036897_b32571254121912">maintain_end</strong> must be set in pairs. If parameter <strong id="kafka-api-180514004__en-us_topic_0128036897_b1257185411195">maintain_begin</strong> is left blank, parameter <strong id="kafka-api-180514004__en-us_topic_0128036897_b1625765451915">maintain_end</strong> is also left blank. In this case, the system automatically sets the start time to 02:00:00.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514004__en-us_topic_0128036897_row196828281817"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514004__en-us_topic_0128036897_p46833281516">maintain_end</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514004__en-us_topic_0128036897_p2068392819113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514004__en-us_topic_0128036897_p1368317281511">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514004__en-us_topic_0128036897_p1680119571413">Indicates the time at which a maintenance time window ends.</p>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p17864150174220">Format: HH:mm:ss</p>
|
|
<ul id="kafka-api-180514004__en-us_topic_0128036897_ul186834281112"><li id="kafka-api-180514004__en-us_topic_0128036897_li2683528010">The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details about how to query the time segments of supported maintenance time windows, see <a href="kafka-api-180514010.html">Querying Maintenance Time Windows</a>.</li><li id="kafka-api-180514004__en-us_topic_0128036897_li96835281015">The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.</li><li id="kafka-api-180514004__en-us_topic_0128036897_li2683172815111">Parameters <strong id="kafka-api-180514004__en-us_topic_0128036897_b982316432200">maintain_begin</strong> and <strong id="kafka-api-180514004__en-us_topic_0128036897_b4823154312207">maintain_end</strong> must be set in pairs. If parameter <strong id="kafka-api-180514004__en-us_topic_0128036897_b68235436207">maintain_end</strong> is left blank, parameter <strong id="kafka-api-180514004__en-us_topic_0128036897_b3823174311203">maintain_start</strong> is also left blank. In this case, the system automatically sets the end time to 06:00:00.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514004__en-us_topic_0128036897_row768311286112"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514004__en-us_topic_0128036897_p2683128811">security_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514004__en-us_topic_0128036897_p2683122812114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514004__en-us_topic_0128036897_p136831528418">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514004__en-us_topic_0128036897_p168316286116">Indicates the security group ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514004__en-us_topic_0128036897_row11328171217524"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514004__p010010151529">retention_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514004__p191018151721">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514004__p1310251520217">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514004__p210217157219">Indicates the capacity threshold policy. Options:</p>
|
|
<ul id="kafka-api-180514004__ul510311157216"><li id="kafka-api-180514004__li01039150215"><strong id="kafka-api-180514004__b141571542772814">produce_reject</strong>: New messages cannot be created.</li><li id="kafka-api-180514004__li8103101512214"><strong id="kafka-api-180514004__b88524982572814">time_base</strong>: The earliest messages are deleted.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514004__en-us_topic_0128036897_row174851091530"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514004__en-us_topic_0128036897_p1448315481491">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514004__en-us_topic_0128036897_p1483348154918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514004__en-us_topic_0128036897_p174842048154917">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514004__en-us_topic_0128036897_p8484174824920">Indicates the enterprise project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p868318281018"><strong id="kafka-api-180514004__en-us_topic_0128036897_b1796504518430">Example request</strong></p>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p35151031582">Example 1:</p>
|
|
<pre class="screen" id="kafka-api-180514004__en-us_topic_0128036897_screen14683928519">PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
|
|
{
|
|
"name": "dms002",
|
|
"description": "instance description"
|
|
} </pre>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p1030513423812">Example 2:</p>
|
|
<pre class="screen" id="kafka-api-180514004__en-us_topic_0128036897_screen99736494819">PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
|
|
{
|
|
"name": "dms002",
|
|
"description": "instance description",
|
|
"maintain_begin":"02:00:00",
|
|
"maintain_end":"06:00:00"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514004__en-us_topic_0128036897_section243616287110"><h4 class="sectiontitle">Response</h4><p id="kafka-api-180514004__en-us_topic_0128036897_p1468312814112"><strong id="kafka-api-180514004__en-us_topic_0128036897_b141218537432">Response parameters</strong></p>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p5683112820118">None.</p>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p368312281515"><strong id="kafka-api-180514004__en-us_topic_0128036897_b9808125415434">Example response</strong></p>
|
|
<p id="kafka-api-180514004__en-us_topic_0128036897_p96833288118">None.</p>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514004__en-us_topic_0128036897_section643822820115"><h4 class="sectiontitle">Status Code</h4><p id="kafka-api-180514004__en-us_topic_0128036897_p568414281016"><a href="#kafka-api-180514004__en-us_topic_0128036897_table044092812115">Table 3</a> describes the status code of successful operations. For details about other status codes, see <a href="kafka-api-0034672261.html">Status Code</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514004__en-us_topic_0128036897_table044092812115"></a><a name="en-us_topic_0128036897_table044092812115"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514004__en-us_topic_0128036897_table044092812115" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="kafka-api-180514004__en-us_topic_0128036897_row1368415282114"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.6.3.2.3.1.1"><p id="kafka-api-180514004__en-us_topic_0128036897_p16849281913">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.85000000000001%" id="mcps1.3.6.3.2.3.1.2"><p id="kafka-api-180514004__en-us_topic_0128036897_p5684152812113">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514004__en-us_topic_0128036897_row16842281518"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180514004__en-us_topic_0128036897_p1468410281117">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180514004__en-us_topic_0128036897_p1868410286115">The instance is modified successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="kafka-api-180514001.html">APIs for Managing Instances</a></div>
|
|
</div>
|
|
</div>
|
|
|