FarmRoleDetailsResponse object

Example JSON representation

{
  "data": {
    "advancedConfiguration": {
      "abortInitializationOnOrchestrationFailure": true, 
      "disableAgentHostnameManagement": true, 
      "disableAgentIptablesManagement": true, 
      "disableAgentNtpManagement": true, 
      "instanceName": "string", 
      "rebootAfterHostInit": true
    }, 
    "alias": "string", 
    "availabilityZones": [
      "string"
    ], 
    "bootstrapping": {
      "enabled": true, 
      "type": "BootstrapConfiguration"
    }, 
    "cloudFeatures": {
      "type": "CloudFeatures"
    }, 
    "cloudLocation": "string", 
    "cloudPlatform": "ec2", 
    "farm": {
      "id": 1
    }, 
    "id": 1, 
    "instanceType": {
      "id": "string"
    }, 
    "launchIndex": 1, 
    "networking": {
      "hostname": {
        "domainName": "string", 
        "type": "HostnameConfiguration"
      }, 
      "networks": [
        {
          "associatePublicIpAddress": true, 
          "cloudFeatures": {
            "type": "NetworkCloudFeatures"
          }, 
          "id": "string", 
          "ipPool": {
            "id": "string"
          }, 
          "primary": true, 
          "staticIpMap": [
            {
              "ipAddress": "string", 
              "serverIndex": 1, 
              "type": "GenericStaticIp"
            }
          ], 
          "subnets": [
            {
              "id": "string"
            }
          ]
        }
      ], 
      "subnets": [
        {
          "id": "string", 
          "networkId": "string"
        }
      ]
    }, 
    "role": {
      "deprecated": {
        "deprecated": "2013-01-01T12:34:56.789Z", 
        "replacement": {
          "id": 1
        }
      }, 
      "id": 1
    }, 
    "scaling": {
      "considerSuspendedServers": "running", 
      "enabled": true, 
      "maxInstances": 1, 
      "minInstances": 1, 
      "rules": [
        "string"
      ], 
      "scalingBehavior": "suspend-resume"
    }, 
    "security": {
      "securityGroups": [
        {
          "id": "string", 
          "name": "string"
        }
      ]
    }
  }, 
  "errors": [
    {
      "code": "string", 
      "message": "string"
    }
  ], 
  "meta": {
    "sample": "string"
  }, 
  "warnings": [
    {
      "code": "string", 
      "message": "string"
    }
  ]
}

Properties

property attributes valid values description filter option
data
FarmRole object
read-only
errors
Array of ApiMessage objects
read-only
meta
ApiMetaContainer object
read-only
warnings
Array of ApiMessage objects
read-only

Endpoints using this object