Retrieve a Group of Hosting Servers (MySQL)

Article
08/24/2015

Applies To: Windows Azure Pack

Retrieves a list of all hosting servers within the specified server group.

Request

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

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

URI Parameters

None.

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 list of hosting servers. For more information, see HostingServer (MySQL Object).

Example

The following code example shows a List Hosting Servers By Group request.

GET https://<ServiceMgmt>:30004/services/mysqlservers/serverGroups/<GroupId>/hostingServers HTTP/1.1
x-ms-version: 2012-03-01
Accept: application/json
Authorization: Bearer <Token>
x-ms-client-request-id: 7a56998f-764b-4586-970e-8191fa6ed653-2013-08-28 23:46:03Z
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 List Hosting Servers By Group 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