forked from docs/doc-exports
Yang, Tong
d75e275491
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
228 lines
18 KiB
HTML
228 lines
18 KiB
HTML
<a name="ces_03_0035"></a><a name="ces_03_0035"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Host Configuration</h1>
|
|
<div id="body1507530586276"><div class="section" id="ces_03_0035__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0035__p1261763614316">This API is used to query the host configuration for a specified event type in a specified time range. You can specify the dimension of data to be queried.</p>
|
|
<div class="notice" id="ces_03_0035__note27213395143138"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="ces_03_0035__p7949112143144">This API is provided for SAP Monitor in the HANA scenario to query the host configuration. In other scenarios, the host configuration cannot be queried with this API.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="ces_03_0035__section5658454014325"><h4 class="sectiontitle">URI</h4><p id="ces_03_0035__p48490504">GET /V1.0/{project_id}/event-data</p>
|
|
<ul id="ces_03_0035__ul8883693"><li id="ces_03_0035__li33761356">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0035__table75058417558" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0035__row6325008217558"><th align="left" class="cellrowborder" valign="top" width="18.3%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="ces_03_0035__p2298303317558">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.36%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="ces_03_0035__p4968641317558">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.34%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="ces_03_0035__p6517651717558">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0035__row4480653817558"><td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0035__p545094717558">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="ces_03_0035__p3887356117558">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.34%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="ces_03_0035__p6175070717558">Specifies the project ID.</p>
|
|
<p id="ces_03_0035__p131101257568">For details about how to obtain the project ID, see <a href="ces_03_0057.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="ces_03_0035__li53602033342">Parameters that are used to query the host configuration
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0035__table35416756" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0035__row27598891"><th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.2.3.2.1.1.5.1.1"><p id="ces_03_0035__p20917673">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.1%" id="mcps1.3.2.3.2.1.1.5.1.2"><p id="ces_03_0035__p16609919">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.54%" id="mcps1.3.2.3.2.1.1.5.1.3"><p id="ces_03_0035__p29058925163547">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.75%" id="mcps1.3.2.3.2.1.1.5.1.4"><p id="ces_03_0035__p3226198">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0035__row59995477"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.1.1.5.1.1 "><p id="ces_03_0035__p3900147595641">namespace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.2.3.2.1.1.5.1.2 "><p id="ces_03_0035__p500289695641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.3.2.1.1.5.1.3 "><p id="ces_03_0035__p667393162913">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.75%" headers="mcps1.3.2.3.2.1.1.5.1.4 "><p id="ces_03_0035__p2687838193910">Specifies the namespace of a service. For details, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
|
|
<p id="ces_03_0035__p1529914911223">The namespace must be in the <strong id="ces_03_0035__b1127311121319">service.item</strong> format and contain 3 to 32 characters. <strong id="ces_03_0035__b1627421161313">service</strong> and <strong id="ces_03_0035__b4274121115131">item</strong> each must start with a letter and contain only letters, digits, and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row14620943"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.1.1.5.1.1 "><p id="ces_03_0035__p36641520143355">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.2.3.2.1.1.5.1.2 "><p id="ces_03_0035__p2566588195641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.3.2.1.1.5.1.3 "><p id="ces_03_0035__p66435433163547">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.75%" headers="mcps1.3.2.3.2.1.1.5.1.4 "><p id="ces_03_0035__p15720316165828">Specifies the event type.</p>
|
|
<p id="ces_03_0035__p7013114145729">It can contain only letters, underscores (_), and hyphens (-). It must start with a letter and cannot exceed 64 characters, for example, <strong id="ces_03_0035__b842352706165359">instance_host_info</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row55056607"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.1.1.5.1.1 "><p id="ces_03_0035__p2518324095641">from</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.2.3.2.1.1.5.1.2 "><p id="ces_03_0035__p2657653695641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.3.2.1.1.5.1.3 "><p id="ces_03_0035__p829483813299">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.75%" headers="mcps1.3.2.3.2.1.1.5.1.4 "><p id="ces_03_0035__p50729725153619">Specifies the start time of the query.</p>
|
|
<p id="ces_03_0035__p58158650145729">The time is a UNIX timestamp and the unit is ms.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row6114302"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.1.1.5.1.1 "><p id="ces_03_0035__p4423458695641">to</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.2.3.2.1.1.5.1.2 "><p id="ces_03_0035__p2623169995641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.3.2.1.1.5.1.3 "><p id="ces_03_0035__p141569412294">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.75%" headers="mcps1.3.2.3.2.1.1.5.1.4 "><p id="ces_03_0035__p37722762154851">Specifies the end time of the query.</p>
|
|
<p id="ces_03_0035__p12358701154859">The time is a UNIX timestamp and the unit is ms.</p>
|
|
<p id="ces_03_0035__p4386413145729"><strong id="ces_03_0035__b10781660165741">from</strong> must be earlier than <strong id="ces_03_0035__b29926084165741">to</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row6189824095632"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.1.1.5.1.1 "><p id="ces_03_0035__p6296468095641">dim</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.2.3.2.1.1.5.1.2 "><p id="ces_03_0035__p6697434595641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.3.2.1.1.5.1.3 "><p id="ces_03_0035__p59844053163547">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.75%" headers="mcps1.3.2.3.2.1.1.5.1.4 "><p id="ces_03_0035__p228921325315">Specifies the dimension. For example, the ECS dimension is <strong id="ces_03_0035__b72241914116">instance_id</strong>. For details about the dimensions corresponding to the monitoring metrics of each service, see the monitoring metrics description of the corresponding service in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
|
|
<p id="ces_03_0035__p3156446135916">Specifies the dimension. A maximum of three dimensions are supported, and the dimensions are numbered from 0 in <strong id="ces_03_0035__b11496656104410">dim.{i}=key,value</strong> format. <strong id="ces_03_0035__b155373012228">key</strong> cannot exceed 32 characters and <strong id="ces_03_0035__b13618115172216">value</strong> cannot exceed 256 characters.</p>
|
|
<p id="ces_03_0035__p5621290395641">Example: <strong id="ces_03_0035__b1344110556214">dim.0=instance_id,i-12345</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="ces_03_0035__ul10963124144253"><li id="ces_03_0035__li51921052">Example: Query the configuration information about the ECS whose <strong id="ces_03_0035__b181866411324">ID</strong> is <strong id="ces_03_0035__b1536613743217">33328f02-3814-422e-b688-bfdba93d4051</strong> and <strong id="ces_03_0035__b532471753311">type</strong> is <strong id="ces_03_0035__b1056616533328">instance_host_info</strong>.<pre class="screen" id="ces_03_0035__screen27442080195729">GET https://{Cloud Eye endpoint}/V1.0/{project_id}/event-data?namespace=SYS.ECS&dim.0=instance_id,33328f02-3814-422e-b688-bfdba93d4051&type=instance_host_info&from=1450234543422&to=1450320943422</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0035__section18441583143655"><h4 class="sectiontitle">Request</h4><p id="ces_03_0035__p1954202614374">None</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0035__section64339306143726"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0035__ul44101323143726"><li id="ces_03_0035__li61367595143726">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0035__table15437449143726" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0035__row46953322143726"><th align="left" class="cellrowborder" valign="top" width="15.14848515148485%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="ces_03_0035__p45122727143726">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.0988901109889%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="ces_03_0035__p33014498143726">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="73.75262473752625%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="ces_03_0035__p56928688143726">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0035__row47821055143726"><td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0035__p48300279143726">datapoints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0035__p10076671143726">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="73.75262473752625%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0035__p42007541165934">Specifies the configuration list.</p>
|
|
<p id="ces_03_0035__p32310501145729">If the corresponding configuration information does not exist, <strong id="ces_03_0035__b842352706165623">datapoints</strong> is an empty array and is <strong id="ces_03_0035__b842352706163912">[]</strong>.</p>
|
|
<p id="ces_03_0035__p240834211342">For details, see <a href="#ces_03_0035__table19905142618343">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0035__table19905142618343"></a><a name="table19905142618343"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0035__table19905142618343" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="ces_03_0035__b815313398279">datapoints</strong> data structure description</caption><thead align="left"><tr id="ces_03_0035__row19041926183419"><th align="left" class="cellrowborder" valign="top" width="15.14848515148485%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="ces_03_0035__p16904192643414">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.0988901109889%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="ces_03_0035__p2090442673410">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="73.75262473752625%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="ces_03_0035__p15904202633412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0035__row5905102618348"><td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0035__p990432693415">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0035__p3904102610348">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="73.75262473752625%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0035__p10905182613411">Specifies the event type, for example, <strong id="ces_03_0035__b842352706164014">instance_host_info</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row1490522663419"><td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0035__p1990562611342">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0035__p12905326113411">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="73.75262473752625%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0035__p49053264343">Specifies when the event is reported. It is a UNIX timestamp and the unit is ms.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row11905426153410"><td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0035__p1090517264343">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0035__p2905126193416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="73.75262473752625%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0035__p1090513263348">Specifies the host configuration information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="ces_03_0035__li14739456143726">Example response<pre class="screen" id="ces_03_0035__screen65546246143726">{
|
|
"datapoints": [
|
|
{
|
|
"type": "instance_host_info",
|
|
"timestamp": 1450231200000,
|
|
"value": "xxx"
|
|
},
|
|
{
|
|
"type": "instance_host_info",
|
|
"timestamp": 1450231800000,
|
|
"value": "xxx"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0035__section11416418161412"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0035__ul20226985"><li id="ces_03_0035__li47825138">Normal<p id="ces_03_0035__p27773061"><a name="ces_03_0035__li47825138"></a><a name="li47825138"></a>200</p>
|
|
</li><li id="ces_03_0035__li48630964">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0035__table10364173623214" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0035__row03645369329"><th align="left" class="cellrowborder" valign="top" width="32.1%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="ces_03_0035__p1849030182924">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67.9%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="ces_03_0035__p15553712182924">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0035__row236413368320"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0035__p581987519168">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0035__p164784039168">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row1736413365328"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0035__p2691669168">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0035__p218024949168">The authentication information is not provided or is incorrect.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row16364113663218"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0035__p563264059168">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0035__p661449719168">Access to the requested page is forbidden.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row9364103633216"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0035__p355199299168">408 Request Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0035__p585420329168">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row173648363321"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0035__p630127129168">429 Too Many Requests</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0035__p37560249168">Concurrent requests are excessive.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row1736483643220"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0035__p537873819168">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0035__p618106189168">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0035__row2036473613329"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0035__p298930079168">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0035__p54144829168">The service is currently unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0035__section134757259472"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0035__ces_03_0020_p91851023153416">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="ces_03_0032.html">Monitoring Data</a></div>
|
|
</div>
|
|
</div>
|
|
|