This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Server Information
This section explains how to get information about the controller server.
Request
GET https://<hostname>/api/v1/system/serverInfo |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
Property | Type | Description |
|---|---|---|
subscriptionId | string | Shows the identification number of the subscription in which the controller server is deployed. |
azureRegion | string | Shows the region in which the controller server is deployed. |
resourceGroup | string | Shows the resource group in which the controller server is deployed. |
azureEnvironment | string | Shows the environment in which the controller server is deployed. |
virtualMachineUniqueId | string | Shows a unique identification number of the virtual machine with the controller server. |
controllerNetwork | Shows an object that contains network parameters of the controller server. |
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the network in which the controller server is deployed. |
name | string | Shows the name of the network in which the controller server is deployed. |
regionName | string | Shows the name of the region in which the network is created. |
addressSpaces | string | Shows the address space the network uses. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/system/serverInfo
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "subscriptionId": "3a9a8330-7bbc-4b03-9c68-15d674fbc809", "azureRegion": "ukwest", "resourceGroup": "", "azureEnvironment": "Global", "virtualMachineUniqueId": "cafff254-12b0-41a7-8562-6f9b9f29bf68", "controllerNetwork": { "id": "/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809/resourcegroups//providers/microsoft.network/virtualnetworks/-network", "name": "-Network", "regionName": "ukwest", "addressSpaces": ["10.4.15.0/24"], "_links": { "subscription": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/cloudInfrastructure/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809"}, "self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/cloudInfrastructure/virtualNetworks/%2Fsubscriptions%2F3a9a8330-7bbc-4b03-9c68-15d674fbc809%2Fresourcegroups%2F%2Fproviders%2Fmicrosoft.network%2Fvirtualnetworks%2F-network"} } } } |