Get a Server Group

Article
08/24/2015

Applies To: Windows Azure Pack

Retrieves 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/sqlservers/serverGroups/<GroupId>	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
SqlServerGroup	The retrieved server group. For more information, see SqlServerGroup (Object).

Example

The following code example shows a Get a Server Group request.

GET https://:30004/services/sqlservers/serverGroups/<GroupId> HTTP/1.1
x-ms-version: 2012-03-01
Accept: application/json
Authorization: Bearer <Token>
x-ms-client-request-id: 5deac5b3-57f1-4f5d-8b9d-152d2103a7e3-2013-08-27 00:46:27Z
x-ms-client-session-id: d6272660-6ee3-45d5-8cb9-cc79a20799cc
x-ms-principal-id: <SERVICEMGMT>%5cAdministrator
Accept-Language: es-ES
Host: <ServiceMgmt>:30004

The following code example shows a Get a Server Group response.

{
    "GroupId": "2n9c",
    "GroupName": "Default",
    "AlwaysOnEnabled": false,
    "SharedFileServer": null,
    "HostingServerCount": 1
  }

Share via