forked from docs/doc-exports
Chen, Junjie
a03981f7be
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
266 lines
9.3 KiB
HTML
266 lines
9.3 KiB
HTML
<a name="ListMaintenanceWindows"></a><a name="ListMaintenanceWindows"></a>
|
|
|
|
<h1 class="topictitle1">Listing Maintenance Time Windows</h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the start time and end time of maintenance windows.</p>
|
|
</div>
|
|
<div class="section" id="ListMaintenanceWindows__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/instances/maintain-windows</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Request Parameters</h4><p>None</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListMaintenanceWindows__response_MaintainWindowsResp" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>maintain_windows</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ListMaintenanceWindows__response_MaintainWindowsEntity">MaintainWindowsEntity</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>List of supported maintenance time windows.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListMaintenanceWindows__response_MaintainWindowsEntity"></a><a name="response_MaintainWindowsEntity"></a><table cellpadding="4" cellspacing="0" summary="" id="ListMaintenanceWindows__response_MaintainWindowsEntity" frame="border" border="1" rules="all"><caption><b>Table 2 </b>MaintainWindowsEntity</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>seq</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Sequence number of the maintenance time window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Whether a maintenance time window is set to the default time segment.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>begin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>UTC time when the maintenance time window starts. The format is HH:mm:ss.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>end</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>UTC time when the maintenance time window ends. The format is HH:mm:ss.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p><strong>Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListMaintenanceWindows__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p>error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p>Error message.</p>
|
|
<p>Maximum: <strong>1024</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p>error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p>Error code.</p>
|
|
<p>Maximum: <strong>9</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p>error_ext_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p>Extended error information. This parameter is not used currently and is set to <strong>null</strong>.</p>
|
|
<p>Maximum: <strong>1024</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">GET https://{dcs_endpoint}/v2/instances/maintain-windows</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
|
<p>Maintenance time windows queried successfully.</p>
|
|
<pre class="screen">{
|
|
"maintain_windows" : [ {
|
|
"default" : true,
|
|
"end" : "19",
|
|
"begin" : "18",
|
|
"seq" : 1
|
|
}, {
|
|
"default" : false,
|
|
"end" : "20",
|
|
"begin" : "19",
|
|
"seq" : 2
|
|
}, {
|
|
"default" : false,
|
|
"end" : "21",
|
|
"begin" : "20",
|
|
"seq" : 3
|
|
}, {
|
|
"default" : false,
|
|
"end" : "22",
|
|
"begin" : "21",
|
|
"seq" : 4
|
|
}, {
|
|
"default" : false,
|
|
"end" : "23",
|
|
"begin" : "22",
|
|
"seq" : 5
|
|
}, {
|
|
"default" : false,
|
|
"end" : "00",
|
|
"begin" : "23",
|
|
"seq" : 6
|
|
}, {
|
|
"default" : false,
|
|
"end" : "01",
|
|
"begin" : "00",
|
|
"seq" : 1
|
|
}, {
|
|
"default" : false,
|
|
"end" : "02",
|
|
"begin" : "01",
|
|
"seq" : 2
|
|
}, {
|
|
"default" : false,
|
|
"end" : "03",
|
|
"begin" : "02",
|
|
"seq" : 3
|
|
}, {
|
|
"default" : false,
|
|
"end" : "04",
|
|
"begin" : "03",
|
|
"seq" : 3
|
|
}, {
|
|
"default" : false,
|
|
"end" : "05",
|
|
"begin" : "04",
|
|
"seq" : 4
|
|
}, {
|
|
"default" : false,
|
|
"end" : "06",
|
|
"begin" : "05",
|
|
"seq" : 5
|
|
}, {
|
|
"default" : false,
|
|
"end" : "07",
|
|
"begin" : "06",
|
|
"seq" : 6
|
|
}, {
|
|
"default" : false,
|
|
"end" : "08",
|
|
"begin" : "07",
|
|
"seq" : 1
|
|
}, {
|
|
"default" : true,
|
|
"end" : "09",
|
|
"begin" : "08",
|
|
"seq" : 2
|
|
}, {
|
|
"default" : false,
|
|
"end" : "10",
|
|
"begin" : "09",
|
|
"seq" : 3
|
|
}, {
|
|
"default" : false,
|
|
"end" : "11",
|
|
"begin" : "10",
|
|
"seq" : 4
|
|
}, {
|
|
"default" : false,
|
|
"end" : "12",
|
|
"begin" : "11",
|
|
"seq" : 5
|
|
}, {
|
|
"default" : false,
|
|
"end" : "13",
|
|
"begin" : "12",
|
|
"seq" : 6
|
|
}, {
|
|
"default" : false,
|
|
"end" : "14",
|
|
"begin" : "13",
|
|
"seq" : 1
|
|
}, {
|
|
"default" : true,
|
|
"end" : "15",
|
|
"begin" : "14",
|
|
"seq" : 2
|
|
}, {
|
|
"default" : false,
|
|
"end" : "16",
|
|
"begin" : "15",
|
|
"seq" : 3
|
|
}, {
|
|
"default" : false,
|
|
"end" : "17",
|
|
"begin" : "16",
|
|
"seq" : 4
|
|
}, {
|
|
"default" : false,
|
|
"end" : "18",
|
|
"begin" : "17",
|
|
"seq" : 5
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListMaintenanceWindows__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Maintenance time windows queried successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="OtherInterface.html">Other APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|