Get cloud host templates by ID

Available in versions: 2022 R1 and later

Description

Gets a cloud host template by the specified ID.

URL

Copy code
/LoadTest/rest/domains/{domainName}/projects/{projectName}/cloud/templates/{templateId}

HTTP method

GET: Returns the cloud host templates in the body of the response.

Request

Headers:

One of the following:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

Version Cookie
2020 or later

LWSSO_COOKIE_KEY={LwssoCookie};

Earlier than 2020

LWSSO_COOKIE_KEY={LwssoCookie};QCSession={QCSessionCookie};

Request body:

GET: No request body.

Request example:

Copy code
GET http://<LRE_Server>/LoadTest/rest/domains/MyDomain/projects/MyProject/cloud/templates/123

Response

Headers:

One of:

  • Accept: application/xml

  • Accept: application/json

Cookies:

None

HTML return code:

One of the HTTP return codes

Upon successful retrieval, returns HTTP status 200 (OK).

HTML body:

GET: Returns the data on the entity in the response.

Response examples:

Copy code
XML example:
<CloudTemplate xmlns="http://www.hp.com/PC/REST/API">
    <Id>1</Id>
    <AccountId>3</AccountId>
    <AccountName>azure</AccountName>
    <Name>azure_elastic</Name>
    <Image>/subscriptions/e9b63fd5-74d9-4094-a256-e104833f6b82/resourceGroups/DIMA_RESOURCEGROUP/providers/Microsoft.Compute/images/LR_LRE_Load_Generator_2022_Win2016</Image>
    <InstanceType>Standard_D2_v2</InstanceType>
    <KeyPairName />
    <SecurityGroupName>AllOpen (/subscriptions/e9b63fd5-74d9-4094-a256-e104833f6b82/resourceGroups/Dima_ResourceGroup/providers/Microsoft.Network/networkSecurityGroups/AllOpen)</SecurityGroupName>
    <Description />
    <Installation>Windows Standalone LG</Installation>
    <Platform>Windows</Platform>
    <IsValid>true</IsValid>
    <NetworkName>Dima_ResourceGroup-vnet</NetworkName>
    <Region>South Central US</Region>
    <UseElasticIp>true</UseElasticIp>
    <UsePrivateIp>false</UsePrivateIp>
</CloudTemplate>
Copy code
JSON example:
{
    "Id": 2,
    "AccountId": 2,
    "AccountName": "AWS",
    "Name": "[test2]",
    "Image": "ami-0cb5a5a9c0d3b609b",
    "InstanceType": "a1.metal",
    "KeyPairName": "az_kp7",
    "SecurityGroupName": "AWS-OpsWorks-Blank-Server (sg-32f55054)",
    "Description": "",
    "Installation": "Unix Load Generator",
    "VpcSubnetId": null,
    "Platform": "Linux",
    "IsValid": true,
    "NetworkName": "",
    "Region": "US East (N. Virginia)",
    "UseElasticIp": false,
    "UsePrivateIp": false
}

See also: