forked from docs/doc-exports
Chen, Junjie
5e34f6ce26
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>
140 lines
8.0 KiB
HTML
140 lines
8.0 KiB
HTML
<a name="dcs-api-0312041"></a><a name="dcs-api-0312041"></a>
|
|
|
|
<h1 class="topictitle1">Querying Maintenance Time Window</h1>
|
|
<div id="body1500977331238"><div class="section" id="dcs-api-0312041__section51971645131316"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312041__p7202629141518">The API is used to query the start time and end time of the maintenance time window.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312041__section64622449235"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312041__p152611543234">GET /v1.0/instances/maintain-windows</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312041__section240851911242"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312041__p19977113213118"><strong id="dcs-api-0312041__b1478312171918">Request parameters</strong></p>
|
|
<p id="dcs-api-0312041__p2977132153115">None</p>
|
|
<p id="dcs-api-0312041__p1497703210316"><strong id="dcs-api-0312041__b1158110418195">Example request</strong></p>
|
|
<p id="dcs-api-0312041__p097723273112">None</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312041__section17914193911241"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312041__p518895813455"><strong id="dcs-api-0312041__b147314719197">Response parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312041__p113341445183919"><a href="#dcs-api-0312041__table615617458391">Table 1</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312041__table615617458391"></a><a name="table615617458391"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312041__table615617458391" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312041__row1215694553917"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312041__p1115617457395">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.4.3.2.2.4.1.2"><p id="dcs-api-0312041__p11561345123918">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.4.3.2.2.4.1.3"><p id="dcs-api-0312041__p6156194512396">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312041__row415615459392"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312041__p471315247">maintain_windows</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312041__p172015145">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312041__p171115441">List of supported maintenance time windows.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312041__table910362216139" frame="border" border="1" rules="all"><caption><b>Table 2 </b>maintain_windows parameter description</caption><thead align="left"><tr id="dcs-api-0312041__row16103322121317"><th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312041__p10104022111310">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312041__p161041122171313">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312041__p4104722171313">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312041__row151043224130"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312041__p1259242341">seq</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312041__p159042743">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312041__p659194219418">Sequence number of the maintenance time window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312041__row81044225134"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312041__p8599427416">begin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312041__p165974212414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312041__p15917421341">Start time of the maintenance time window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312041__row81049226139"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312041__p45917421844">end</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312041__p659042541">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312041__p175919421044">End time of the maintenance time window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312041__row7105132241314"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312041__p959842643">default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312041__p85984210414">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312041__p65910421645">An indicator of whether the maintenance time window is set to the default time segment.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="p" id="dcs-api-0312041__p9126512164618"><strong id="dcs-api-0312041__b1970665901915">Example response</strong><pre class="screen" id="dcs-api-0312041__screen117211519164620">{
|
|
"maintain_windows": [
|
|
{
|
|
"seq": 1,
|
|
"begin": "22",
|
|
"end": "02",
|
|
"default": false
|
|
},
|
|
{
|
|
"seq": 2,
|
|
"begin": "02",
|
|
"end": "06",
|
|
"default": true
|
|
},
|
|
{
|
|
"seq": 3,
|
|
"begin": "06",
|
|
"end": "10",
|
|
"default": false
|
|
},
|
|
{
|
|
"seq": 4,
|
|
"begin": "10",
|
|
"end": "14",
|
|
"default": false
|
|
},
|
|
{
|
|
"seq": 5,
|
|
"begin": "14",
|
|
"end": "18",
|
|
"default": false
|
|
},
|
|
{
|
|
"seq": 6,
|
|
"begin": "18",
|
|
"end": "22",
|
|
"default": false
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312041__section15118192111410"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312041__p1011872101415"><a href="#dcs-api-0312041__table611872191420">Table 3</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312041__table611872191420"></a><a name="table611872191420"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312041__table611872191420" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312041__row1411932101418"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312041__p81194271410">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312041__p91199217144">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312041__row1011932151411"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312041__p21194210147">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312041__p10119626142">Successfully queried the maintenance time window.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312038.html">Other APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|