This is an automated email from the ASF dual-hosted git repository.
weizhouapache pushed a commit to branch 4.22
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
The following commit(s) were added to refs/heads/4.22 by this push:
new 67cf2598 List hosts API details (#674)
67cf2598 is described below
commit 67cf259894226a39df6e997f7b885f80ab627ffe
Author: Nicolas Vazquez <[email protected]>
AuthorDate: Tue Sep 1 09:15:52 2026 -0300
List hosts API details (#674)
---
source/adminguide/hosts.rst | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/source/adminguide/hosts.rst b/source/adminguide/hosts.rst
index 87d5d945..bd7a7c87 100644
--- a/source/adminguide/hosts.rst
+++ b/source/adminguide/hosts.rst
@@ -20,6 +20,22 @@ Adding Hosts
Additional hosts can be added at any time to provide more capacity for
guest Instances. For requirements and instructions, see :ref:`adding-a-host`.
+Listing Host Attributes
+------------------------
+The `listHosts` API accepts a comma-separated list of requested items in its
`details` parameter. Accepted values are `min`, `all`, `capacity`, `events`,
`stats`, and `core`.
+
+- `listHosts details=capacity` includes each host's total and allocated CPU
and memory, as well as host tag information, in the API response.
+- `listHosts details=stats` includes each host's used CPU and memory
information in the API response.
+- `listHosts details=events` includes events related to each host in the API
response.
+- `listHosts details=all` returns all available host information in the API
response.
+- `listHosts details=min` excludes capacity, stats, and events information.
+- `listHosts details=core` returns only the core set of host information that
CloudStack can retrieve without performing additional database queries.
+
+The `core` detail was introduced to improve `listHosts` API performance:
because the information returned for each host is lightweight, it reduces the
number of database lookups required when listing hosts.
+
+.. note::
+ When `details=core` is used, the response includes the host's owning
management server ms_id (from the `ms_host` table) in the `msid` field. When
any of `capacity`, `stats`, `events`, `min`, or `all` is used instead, `msid`
is not populated; the `managementserverid` and `managementservername` fields
are returned instead.
+
Scheduled Maintenance and Maintenance Mode for Hosts
----------------------------------------------------
