Get all cloud hosts
Available in versions: 12.56-12.63 only
Description
Returns a list of all hosts provisioned on the cloud.
URL
/Admin/rest/v1/cloud/hosts
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 of provisioned 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 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 the provisioned hosts.
<LabHosts>
<LabHosts>
<Name>52.213.15.142</Name>
<Installation>WindowsStandaloneLG</Installation>
<HostPurposes>
<HostPurpose>LoadGenerator</HostPurpose>
<HostPurposes>
<Status>Unavailable</Status>
<Location>Amazon EC2 EU (Ireland)</Location>
<MIListener>None</MIListener>
<Attributes>
<Attribute>Host memory:High</Attribute>
<Attribute>Host strength:High</Attribute>
</Attributes>
<Priority>5</Priority>
<SslEnabled>false</SslEnabled>
<Description/>
<Pools>
<PoolID>1000</PoolID>
</Pools>
<IsPrivateHost>false</IsPrivateHost>
<ID>1057</ID>
<CloudAccount>1023</CloudAccount>
<CloudAccountName>SW</CloudAccountName>
<CloudImage>LR-PC_Load_Generator_12.55_Win2012R2</CloudImage>
<CloudInstanceType>IT 6</CloudInstanceType>
<CloudRegion>eu-west-1</CloudRegion>
<CloudRequestId>1070</CloudRequestId>
<CloudTemplate>Amazon EC2_EU Ireland_Windows_Load Generator 12.55_Large</CloudTemplate>
</LabHost>
</LabHosts>
See Also
Provision cloud hosts
Get provision request
Get all provision requests
Deprovision cloud hosts
Audit cloud hosts
Get Cloud Account