Retrieve an Instance

get

/api/v2/instances/{id}/

Make GET request to this resource to retrieve a single instance record containing the following fields:

  • id: Database ID for this instance. (integer)
  • hostname: (string)
  • type: Data type for this instance. (choice)
  • url: URL for this instance. (string)
  • related: Data structure with URLs of related resources. (object)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
  • uuid: (string)
  • created: Timestamp when this instance was created. (datetime)
  • modified: Timestamp when this instance was last modified. (datetime)
  • last_seen: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)
  • health_check_started: The last time a health check was initiated on this instance. (datetime)
  • health_check_pending: (field)
  • last_health_check: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)
  • errors: Any error details from the last health check. (string)
  • capacity_adjustment: (decimal)
  • version: (string)
  • capacity: (integer)
  • consumed_capacity: (field)
  • percent_capacity_remaining: (field)
  • jobs_running: Count of jobs in the running or waiting state that are targeted for this instance (integer)
  • jobs_total: Count of all jobs that target this instance (integer)
  • cpu: (decimal)
  • memory: Total system memory of this instance in bytes. (integer)
  • cpu_capacity: (integer)
  • mem_capacity: (integer)
  • enabled: (boolean)
  • managed_by_policy: (boolean)
  • node_type: Role that this node plays in the mesh. (choice)
    • control: Control plane node
    • execution: Execution plane node
    • hybrid: Controller and execution
    • hop: Message-passing node, no execution capability
  • node_state: Indicates the current life cycle stage of this instance. (choice)
    • provisioning: Provisioning
    • provision-fail: Provisioning Failure
    • installed: Installed
    • ready: Ready
    • unavailable: Unavailable
    • deprovisioning: De-provisioning
    • deprovision-fail: De-provisioning Failure
  • ip_address: (string)
  • listener_port: Port that Receptor will listen for incoming connections on. (integer)
  • peers: (field)
  • peers_from_control_nodes: If True, control plane cluster nodes should automatically peer to it. (boolean)

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : Instance
Type: object
Show Source
Nested Schema : peers
Type: array
Unique Items Required: true
Show Source
Back to Top