forked from docs/doc-exports
Chen, Junjie
7f68b84da4
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
141 lines
10 KiB
HTML
141 lines
10 KiB
HTML
<a name="kafka-api-180514010"></a><a name="kafka-api-180514010"></a>
|
|
|
|
<h1 class="topictitle1">Querying Maintenance Time Windows</h1>
|
|
<div id="body1524661275119"><div class="note" id="kafka-api-180514010__note159644115208"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kafka-api-180514010__p0964111132019">This API is out-of-date and may not be maintained in the future. Please use the API described in <a href="ShowMaintainWindows.html">Listing Maintenance Time Windows</a>.</p>
|
|
</div></div>
|
|
<div class="section" id="kafka-api-180514010__section51971645131316"><h4 class="sectiontitle">Function</h4><p id="kafka-api-180514010__p7202629141518">This API is used to query the start and end time of the maintenance window.</p>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514010__en-us_topic_0128036903_section747445721120"><h4 class="sectiontitle">URI</h4><p id="kafka-api-180514010__en-us_topic_0128036903_p1857635701119">GET /v1.0/instances/maintain-windows</p>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514010__en-us_topic_0128036903_section1547413577114"><h4 class="sectiontitle">Request</h4><p id="kafka-api-180514010__en-us_topic_0128036903_p25761157181116"><strong id="kafka-api-180514010__en-us_topic_0128036903_b664125209">Request parameters</strong></p>
|
|
<p id="kafka-api-180514010__en-us_topic_0128036903_p7576957181117">None.</p>
|
|
<p id="kafka-api-180514010__en-us_topic_0128036903_p4576195720116"><strong id="kafka-api-180514010__b553010513219">Example request</strong></p>
|
|
<pre class="screen" id="kafka-api-180514010__screen5417230154817">GET https://{dms_endpoint}/v1.0/instances/maintain-windows</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514010__en-us_topic_0128036903_section15475195711113"><h4 class="sectiontitle">Response</h4><p id="kafka-api-180514010__en-us_topic_0128036903_p1857720572119"><strong id="kafka-api-180514010__en-us_topic_0128036903_b109513742012">Response parameters</strong></p>
|
|
<p id="kafka-api-180514010__en-us_topic_0128036903_p1457775771115"><a href="#kafka-api-180514010__en-us_topic_0128036903_table04768576115">Table 1</a> and <a href="#kafka-api-180514010__en-us_topic_0128036903_table748235716115">Table 2</a> describe the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514010__en-us_topic_0128036903_table04768576115"></a><a name="en-us_topic_0128036903_table04768576115"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514010__en-us_topic_0128036903_table04768576115" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="kafka-api-180514010__en-us_topic_0128036903_row14577185716113"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.5.4.2.4.1.1"><p id="kafka-api-180514010__en-us_topic_0128036903_p8577135719113">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.2"><p id="kafka-api-180514010__en-us_topic_0128036903_p857745731115">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.5.4.2.4.1.3"><p id="kafka-api-180514010__en-us_topic_0128036903_p1957785713116">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514010__en-us_topic_0128036903_row157725711111"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514010__en-us_topic_0128036903_p16577125741112">maintain_windows</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514010__en-us_topic_0128036903_p175771857111112">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514010__en-us_topic_0128036903_p7577155714112">Indicates a list of supported maintenance time windows.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514010__en-us_topic_0128036903_table748235716115"></a><a name="en-us_topic_0128036903_table748235716115"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514010__en-us_topic_0128036903_table748235716115" frame="border" border="1" rules="all"><caption><b>Table 2 </b>maintain_windows parameter description</caption><thead align="left"><tr id="kafka-api-180514010__en-us_topic_0128036903_row1857745761111"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.5.2.4.1.1"><p id="kafka-api-180514010__en-us_topic_0128036903_p35779572111">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.5.5.2.4.1.2"><p id="kafka-api-180514010__en-us_topic_0128036903_p165779572119">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.5.5.2.4.1.3"><p id="kafka-api-180514010__en-us_topic_0128036903_p0577185711113">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514010__en-us_topic_0128036903_row0577175719114"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514010__en-us_topic_0128036903_p157817574116">seq</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514010__en-us_topic_0128036903_p557895791115">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514010__en-us_topic_0128036903_p857885771118">Indicates the sequential number of a maintenance time window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514010__en-us_topic_0128036903_row9578165718115"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514010__en-us_topic_0128036903_p13578125711113">begin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514010__en-us_topic_0128036903_p115789578119">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514010__en-us_topic_0128036903_p957825714112">Indicates the time at which a maintenance time window starts.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514010__en-us_topic_0128036903_row157819575116"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514010__en-us_topic_0128036903_p16578165771110">end</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514010__en-us_topic_0128036903_p6578185751118">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514010__en-us_topic_0128036903_p1757811578116">Indicates the time at which a maintenance time window ends.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514010__en-us_topic_0128036903_row205787575119"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514010__en-us_topic_0128036903_p1578175715114">default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514010__en-us_topic_0128036903_p135781757101115">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514010__en-us_topic_0128036903_p1557865712114">Indicates whether a maintenance time window is set to the default time segment.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="kafka-api-180514010__en-us_topic_0128036903_p145781257171114"></p>
|
|
<p id="kafka-api-180514010__en-us_topic_0128036903_p1557812577114"><strong id="kafka-api-180514010__en-us_topic_0128036903_b18589122042112">Example response</strong></p>
|
|
<pre class="screen" id="kafka-api-180514010__screen12252727161414">{
|
|
"maintain_windows": [{
|
|
"default": false,
|
|
"seq": 1,
|
|
"begin": "22:00:00",
|
|
"end": "02:00:00"
|
|
},
|
|
{
|
|
"default": true,
|
|
"seq": 2,
|
|
"begin": "02:00:00",
|
|
"end": "06:00:00"
|
|
},
|
|
{
|
|
"default": false,
|
|
"seq": 3,
|
|
"begin": "06:00:00",
|
|
"end": "10:00:00"
|
|
},
|
|
{
|
|
"default": false,
|
|
"seq": 4,
|
|
"begin": "10:00:00",
|
|
"end": "14:00:00"
|
|
},
|
|
{
|
|
"default": false,
|
|
"seq": 5,
|
|
"begin": "14:00:00",
|
|
"end": "18:00:00"
|
|
},
|
|
{
|
|
"default": false,
|
|
"seq": 6,
|
|
"begin": "18:00:00",
|
|
"end": "22:00:00"
|
|
}]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514010__en-us_topic_0128036903_section10504657101112"><h4 class="sectiontitle">Status Code</h4><p id="kafka-api-180514010__en-us_topic_0128036903_p175791957191116"><a href="#kafka-api-180514010__en-us_topic_0128036903_table155041657181114">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-180514010__en-us_topic_0128036903_table155041657181114"></a><a name="en-us_topic_0128036903_table155041657181114"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514010__en-us_topic_0128036903_table155041657181114" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="kafka-api-180514010__en-us_topic_0128036903_row1157985731113"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.6.3.2.3.1.1"><p id="kafka-api-180514010__en-us_topic_0128036903_p195791357141117">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-180514010__en-us_topic_0128036903_p205791357161114">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514010__en-us_topic_0128036903_row8579195751118"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180514010__en-us_topic_0128036903_p8579105713119">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180514010__en-us_topic_0128036903_p6579175761116">The maintenance time windows are queried successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="kafka-api-190605002.html">Other APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|