Retrieve a Server Group (MySQL)

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/mysqlservers/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 MySQLServerGroup (MySQL Object).

Example

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

GET https://<ServiceMgmt>:30004/services/mysqlservers/serverGroups/<GroupId> HTTP/1.1
x-ms-version: 2012-03-01
Accept: application/json
Authorization: Bearer <Token>
x-ms-client-request-id: 849da7d1-787d-4727-9da7-c30d725034f0-2013-09-05 01:27:13Z
x-ms-client-session-id: d0266f00-4e5d-4c60-afe6-3e4acc8fff42
x-ms-principal-id: <SERVICEMGMT>%5cAdministrator
Accept-Language: en-US
Host: <ServiceMgmt>:30004
Content-Length: 0

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

{
  "GroupId": "2n9c",
  "GroupName": "Default",
  "HostingServerCount": 1
}

Share via