Retrieve All Hosting Servers (MySQL)

Article
08/24/2015

Applies To: Windows Azure Pack

Retrieves a list of all hosting servers.

Request

Replace <ServiceMgmt> with your Service Management API endpoint address.

Method	Request URI	HTTP version
GET	https://<ServiceMgmt>:30004/services/mysqlservers//hostingServers	HTTP/1.1

URI Parameters

The following table describes the URI parameters.

URI Parameter	Description
skip	The number of items to bypass in the list, starting from the begging. The remaining items will be included in the list.
take	The number of items to retrieve, starting from the beginning of the list. The remaining items will be excluded from the list.

Request Headers

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.

Request Body

None.

Response

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

Status Code

A successful operation returns status code 200 (OK).

Response Headers

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

Response Body

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

Element name	Description
HostingServer	The retrieved collection of hosting servers. For more information, see HostingServer (MySQL Object).

Example

The following code example shows a Retrieve All Hosting Servers request.

GET https://<ServiceMgmt>:30004/services/mysqlservers//hostingServers?skip=0&take=25 HTTP/1.1
x-ms-version: 2012-03-01
Accept: application/json
Authorization: Bearer <Token>
x-ms-client-request-id: f5837983-d8fa-4d87-8696-238503e911a2-2013-08-28 23:45:37Z
x-ms-client-session-id: aa1ca0e4-94b9-4db6-97ab-e1ed667173d7
x-ms-principal-id: <SERVICEMGMT>%5cAdministrator
Accept-Language: es-ES
Host: <ServiceMgmt>:30004
Connection: Keep-Alive

The following code example shows a Retrieve All Hosting Servers response.

{
  "items": [
    {
      "Name": “computer",
      "ServerId": "lxbn7i",
      "Created": "0001-01-01T00:00:00+00:00",
      "AvailableSpaceMB": 102400,
      "TotalSpaceMB": 102400,
      "DatabaseCount": 0,
      "State": 1,
      "ServerGroups": [
        {
          "GroupId": "2n9c",
          "GroupName": "Default",
          "HostingServerCount": 1
        }
      ],
      "ConnectionString": ""
    }
  ],
  "filteredTotalCount": 1,
  "totalCount": 1
}

Share via