Sign in

v1

latestOpenAPI 3.0.02026-08-0645003.8 MB
Elastigroup AWS

Create Instance Signal

The instance signal API is used for notifying Spot about the instance state, so Spot can act accordingly. Supported signals are - INSTANCE_READY – Whenever this signal is sent, Spot will register the instance to the ELB INSTANCE_READY_TO_SHUTDOWN – Whenever this signal is sent, Spot will terminate the instance after it was marked for termination. Important - You need to define the expected signals for your Elastigroup in the group configuration.

post/aws/ec2/instance/signal

Query parameters

accountIdstring

ID of the account associated with your token

Request body

instanceIdstring

The instance ID the signal refers to.

signalstring

The specific signal you want to trigger. Valid Values - INSTANCE_READY, INSTANCE_READY_TO_SHUTDOWN

Example request

{
  "instanceId": "i-123456",
  "signal": "INSTANCE_READY"
}

Response

Create Instance Signal Response

Example response

{
  "request": {
    "id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
    "url": "/aws/ec2/instance/signal",
    "method": "POST",
    "timestamp": "2018-01-07T07:30:58.622Z"
  },
  "response": {
    "status": {
      "code": 200,
      "message": "OK",
      "kind": "spotinst:aws:ec2:instance:signal",
      "items": {
        "instanceId": "i-0c8bc7fd0e8cd6c8d",
        "instanceLaunchedAt": "2023-04-30T12:20:14.000Z",
        "instanceDetachedAt": "2023-04-30T12:20:14.000Z",
        "type": "INSTANCE_READY",
        "signalExpiresAt": "2023-04-30T12:21:14.000Z",
        "message": "This instance crossed the signal timeout limit at Sun Apr 30 12:21:14 UTC 2023"
      },
      "count": 1
    }
  }
}