Get all cloud host templates

Available in versions: 2022 R1 and later

Description

Retrieves a list of all existing cloud host templates in the project.

URL

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

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:

None

Request example:

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

Response

Headers:

One of:

  • Accept: application/xml

  • Accept: application/json

Cookies:

None

HTML return code:

One of the HTTP return codes

HTML body:

The XML or JSON containing the cloud host templates.

Response examples:

Copy code
XML example:
<CloudTemplates xmlns="http://www.hp.com/PC/REST/API">
    <CloudTemplate>
        <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>
        <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>
    <CloudTemplate>
        <Id>2</Id>
        <AccountId>3</AccountId>
        <AccountName>azure</AccountName>
        <Name>azure_nonelastic</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>
        <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>false</UseElasticIp>
        <UsePrivateIp>false</UsePrivateIp>
    </CloudTemplate>
</CloudTemplates>
Copy code
JSON example:
[
    {
        "Id": 1,
        "AccountId": 2,
        "AccountName": "AWS",
        "Name": "[test1]",
        "Image": "ami-013bc9e865c15e007",
        "InstanceType": "c1.medium",
        "KeyPairName": "az_kp7",
        "SecurityGroupName": "ansible-sec-gr (sg-358e2f40)",
        "Description": "",
        "Installation": "Windows Standalone LG",
        "VpcSubnetId": null,
        "Platform": "Windows",
        "IsValid": true,
        "NetworkName": null,
        "Region": "US East (N. Virginia)",
        "UseElasticIp": false,
        "UsePrivateIp": false
    },
    {
        "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": null,
        "Region": "US East (N. Virginia)",
        "UseElasticIp": false,
        "UsePrivateIp": false
    }
]

See also: