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.
HTTP Method
GET: Returns a list showing the status of all provisioned and deprovisioned hosts.
Request
Headers:
Accept: application/xml
Cookies:
Versions 2023 and later | ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE}; |
Versions 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}; |
Versions 2021 - 2021 R2 | ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE}; ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE}; |
Versions 2020 - 2020 SP3 | ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE}; |
Versions earlier than 2020 | LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE}; QCSession={QC_SESSION_COOKIE_VALUE}; |
Request Body:
GET: No request body.
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:
|
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:
|
StartTerminateTime | The date and time that the deprovisioning started. |
TotalIdleTime | The total cloud host idle (inactivity) time. |
TotalUpTime | The total cloud host uptime. |
<CloudAuditHosts>
<CloudAuditHost>
<ID>1048</ID>
<AccountID>1001</AccountID>
<CloudHostIdentifier>i-0a351caf86de381fa</CloudHostIdentifier>
<Credit>1</Credit>
<HostID>1055</HostID>
<Image>LR-LRE_Load_Generator_2023_Win2019</Image>
<InstanceTypeDisplayName>B1 Medium</InstanceTypeDisplayName>
<LogicalName>59.254.48.173</LogicalName>
<Installation>WindowsStandaloneLG</Installation>
<LocationName>Amazon EC2 EU (Ireland)</LocationName>
<RequestItemId>1065</RequestItemId>
<HostName>59.254.48.173</HostName>
<TerminateOperationID>1068</TerminateOperationID>
<ProvisionOperationID>1065</ProvisionOperationID>
<StartProvisionTime>2017-07-30T14:18:23+00</StartProvisionTime>
<EndProvisionTime>2017-07-30T14:26:20+00</EndProvisionTime>
<ProvisionDuration>7.95</ProvisionDuration>
<ProvisionStatus>Active</ProvisionStatus>
<HostPurpose>LoadGenerator</HostPurpose>
<RequestId>1064</RequestId>
<TemplateName>ireland_dave</TemplateName>
<TerminateStatus>Terminated</TerminateStatus>
<StartTerminateTime>2017-07-30T15:41:57</StartTerminateTime>
<TotalIdleTime>83</TotalIdleTime>
<TotalUpTime>83</TotalUpTime>
</CloudAuditHost>
<CloudAuditHost>
<ID>1049</ID>
<AccountID>1001</AccountID>
<CloudHostIdentifier>i-017399e06d3905cc9</CloudHostIdentifier>
<Credit>1</Credit>
<HostID>1056</HostID>
<Image>LR-LRE_Load_Generator_2023_Win2019</Image>
<InstanceTypeDisplayName>B1 Medium</InstanceTypeDisplayName>
<LogicalName>54.77.45.173</LogicalName>
<Installation>WindowsStandaloneLG</Installation>
<LocationName>Amazon EC2 EU (Ireland)</LocationName>
<RequestItemId>1069</RequestItemId>
<HostName>54.77.45.173</HostName>
<TerminateOperationID>1070</TerminateOperationID>
<ProvisionOperationID>1069</ProvisionOperationID>
<StartProvisionTime>2017-07-31T10:35:42</StartProvisionTime>
<EndProvisionTime>2017-07-31T10:43:41</EndProvisionTime>
<ProvisionDuration>7.98</ProvisionDuration>
<ProvisionStatus>Active</ProvisionStatus>
<HostPurpose>LoadGenerator</HostPurpose>
<RequestId>1068</RequestId>
<TemplateName>ireland_dave</TemplateName>
<TerminateStatus>Terminated</TerminateStatus>
<StartTerminateTime>2017-07-31T11:05:23</StartTerminateTime>
<TotalIdleTime>29</TotalIdleTime>
<TotalUpTime>29</TotalUpTime>
</CloudAuditHost>
</CloudAuditHosts>
See Also
Provision cloud hosts
Deprovision cloud hosts
Get provision request
Provision host response
Get all provision requests
Get all cloud hosts