forked from docs/doc-exports
Li, Qiao
914011d51b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
117 lines
8.6 KiB
HTML
117 lines
8.6 KiB
HTML
<a name="waf_02_0097"></a><a name="waf_02_0097"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Instance Name and Status</h1>
|
|
<div id="body1558942309612"><div class="section" id="waf_02_0097__section17925194784510"><h4 class="sectiontitle">Function Description</h4><p id="waf_02_0097__p1584712496453">This API is used to query the name and status of the instance for interconnecting with Cloud Eye.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0097__section15676185813475"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0097__ul77116711482"><li id="waf_02_0097__li871277124818">URI format<p id="waf_02_0097__p471217124818"><a name="waf_02_0097__li871277124818"></a><a name="li871277124818"></a>GET /v1/{project_id}/waf/instance/{instance_id}/metrics</p>
|
|
</li></ul>
|
|
<ul id="waf_02_0097__ul2071211734819"><li id="waf_02_0097__li1071217714812">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0097__table1048819319483" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0097__row353643114813"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="waf_02_0097__p18536831104815"><strong id="waf_02_0097__b38451298118">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="waf_02_0097__p4536173114815"><strong id="waf_02_0097__b166518108112">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="waf_02_0097__p185364319489"><strong id="waf_02_0097__b12744911915">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="waf_02_0097__p8536103112487"><strong id="waf_02_0097__b145901171010">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0097__row1953633115481"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="waf_02_0097__p11536133110481">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="waf_02_0097__p2536183144817">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="waf_02_0097__p1953663124812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="waf_02_0097__p11537153117487">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0097__row1537331104812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="waf_02_0097__p1753783118487">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="waf_02_0097__p19537631154812">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="waf_02_0097__p10537103174812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="waf_02_0097__p115371531134814">Specifies the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0097__section138291117497"><h4 class="sectiontitle">Request</h4><p id="waf_02_0097__p137181018104911">Request parameters</p>
|
|
<p id="waf_02_0097__p149572424915">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0097__section1046935119499"><h4 class="sectiontitle">Response</h4><p id="waf_02_0097__p754316535495">Response parameters</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0097__table20232171385015" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0097__row12271181316508"><th align="left" class="cellrowborder" valign="top" width="33.690000000000005%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0097__p8271413105017"><strong id="waf_02_0097__b97174217112">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.99%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0097__p3271121313509"><strong id="waf_02_0097__b1090734212112">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.320000000000004%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0097__p1927181395011"><strong id="waf_02_0097__b37870431213">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0097__row1927111139504"><td class="cellrowborder" valign="top" width="33.690000000000005%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0097__p3271121365015">waf_instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.99%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0097__p427115134503">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.320000000000004%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0097__p4271013145018">Specifies the identifier of a metric dimension.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0097__row027110130503"><td class="cellrowborder" valign="top" width="33.690000000000005%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0097__p12711013205012">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.99%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0097__p427118130502">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.320000000000004%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0097__p527161318505">Specifies the name of a resource instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0097__row18680145212501"><td class="cellrowborder" valign="top" width="33.690000000000005%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0097__p6521165815011">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.99%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0097__p752135816500">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.320000000000004%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0097__p3521205818506">Specifies the status of a resource instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0097__section9288151211513"><h4 class="sectiontitle">Example</h4><p id="waf_02_0097__p1089617164"></p>
|
|
<p id="waf_02_0097__p4692812513">Response example</p>
|
|
<pre class="screen" id="waf_02_0097__screen16632815111">{
|
|
"waf_instance_id": "dhbvhdfbvdhbasdkjvfhwoow",
|
|
"name": "www.test.com",
|
|
"status": "enable"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="waf_02_0097__section124031118185219"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0097__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0097__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 3</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0097__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0097__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="waf_02_0097__waf_02_0012_r3d6e2f205c444705bdbb9daaac74e575"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.6.2.2.2.4.1.1"><p id="waf_02_0097__waf_02_0012_af3c4073076f24eca88d94e3fa1effdc6">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.41%" id="mcps1.3.6.2.2.2.4.1.2"><p id="waf_02_0097__waf_02_0012_en-us_topic_0144911667_p4531342288">Description</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.589999999999996%" id="mcps1.3.6.2.2.2.4.1.3"><p id="waf_02_0097__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0097__waf_02_0012_rc7b2adc390904a1ba79e303017797786"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="waf_02_0097__waf_02_0012_a93f3895d44bb4226934cc626ac50e37b">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.41%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="waf_02_0097__waf_02_0012_en-us_topic_0144911667_p7538425819">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="waf_02_0097__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0097__waf_02_0012_en-us_topic_0144911667_p482819399522">For details about error status codes, see <a href="waf_02_0085.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="waf_02_0096.html">Interconnecting with Cloud Eye</a></div>
|
|
</div>
|
|
</div>
|
|
|