Retrieve the Allocated Space on a Server (MySQL)

 

Applies To: Windows Azure Pack

Retrieves the total allocated space of a hosting server during the specified duration.

Replace <ServiceMgmt> with your Service Management API endpoint address, and <ServerId> with the identifier of the server.

Method

Request URI

HTTP version

GET

https://<ServiceMgmt>:30004/services/mysqlservers/hostingServers/<ServerId>/Metrics/TotalAllottedSpace

HTTP/1.1

The following table describes the URI parameters.

URI Parameter

Description

startTime

The time in UTC format, to start collecting the metric.

endTime

The time in UTC format, to stop collecting the metric.

The following table describes required and optional request headers.

Request header

Description

Authorization: Bearer

Required. The authorization bearer token.

x-ms-principal-id

Required. The principal identifier.

x-ms-client-request-id

Optional. The client request identifier.

x-ms-client-session-id

Optional. The client session identifier.

x-ms-principal-liveid

Optional. The principal Live identifier.

The response includes an HTTP status code, a set of response headers, and a response body.

A successful operation returns status code 200 (OK).

The response for this operation includes standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

The following table describes the key elements of the response body:

Element name

Description

ResourceMetricResponse

The retrieved metric. For more information, see ResourceMetricResponse (MySQL Object).

The following code example shows a Retrieve the Allocated Space on a Server request.

GET https://<ServiceMgmt>:30004/services/mysqlservers/hostingServers/<ServerId>/Metrics/TotalAllottedSpace?startTime=2013-08-27T23:51:56.7613394Z&endTime=2013-08-28T23:51:56.7613394Z HTTP/1.1
x-ms-version: 2012-03-01
Accept: application/json
Authorization: Bearer <Token>
x-ms-client-request-id: 59098650-61da-4dc3-9472-b5eee712be0a-2013-08-28 23:51:56Z
x-ms-client-session-id: aa1ca0e4-94b9-4db6-97ab-e1ed667173d7
x-ms-principal-id: <SERVICEMGMT>%5cAdministrator
Accept-Language: es-ES
Host: <ServiceMgmt>:30004

The following code example shows a Retrieve the Allocated Space on a Server response.

{
  "Code": null,
  "Message": null,
  "Data": {
    "Name": "TotalAllottedSpace",
    "Dimensions": [

    ],
    "PrimaryAggregationType": "Total",
    "Unit": "Count",
    "MetricAvailabilities": [

    ],
    "EndTime": "2013-08-28T23:00:00",
    "StartTime": "2013-08-27T23:00:00",
    "Values": [
      {
        "TimeCreated": "2013-08-28T23:00:00",
        "Total": 1024,
        "Minimum": 1024,
        "Maximum": 1024,
        "Count": 1
      },
      {
        "TimeCreated": "2013-08-27T23:00:00",
        "Total": 0,
        "Minimum": 0,
        "Maximum": 0,
        "Count": 1
      }
    ],
    "TimeGrain": "01:00:00"
  }
}
Show: