Server object
A Scalr Server.
Example JSON representation
{
"alerts": [
{
"message": "string",
"occurred": "2013-01-01T12:34:56.789Z",
"status": "failed",
"type": "SCALARIZR_CONNECT"
}
],
"cloudLocation": "string",
"cloudPlatform": "ec2",
"cloudServerId": "string",
"farm": {
"id": 1
},
"farmRole": {
"id": 1
},
"hostname": "string",
"id": "string",
"index": 1,
"instanceType": {
"id": "string"
},
"launchReason": "string",
"launched": "2013-01-01T12:34:56.789Z",
"launchedBy": {
"email": "string",
"id": 1
},
"operations": [
{
"name": "resizing"
}
],
"privateIp": [
"string"
],
"publicIp": [
"string"
],
"scalrAgent": {
"deployCommand": "string",
"initializationStatus": {
"message": "string",
"status": "insufficient-data"
},
"reachabilityStatus": {
"message": "string",
"status": "insufficient-data"
},
"version": "string"
},
"status": "temporary",
"suspended": "2013-01-01T12:34:56.789Z"
}
Properties
property | attributes | valid values | description | filter option |
---|---|---|---|---|
alerts Array of ServerAlert objects |
read-only |
Alerts about server state |
||
cloudLocation string |
read-only filterable |
Cloud Location, inside a given Cloud Platform, for this resource. May be null if this resource does not have a specific location. Note: if you would like to filter on this property, you must also filter on |
?cloudLocation=... | |
cloudPlatform string |
read-only filterable |
"ec2" "gce" "azure" "cloudstack" "idcf" "openstack" "ocs" "otc" "rackspacenguk" "rackspacengus" "hpcloud" "mirantis" "vio" "cisco" "vmware" |
The Cloud Platform this resource resides in. |
?cloudPlatform=... |
cloudServerId string |
read-only filterable |
Identifier of the Server on the cloud. |
?cloudServerId=... | |
farm FarmForeignKey object |
read-only filterable |
Identifier of the Farm this Server belongs to. |
Pass the id of the object you are referencing in: ?farm=... |
|
farmRole FarmRoleForeignKey object |
read-only filterable |
Identifier of the Farm Role this Server belongs to. |
Pass the id of the object you are referencing in: ?farmRole=... |
|
hostname string |
read-only filterable |
The hostname of this Server. |
?hostname=... | |
id string |
read-only filterable |
Unique identifier for this Server. |
?id=... | |
index integer |
read-only filterable |
The index of this Server in the Farm Role. |
?index=... | |
launchReason string |
read-only filterable |
The reason this Server was launched. |
?launchReason=... | |
launched string |
read-only |
The date at which this Server was launched. |
||
launchedBy ComposedUserIdentity object |
read-only filterable |
The identifier and email of the User who launched this Server. |
Pass the id of the object you are referencing in: ?launchedBy=... |
|
operations Array of ServerOperations objects |
read-only |
Temporary states of the Cloud Server being processed by one or a number of Requests. |
||
privateIp Array of string |
read-only filterable |
The private IP address of this Server. |
?privateIp=... | |
publicIp Array of string |
read-only filterable |
The public IP address of this Server. |
?publicIp=... | |
scalrAgent ScalrAgent object |
read-only |
The information about Scalr Agent. This property is available only for a servers which have Scalr agent installed. |
||
status string |
read-only filterable |
"temporary" "running" "pending" "pending_launch" "initializing" "importing" "terminated" "pending_terminate" "pending_suspend" "suspended" "resuming" |
Server status. |
?status=... |
suspended string |
read-only |
Datetime when server was suspended. |
||
instanceType InstanceTypeForeignKey object |
optional filterable |
Instance type on the Cloud Platform. |
Pass the id of the object you are referencing in: ?instanceType=... |
Endpoints using this object
- User / Servers: Get
- User / Servers: Edit
- User / Servers / Actions: Reboot
- User / Servers / Actions: Resume
- User / Servers / Actions: Suspend
- User / Servers / Actions: Sync
- User / Servers / Actions: Terminate
- User / Servers / Global Variables: List
- User / Servers / Global Variables: Create
- User / Servers / Global Variables: Delete
- User / Servers / Global Variables: Get
- User / Servers / Global Variables: Edit