Click or drag to resize

IJsonpWsEndUserGetServers Method

Obtain server list of specified account. Can you filter result by state. GetServer method get object list of Server class. Exist optional integer value to filter by state.

Namespace:  Aruba.Cloud.WsEndUser
Assembly:  Aruba.Cloud.WsEndUser (in Aruba.Cloud.WsEndUser.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
[OperationContractAttribute]
[WebGetAttribute(ResponseFormat = WebMessageFormat.Json, UriTemplate = "GetServers/{jsonp}/{userName}/{token}/{statusId}")]
Stream GetServers(
	string jsonp,
	string userName,
	string token,
	string statusId
)

Parameters

jsonp
Type: SystemString
ArubaCloud.Response.Server.call
userName
Type: SystemString
Type string to indicate account. Format: ARU-XXXX
token
Type: SystemString
Type string to rappresent valid token for authenticated account
statusId
Type: SystemString
Value type System.Int32. It’s status id of server. If null return all account’s servers. Possible status code in follow table:
CodeStatus
1Creation Server
2Server Off
3Started Server
4Archivied Server
5Deleted Server

Return Value

Type: Stream
WsResultOfServerDetails contain server details information of authenticated user. For more information consult WsResult class and Server class
Examples
The method can be called using the following notation:
https://api.dc1.computing.cloud.it/wsenduser/v1.3/jsonp/GetServers/ArubaCloud.Response.Server.call/ARU-0000/e20cf5fa-ce5c-489c-9160-b26efdc1bad8/859

The following is an example of the response body

ArubaCloud.Response.server.call({
  "ExceptionInfo": null,
  "ResultCode": 0,
  "ResultMessage": null,
  "Success": true,
  "Value": [
    {
      "CPUQuantity": 1,
      "CompanyId": 1,
      "DatacenterId": 1,
      "HDQuantity": 4,
      "HDTotalSize": 40,
      "HypervisorServerType": 1,
      "HypervisorType": 1,
      "Name": "ServerCloud01",
      "OSTemplateId": 23,
      "RAMQuantity": 1,
      "ServerId": 787,
      "ServerStatus": 4,
      "UserId": 267
    },
    {
      "CPUQuantity": 1,
      "CompanyId": 1,
      "DatacenterId": 1,
      "HDQuantity": 1,
      "HDTotalSize": 30,
      "HypervisorServerType": 2,
      "HypervisorType": 2,
      "Name": "ServerCloud01",
      "OSTemplateId": 4,
      "RAMQuantity": 1,
      "ServerId": 825,
      "ServerStatus": 4,
      "UserId": 267
    },
    {
      "CPUQuantity": 1,
      "CompanyId": 1,
      "DatacenterId": 1,
      "HDQuantity": 1,
      "HDTotalSize": 10,
      "HypervisorServerType": 2,
      "HypervisorType": 2,
      "Name": "ServerLinux",
      "OSTemplateId": 6,
      "RAMQuantity": 1,
      "ServerId": 859,
      "ServerStatus": 3,
      "UserId": 267
    }
  ]
})
See Also