GET /cloud/gatewayPools/{ID}
Returns a resource representation of a cloud gateway pool with the specified ID.
Request
To get a resource representation of the cloud gateway pool, send the GET HTTP request to the URL of the /cloud/gatewayPools/{ID} resource:
HTTP Request
GET https://<Enterprise-Manager>:9398/api/cloud/gatewayPools/{ID} |
or
GET https://<Enterprise-Manager>:9398/api/cloud/gatewayPools/{ID}?format=Entity |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
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. Possible values:
|
Response Body
In the response body, the REST API returns an entity or an entity reference of the /cloud/gatewayPools/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
|---|---|---|
UID | UidType | UID of the cloud gateway pool resource, for example: urn:veeam:CloudGatewayPool:18b395e2-81ff-439c-ae8c-188d97274c15. |
Name | String | Name of the cloud gateway pool resource, for example: TechCompany Gateway Pool. |
Description | String | Description of the cloud gateway pool. |
CloudGateways | CloudGatewayPoolGatewayListType | Specifies the list of the cloud gateways included in the cloud gateway pool. At least one cloud gateway must be specified to create a cloud gateway pool. For details, see Cloud Gateway Settings. |
CloudTenants | CloudGatewayPoolTenantListType | Specifies a list of cloud tenants to whom the cloud gateway pool will be assigned. This parameter is optional, because a gateway pool can be assigned to no tenants. For details, see Cloud Tenant Settings. |
To view query parameters that you can use for filtering or sorting, see GET /query?type=CloudGatewayPool.
The CloudGateways element contains the following cloud gateway settings.
Element | Type | Description |
|---|---|---|
CloudGatewayUid | UidType | UID of the cloud gateway included in the cloud gateway pool. Can be obtained from the representation of the /cloud/gateways resource. |
The CloudTenants element contains the following cloud tenant settings.
Element | Type | Description |
|---|---|---|
CloudTenantUid | UidType | UID of the tenant account to which the cloud gateway pool will be assigned. Can be obtained from the representation of the /cloud/tenants resource. |
Links
Reference | Relationship | Description |
|---|---|---|
/backupServers/{ID} | Up | URL of the /backupServers/{ID} resource — a backup server where the cloud gateway pool was created. |
/cloud/gatewayPools/{ID} | Alternate | Alternate URL of the /cloud/gatewayPools/{ID} resource. |
/cloud/gatewayPools/{ID} | Edit | URL for the PUT /cloud/gatewayPools/{ID} request. |
/cloud/gateways/{ID} | Delete | URL for the DELETE /cloud/gatewayPools/{ID} request. |
/cloud/gatewayPools/{ID}/gateways | Down | URL of the /cloud/gateways resource — a collection of cloud gateways contained in the gateway pool. |
/cloud/gatewayPools/{ID}/tenants | Related | URL of the /cloud/tenants resource — a collection of tenant accounts have access to the gateway pool. |
Example
The example below returns an entity reference representation of the cloud gateway pool with ID 77e85a22-aa23-4c86-bbb2-a4e55860b0ee.
Request: GET https://localhost:9398/api/cloud/gatewayPools/77e85a22-aa23-4c86-bbb2-a4e55860b0ee?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <?xml version="1.0" encoding="utf-8"?> |