This is an archive version of the document. To get the most up-to-date information, see the current version.

Get Elastic Pool Data

You can get data on an elastic pool with the specified ID.

Request

To retrieve information on a specific elastic pool, send the HTTP GET request to the /cloudInfrastructure/sqlElasticPool/{sqlElasticPoolId} endpoint. {sqlElasticPoolId} is a system ID assigned to the elastic pool in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

GET https://<hostname>/api/v3/cloudInfrastructure/elasticPool/{sqlElasticPoolId}

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following query parameters:

Query Parameter

Value

Description

Sync

boolean

Defines whether Veeam Backup for Microsoft Azure database is synchronized with Azure resources.

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a 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

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a representation of the elastic pool with the specified ID. The SqlElasticPoolV3 schema is used for the collection representation.

Get Elastic Pool DataExample

The following request returns information on the elastic pool with the ID d41h9girzxb4d6aszx7p8ehypx3dq7usjd411zuset7h4s65raco.

Request:

GET https://51.11.247.127/api/v3/cloudInfrastructure/sqlElasticPool/d41h9girzxb4d6aszx7p8ehypx3dq7usjd411zuset7h4s65raco

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "databaseStorageCapacityMb": 5000,

 "dtu": 50,

 "edition": "Basic",

 "id": "d41h9girzxb4d6aszx7p8ehypx3dq7usjd411zuset7h4s65raco",

 "name": "bp-elastic-1",

 "regionId": "eastus",

 "resourceId": "/subscriptions/280921a2-220d-45c9-92dd-82b6d5a3a78f/resourcegroups/bp-sql/providers/microsoft.sql/servers/bp-server-eus2/elasticpools/bp-elastic-1",

 "serverId": "mtmbozrjjz7p91axo9pt9wzsii9jz3mi1m89apgnkkcswxgek6mo",

 "state": "Ready",

 "poolStorageCapacityMb": 5000,

 "subscriptionId": "280921a2-220d-45c9-92dd-82b6d5a3a78f",

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v3/cloudInfrastructure/sqlElasticPools/d41h9girzxb4d6aszx7p8ehypx3dq7usjd411zuset7h4s65raco"

   }

 }

}