Get a Cloud Gateway Pool

In this article

    You can get a representation of a cloud gateway pool with the specified ID.

    Request

    To get a representation of a cloud gateway pool in Veeam Service Provider Console, send the GET HTTPS request to the URL of its resource.

    HTTP Request

    GET https://<hostname>:1281/v2/cloudGatewayPools/{instanceUid}

    Request Headers

    The request header must contain the authorization token for the current logon session.

    Response

    The server returns the following response to the client.

    Response Code

    A successfully completed operation returns response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTP headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the request body message: application/json; charset=utf-8

    Response Body

    In the response body, Veeam Service Provider Console returns a representation of the /cloudGatewayPools/{instanceUid} resource.

    Example Get a Cloud Gateway Pool

    The following example returns a representation of a cloud gateway pool with ID a8d8032d-534d-4945-844d-cafe51869747.

    Request:

    GET https://localhost:1281/v2/cloudGatewayPools/a8d8032d-534d-4945-844d-cafe51869747

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response Code:

    200 Success

     

    Response Body:

    {

     "instanceUid": "a8d8032d-534d-4945-844d-cafe51869747",

     "name": "Alpha Pool",

     "numberOfGateways": 7,

     "cloudAgentUid": "6e8b485b-c729-4c26-94d6-bc843b4f645e",

     "_links": [

       {

         "rel": "self",

         "method": "GET",

         "href": "https://vac:1281/v2/cloudGatewayPools/a8d8032d-534d-4945-844d-cafe51869747"

       }

     ]

    }