Audit cloud hosts

Available in versions: 12.56-12.63 only

Description

Returns a list showing the status of all provisioned and deprovisioned cloud hosts.

URL

/Admin/rest/v1/cloud/hosts/audithosts

Remarks

The host data can be passed as XML containing the equivalent data.

Only Amazon EC2 is supported for provisioning cloud hosts using the REST API.

This API should be authorized for the Application, Tenant, and Site Admin permission levels.

HTTP method

GET: Returns a list showing the status of all provisioned and deprovisioned hosts.

Request

Headers:

Accept: application/xml

Cookies:

Version	Cookie
2023, 24.1, and later	ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};
2022 - 2022 R2	ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE}; ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE}; LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};
2021 - 2021 R2	ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE}; ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};
2020 - 2020 SP3	ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};
Earlier than 2020	LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE}; QCSession={QC_SESSION_COOKIE_VALUE};

Request body:

GET: No request body.

Request example:

Copy code

GET http://<LRE_Server>/Admin/rest/v1/cloud/hosts/audithosts HTTP/1.1
Host: PCServer
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

Response

Headers:

Content-Type: application/xml or application/json

Cookies:

None

HTML return code:

One of the HTTP return codes

Upon successful deletion, returns HTTP status 201 (Created).

HTML body:

GET: Returns the data on all provisioned and deprovisioned hosts.

This table lists the fields in the response:

Element	Description
ID	The ID for the cloud audit.
AccountID	The ID of the cloud account from which the host was provisioned.
CloudHostIdentifier	A unique ID for the host assigned by the cloud provider.
Credit	The number of cloud credits consumed by the provisioned host.
HostID	The ID of the host.
Image	The machine image applied to the cloud host.
InstanceTypeDisplayName	The instance type of the cloud host.
Logical Name	The hostname of the host.
Installation	The installation type of the host: WindowsHost, WindowsStandaloneLG, Unix.
LocationName	The location of the host. For example, locations can be defined according to physical areas.
RequestItemID	The cloud provider's ID for a batch of hosts within a provision request. All hosts in a batch have identical specs and configurations.
HostName	The name of the host.
TerminateOperationID	The ID for the terminate request.
ProvisionOperationID	The ID for the provision request.
StartProvisionTime	The UTC date and time that the provisioning started.
EndProvisionTime	The UTC date and time that the provisioning ended.
ProvisionDuration	The amount of time the host was provisioned.
ProvisionStatus	One of: Active Pending Pending provider status checks Pending status checks Failed
HostPurpose	The testing tools available on the host: LoadGenerator.
RequestID	The cloud provider's ID for a single provision request. A provision request includes all requested batches of hosts. Each batch has its own Cloud Request Item ID.
TemplateName	The name of the template used to provision the host.
AccountName	The name of the cloud account from which the host was provisioned.
TerminateStatus	One of: Terminated Pending
StartTerminateTime	The date and time that the deprovisioning started.
TotalIdleTime	The total cloud host idle (inactivity) time.
TotalUpTime	The total cloud host uptime.

Response example: