/en/connecting-to/management-api/rest-apis-agent/hosts/ Recent content in Hosts on OpenText Analytics Database 26.2.x Hugo -- gohugo.io /en/connecting-to/management-api/rest-apis-agent/hosts/get-hosts/ Mon, 01 Jan 0001 00:00:00 +0000 /en/connecting-to/management-api/rest-apis-agent/hosts/get-hosts/ <p>Returns a list of the hosts in the cluster and the hardware, software, and network details about each host.</p> <h2 id="resource-url">Resource URL</h2> <pre tabindex="0"><code>https://&lt;NODE&gt;:5444/hosts </code></pre><h2 id="authentication">Authentication</h2> <p>Requires a <a href="../../../../../en/connecting-to/management-api/rest-apis-agent/verticaapikey/#">VerticaAPIKey</a> in the request header.</p> <p>The API key must have <strong>restricted</strong> level security or higher.</p> <h2 id="parameters">Parameters</h2> <p>None.</p> <h2 id="example-request">Example request</h2> <table class="table table-bordered" > <tr> <td > <strong>GET</strong></td> <td > <code>https://&lt;NODE&gt;:5444/hosts</code></td></tr></table> <p><strong>Response:</strong></p> <pre tabindex="0"><code>{ &#34;body&#34;: [ { &#34;cpu_info&#34;: { &#34;cpu_type&#34;: &#34; Intel(R) Xeon(R) CPU E5-2695 v2 @ 2.40GHz&#34;, &#34;number_of_cpus&#34;: 2 }, &#34;host_id&#34;: &#34;10.20.100.247&#34;, &#34;hostname&#34;: &#34;v_vmart_node0001.example.com&#34;, &#34;max_user_proc&#34;: &#34;3833&#34;, &#34;nics&#34;: [ { &#34;broadcast&#34;: &#34;10.20.100.255&#34;, &#34;ipaddr&#34;: &#34;10.20.100.247&#34;, &#34;name&#34;: &#34;eth0&#34;, &#34;netmask&#34;: &#34;255.255.255.0&#34;, &#34;speed&#34;: &#34;unknown&#34; }, { &#34;broadcast&#34;: &#34;255.255.255.255&#34;, &#34;ipaddr&#34;: &#34;127.0.0.1&#34;, &#34;name&#34;: &#34;lo&#34;, &#34;netmask&#34;: &#34;255.0.0.0&#34;, &#34;speed&#34;: &#34;locallink&#34; } ], &#34;total_memory&#34;: 3833, &#34;vertica&#34;: { &#34;arch&#34;: &#34;x86_64&#34;, &#34;brand&#34;: &#34;vertica&#34;, &#34;release&#34;: &#34;20140716&#34;, &#34;version&#34;: &#34;26.2.x0&#34; } }, { &#34;cpu_info&#34;: { &#34;cpu_type&#34;: &#34; Intel(R) Xeon(R) CPU E5-2695 v2 @ 2.40GHz&#34;, &#34;number_of_cpus&#34;: 2 }, &#34;host_id&#34;: &#34;10.20.100.248&#34;, &#34;hostname&#34;: &#34;v_vmart_node0002.example.com&#34;, &#34;max_user_proc&#34;: &#34;3833&#34;, &#34;nics&#34;: [ { &#34;broadcast&#34;: &#34;10.20.100.255&#34;, &#34;ipaddr&#34;: &#34;10.20.100.248&#34;, &#34;name&#34;: &#34;eth0&#34;, &#34;netmask&#34;: &#34;255.255.255.0&#34;, &#34;speed&#34;: &#34;unknown&#34; }, { &#34;broadcast&#34;: &#34;255.255.255.255&#34;, &#34;ipaddr&#34;: &#34;127.0.0.1&#34;, &#34;name&#34;: &#34;lo&#34;, &#34;netmask&#34;: &#34;255.0.0.0&#34;, &#34;speed&#34;: &#34;locallink&#34; } ], &#34;total_memory&#34;: 3833, &#34;vertica&#34;: { &#34;arch&#34;: &#34;x86_64&#34;, &#34;brand&#34;: &#34;vertica&#34;, &#34;release&#34;: &#34;20140716&#34;, &#34;version&#34;: &#34;26.2.x0&#34; } }, { &#34;cpu_info&#34;: { &#34;cpu_type&#34;: &#34; Intel(R) Xeon(R) CPU E5-2695 v2 @ 2.40GHz&#34;, &#34;number_of_cpus&#34;: 2 }, &#34;host_id&#34;: &#34;10.20.100.249&#34;, &#34;hostname&#34;: &#34;v_vmart_node0003.example.com&#34;, &#34;max_user_proc&#34;: &#34;3833&#34;, &#34;nics&#34;: [ { &#34;broadcast&#34;: &#34;10.20.100.255&#34;, &#34;ipaddr&#34;: &#34;10.20.100.249&#34;, &#34;name&#34;: &#34;eth0&#34;, &#34;netmask&#34;: &#34;255.255.255.0&#34;, &#34;speed&#34;: &#34;unknown&#34; }, { &#34;broadcast&#34;: &#34;255.255.255.255&#34;, &#34;ipaddr&#34;: &#34;127.0.0.1&#34;, &#34;name&#34;: &#34;lo&#34;, &#34;netmask&#34;: &#34;255.0.0.0&#34;, &#34;speed&#34;: &#34;locallink&#34; } ], &#34;total_memory&#34;: 3833, &#34;vertica&#34;: { &#34;arch&#34;: &#34;x86_64&#34;, &#34;brand&#34;: &#34;vertica&#34;, &#34;release&#34;: &#34;20140716&#34;, &#34;version&#34;: &#34;26.2.x0&#34; } } ], &#34;href&#34;: &#34;/hosts&#34;, &#34;links&#34;: [ &#34;/:hostid&#34; ], &#34;mime-type&#34;: &#34;application/vertica.hosts.json-v2&#34; } </code></pre> /en/connecting-to/management-api/rest-apis-agent/hosts/get-hostshostid/ Mon, 01 Jan 0001 00:00:00 +0000 /en/connecting-to/management-api/rest-apis-agent/hosts/get-hostshostid/ <p>Returns hardware, software, and network details about the host identified by <code>:host_id</code>. You can find <code>:host_id</code> for each host using <a href="../../../../../en/connecting-to/management-api/rest-apis-agent/hosts/get-hosts/#">GET hosts</a>.</p> <h2 id="resource-url">Resource URL</h2> <pre tabindex="0"><code>https://&lt;NODE&gt;:5444/hosts/:hostid </code></pre><h2 id="authentication">Authentication</h2> <p>Requires a <a href="../../../../../en/connecting-to/management-api/rest-apis-agent/verticaapikey/#">VerticaAPIKey</a> in the request header.</p> <p>The API key must have <strong>restricted</strong> level security or higher.</p> <h2 id="parameters">Parameters</h2> <p>None.</p> <h2 id="example-request">Example request</h2> <table class="table table-bordered" > <tr> <td > <strong>GET</strong></td> <td > <code>https://&lt;NODE&gt;:5444/hosts/:10.20.100.247</code></td></tr></table> <p><strong>Response:</strong></p> <pre tabindex="0"><code>{ &#34;body&#34;: { &#34;cpu_info&#34;: { &#34;cpu_type&#34;: &#34; Intel(R) Xeon(R) CPU E5-2695 v2 @ 2.40GHz&#34;, &#34;number_of_cpus&#34;: 2 }, &#34;hostname&#34;: &#34;v_vmart_node0001.example.com&#34;, &#34;max_user_proc&#34;: &#34;3833&#34;, &#34;nics&#34;: [ { &#34;broadcast&#34;: &#34;10.20.100.255&#34;, &#34;ipaddr&#34;: &#34;10.20.100.247&#34;, &#34;name&#34;: &#34;eth0&#34;, &#34;netmask&#34;: &#34;255.255.255.0&#34;, &#34;speed&#34;: &#34;unknown&#34; }, { &#34;broadcast&#34;: &#34;255.255.255.255&#34;, &#34;ipaddr&#34;: &#34;127.0.0.1&#34;, &#34;name&#34;: &#34;lo&#34;, &#34;netmask&#34;: &#34;255.0.0.0&#34;, &#34;speed&#34;: &#34;locallink&#34; } ], &#34;total_memory&#34;: 3833, &#34;vertica&#34;: { &#34;arch&#34;: &#34;x86_64&#34;, &#34;brand&#34;: &#34;vertica&#34;, &#34;release&#34;: &#34;20140716&#34;, &#34;version&#34;: &#34;26.2.x0&#34; } }, &#34;href&#34;: &#34;/hosts/10.20.100.247&#34;, &#34;links&#34;: [], &#34;mime-type&#34;: &#34;application/vertica.host.json-v2&#34; } </code></pre>