Elastic Compute Service:Detect and respond to spot instance interruption events

Create a request object for the API operation

Before you create a request object, view the parameters of the API operation that you want to call.

// Create a request object.
DescribeInstancesRequest request = new DescribeInstancesRequest().setRegionId("cn-hangzhou");

Initiate a call

When you call an API operation from a client, you can specify runtime parameters, such as timeout parameters and proxy parameters. For more information, see Advanced settings.

// Specify the runtime parameters.
RuntimeOptions runtime = new RuntimeOptions();
// Call the DescribeInstances operation.
DescribeInstancesResponse response = client.describeInstancesWithOptions(request, runtime);
System.out.println(response.body.toMap());

Handle exceptions

ECS SDK for Java classifies exceptions into the following types:

• TeaUnretryableException: In most cases, exceptions of this type are caused by network errors and are reported when the maximum number of retries is reached.

• TeaException: In most cases, this type of exception is caused by business errors.

We recommend that you properly handle exceptions by performing operations, such as reporting exceptions, logging exceptions, and performing retries, to ensure the robustness and stability of your system.

Example

import com.aliyun.ecs20140526.Client;
import com.aliyun.ecs20140526.models.DescribeInstancesRequest;
import com.aliyun.ecs20140526.models.DescribeInstancesResponse;
import com.aliyun.ecs20140526.models.DescribeInstancesResponseBody;
import com.aliyun.tea.TeaException;
import com.aliyun.tea.TeaUnretryableException;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teautil.models.RuntimeOptions;
import com.alibaba.fastjson.JSONArray;

import java.util.Arrays;

public class Sample {
    private static Client createClient() throws Exception {
        Config config = new Config()
                // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured. 
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is configured. 
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
                // Specify an endpoint. For information about endpoints, visit https://api.alibabacloud.com/product/Ecs.
                .setEndpoint("ecs.cn-hangzhou.aliyuncs.com");
        return new Client(config);
    }

    public static void main(String[] args) {
        try {
            Client client = Sample.createClient();
            // Create a request object.
            // Specify the IDs of one or more ECS instances. 
            JSONArray instanceIds = new JSONArray();
            instanceIds.addAll(Arrays.asList("i-bp145cvd0exyqj****","i-bp1gehfgfrrk4lah****"));
            DescribeInstancesRequest request = new DescribeInstancesRequest()
                    .setRegionId("cn-hangzhou")
                    .setInstanceIds(instanceIds.toJSONString());
            // Specify the runtime parameters.
            RuntimeOptions runtime = new RuntimeOptions();
            while (!instanceIds.isEmpty()) {
              // Call the DescribeInstances operation.
              DescribeInstancesResponse response = client.describeInstancesWithOptions(request, runtime);
              // Obtain instance-specific results. 
              DescribeInstancesResponseBody responseBody = response.getBody();
              DescribeInstancesResponseBody.DescribeInstancesResponseBodyInstances instanceList = responseBody.getInstances();
              // Obtain instance information and determine the status of instances based on the value of the lockReason parameter.
              if (instanceList != null && instanceList.getInstance()!= null && !instanceList.getInstance().isEmpty()) {
                  for (DescribeInstancesResponseBody.DescribeInstancesResponseBodyInstancesInstance instance : instanceList.getInstance()) {
                      // View the IDs and zone IDs of the queried instances. 
                      System.out.println("result:instance:" + instance.getInstanceId() + ",az:" + instance.getZoneId());
                      if (instance.getOperationLocks() != null ) {
                          DescribeInstancesResponseBody.DescribeInstancesResponseBodyInstancesInstanceOperationLocks operationLocks  = instance.getOperationLocks();
                          if(operationLocks.getLockReason()!=null && !operationLocks.getLockReason().isEmpty()){
                              for (DescribeInstancesResponseBody.DescribeInstancesResponseBodyInstancesInstanceOperationLocksLockReason lockReason : operationLocks.getLockReason()) {
                                  // If an instance is locked, view the instance ID and the reason why the instance is locked. 
                                  System.out.println("instance:" + instance.getInstanceId() + "-->lockReason:" + lockReason.getLockReason() + ",vmStatus:" + instance.getStatus());
                                  if ("Recycling".equals(lockReason.getLockReason())) {
                                      // View the IDs of the instances to be reclaimed. 
                                      System.out.println("spot instance will be recycled immediately, instance id:" + instance.getInstanceId());
                                      instanceIds.remove(instance.getInstanceId());
                                  }
                              }
                          }

                      }
                  }
                  // If a spot instance is not locked, the instance is queried every 2 minutes. 
                  System.out.print("try describeInstances again later ...");
                  Thread.sleep(2 * 60 * 1000);
              } else {
                  break;
              }
            }
        } catch (TeaUnretryableException ue) {
            // Handle exceptions with caution in actual business scenarios and do not ignore exceptions in your project. In this example, exceptions are provided only for reference. 
            ue.printStackTrace();
            // Display the error message.
            System.out.println(ue.getMessage());
            // Display the request message and query the request information when an error occurs.
            System.out.println(ue.getLastRequest());
        } catch (TeaException e) {
            // Handle exceptions with caution in actual business scenarios and do not ignore exceptions in your project. In this example, exceptions are provided only for reference. 
            e.printStackTrace();
            // Display the error code.
            System.out.println(e.getCode());
            // Display the error message that contains the request ID.
            System.out.println(e.getMessage());
            // Display the detailed error information that is returned by the server.
            System.out.println(e.getData());
        } catch (Exception e) {
            // Handle exceptions with caution in actual business scenarios and do not ignore exceptions in your project. In this example, exceptions are provided only for reference. 
            e.printStackTrace();
        }
    }
}

Response

The following response is returned if the reclamation of a spot instance is triggered:

result:instance:i-bp1i9c3qiv1qs6nc****,az:cn-hangzhou-i
instance:i-bp1i9c3qiv1qs6nc****-->lockReason:Recycling,vmStatus:Stopped
spot instance will be recycled immediately, instance id:i-bp1i9c3qiv1qs6nc****

Linux ECS instance

# Obtain the access credentials of the metadata server for authentication.
TOKEN=`curl -X PUT "http://100.100.100.200/latest/api/token" -H "X-aliyun-ecs-metadata-token-ttl-seconds:<Validity period of the metadata server access credentials>"`
# Query whether the spot instance is interrupted and reclaimed.
curl -H "X-aliyun-ecs-metadata-token: $TOKEN" http://100.100.100.200/latest/meta-data/instance/spot/termination-time

Windows ECS instance

# Obtain the access credentials of the metadata server for authentication.
$token = Invoke-RestMethod -Headers @{"X-aliyun-ecs-metadata-token-ttl-seconds" = "<Validity period of the metadata server access credentials>"} -Method PUT -Uri http://100.100.100.200/latest/api/token
# Query whether the spot instance is interrupted and reclaimed.
Invoke-RestMethod -Headers @{"X-aliyun-ecs-metadata-token" = $token} -Method GET -Uri http://100.100.100.200/latest/meta-data/instance/spot/termination-time

Workflow

Procedure

1. Create a push channel

   Function Compute

   1. Log on to the Function Compute console. In the left-side navigation pane, click Services & Functions.

   2. In the top navigation bar, select a region. On the Services page, click the desired service.

   3. On the Functions page, click Create Function.

   4. On the Create Function page, select a method to create a function, configure the following parameters, and then click Create.

      Note

      In this example, Use Built-in Runtime and Use Custom Runtime are used. If the runtimes provided by Function Compute cannot meet your business requirements, you can select Use Container Image to create a function. For more information, see Create a Custom Container function.

      • Basic Settings: Configure the basic information of the function, including Function Name and Handler Type. Handler Type can be set to one of the following values:

        • Event Handler: triggers the function by using a timer, calling API operations, using SDKs, or using triggers integrated with other Alibaba Cloud services.

        • HTTP Handler: triggers function execution by HTTP requests or WebSocket requests. In web scenarios, we recommend that you select Use Custom Runtime.

      • In the Code section, configure the runtime and code-related information of the function.

        Parameter	Description	Example
        Runtime	Select a programming language, such as Python, Java, PHP, or Node.js. For more information about the runtimes that are supported by Function Compute, see Runtimes that are supported by Function Compute.	Node.js14
        Code Upload Method	Select a method to upload function code to Function Compute. Use Sample Code: Select sample code provided by Function Compute to create a function based on your business requirements. This is the default method. Upload ZIP: Select and upload a ZIP package that contains your code. Upload JAR: Select and upload a JAR file that contains your function code. Upload Folder: Select and upload a folder that contains function code. OSS: Specify the Bucket Name and Object Name parameters for your function code. Note If you set Code Upload Method to Use Sample Code, you do not need to modify Handler. If you select another code upload method, you must modify Handler based on your business requirements. Otherwise, an error is reported when you run the function. If you set Runtime to Java 8 or Java 11, you can select only Use Sample Code, Upload JAR, or OSS to upload function code. For other runtimes, you can select Use Sample Code, Upload ZIP, Upload Folder, or OSS.	Use Sample Code
        Startup Command	Note You must configure this parameter only if you select Use Custom Runtime to create a function. Configure the startup command of the program. If you do not configure the startup command, you must manually create a startup script named bootstrap in the root directory of the code. The bootstrap script is used to start your program.	npm run start
        Listening Port	Note You must configure this parameter only if you select Use Custom Runtime to create a function. Specify the port on which the HTTP server in your code listens.	9000

      • Advanced Settings: Configure instance information and the function execution timeout period.

        Parameter	Description	Example
        Specifications	Configure vCPU Capacity and Memory Capacity based on your business requirements. For more information about billing of resources, see Billing overview. Note The ratio of vCPU capacity to memory capacity (in GB) must be set from 1:1 to 1:4.	0.35 vCPUs, 512 MB
        Size of Temporary Disk	Specify the size of the hard disk used to temporarily store files based on your business requirements. Valid values: 512 MB (default): You are not charged for using a temporary disk of this size. Function Compute provides you with a free disk capacity of 512 MB. 10 GB: You are charged based on a disk size of 9.5 GB. Note Data can be written to all directories in the temporary hard disk. The directories share the space of the temporary hard disk. The lifecycle of the temporary hard disk is consistent with that of the underlying instance. After the instance is recycled by the system, the data on the hard disk is cleared. To persist stored data, you can use File Storage NAS (NAS) or Object Storage Service (OSS). For more information, see Configure a NAS file system and Configure an OSS file system.	512 MB
        Instance Concurrency	Specify the instance concurrency. For more information, see Configure instance concurrency.	10
        Execution Timeout Period	Specify the timeout period of a function execution. The default value of Execution Timeout Period is 60 seconds and the maximum value is 86,400 seconds.	60
        Handler	Specify the handler of the function. The Function Compute runtime loads and invokes the handler to process requests. This parameter is not required if you select Use Custom Runtime or Use Container Image. Note If you set Code Upload Method to Use Sample Code, you do not need to modify Handler. If you select another code upload method, you must modify Handler based on your business requirements. Otherwise, an error is reported when you run the function.	index.handler
        Time Zone	Specify the time zone of the function. After you configure the time zone of the function, the environment variable TZ is automatically added to the function. The value is the time zone that you configure.	UTC

      • Environment Variables: Configure environment variables for the runtime of your function. For more information, see Environment variables.

      • In the Trigger Configurations section, configure a trigger for the function based on your business requirements. You can use the trigger to trigger the function. For more information, see Manage triggers.

   SMQ

   1. Log on to the SMQ console.

   2. In the left-side navigation pane, choose Queue Model > Queues.

   3. In the top navigation bar, select a region.

   4. On the Queues page, click Create Queue.

   5. In the Create Queue panel, configure the following parameters and click OK:

      • Name: the name of the queue.

      • Maximum Message Length: the maximum length of the message that is sent to the queue.

      • Long Polling Period: the maximum duration for which long polling requests are held after the ReceiveMessage operation is called.

      • Visibility Timeout Period: the duration for which a message stays in the Inactive state after the message is received from the queue.

      • Message Retention Period: the maximum duration for which a message exists in the queue. After the specified retention period, the message is deleted regardless of whether the message is received.

      • Message Delay Period: the period after which all messages sent to the queue are consumed.

      • Enable Logging Feature: specifies whether to enable the logging feature.

      After the queue is created, it is displayed on the Queues page.

   Webhook

   Important

   The webhook service must be deployed on a server that has Internet access. Make sure that the webhook port of the server is open in the corresponding security groups and firewall.

   Sample code in Java:

   import org.springframework.http.ResponseEntity;
   import org.springframework.web.bind.annotation.PostMapping;
   import org.springframework.web.bind.annotation.RequestBody;
   import org.springframework.web.bind.annotation.RestController;
   
   @RestController
   public class WebhookController {
       @PostMapping("/callback")
       public ResponseEntity<String> receiveWebhook(@RequestBody String payload) {
           // Process the payload, such as logging or performing business logic.
           System.out.println("Received webhook payload: " + payload);
           // Return a success response.
           return ResponseEntity.ok("Webhook received");
       }
   }

2. Create a subscription policy

   1. Log on to the CloudMonitor console.

   2. In the left-side navigation pane, choose Event Center > Event Subscription.

   3. On the Subscription Policy tab, click Create Subscription Policy.

   4. On the Create Subscription Policy page, configure the parameters.

      Take note of the following parameters, which are required to subscribe to spot instance interruption events. For information about other parameters, see Manage event subscription policies (recommended).

      • Basic information: Enter a name and description for the subscription policy.

      • Alarm subscription:

        • Subscription Type: Select System Events.

        • Subscription Scope:

        • Products: Select Elastic Compute Service (ECS).

        • Event Type: Select Status Notification.

        • Event Name: Select Instance:PreemptibleInstanceInterruption.

        • Event Level: Select Warning (Warning).

        • Application group, Event Content, and Event Resources: Leave the parameters empty, which indicates that you subscribe to the Instance:PreemptibleInstanceInterruption system events of all ECS instances in all application groups that belong to the current account.

      • Combined Noise Reduction: Use the default settings.

      • Notification: For the Custom Notification Method parameter, use the default settings.

      • Push and Integration: Click Add Channel. In the dialog box that appears, click Increase Channels. In the Create Push Channel panel, set the Target type parameter to the push channel that you created in Step 1. Then, follow the on-screen instructions to configure the other parameters. For information about push channels, see Manage push channels.

3. Simulate a spot instance interruption event

   Spot instance interruption events are triggered events. When you develop an interruption event handler for a spot instance, you cannot debug the code. You can use the Debug Event Subscription feature of CloudMonitor to simulate a spot instance interruption event.

   1. On the Subscription Policy tab, click Debug Event Subscription.

   2. In the Create Event Debugging panel, set the Products parameter to Elastic Compute Service (ECS) and the Name parameter to Instance:PreemptibleInstanceInterruption.

      CloudMonitor automatically generates the debugging content in the JSON format. Replace the resource information in the debugging content with the information of the spot instance for which you want to simulate an interruption event.

      • Replace the <Alibaba Cloud account ID> variable with the ID of your Alibaba Cloud account.

      • Replace the <resource-id> and <instanceId> variables with the ID of the spot instance.

      • Replace the <Region ID> variable with the region ID of the spot instance.

        {
            "product": "ECS",
            "resourceId": "acs:ecs:cn-shanghai:<Alibaba Cloud account ID>UID:instance/<resource-id>",
            "level": "WARN",
            "instanceName": "instanceName",
            "regionId": "<Region ID>",
            "groupId": "0",
            "name": "Instance:PreemptibleInstanceInterruption",
            "content": {
                "instanceId": "i-2zeg014dfo4y892z***",
                "instanceName": "wor***b73",
                "action": "delete"
            },
            "status": "Normal"
        }

   3. Click OK.

      The Operation successful message appears. CloudMonitor automatically sends a test alert notification based on the notification methods specified in the subscription policy.

4. Receive and view alert notifications for spot instance interruption events

   Function Compute

   1. Log on to the Function Compute console. In the left-side navigation pane, click Services & Functions.

   2. In the top navigation bar, select a region. On the Services page, find the service that you want to manage and click Functions in the Actions column.

   3. On the Functions page, click the name of the function that you want to manage. On the Function Details page, click the Logs tab.

   SMQ

   1. Log on to the SMQ console. In the left-side navigation pane, choose Queue Model > Queues.

   2. In the top navigation bar, select a region. On the Queues page, find the queue that you want to manage and click Send Messages in the Action column.

   3. (Optional) In the Receive Message section of the Quick Experience page, click Edit Parameters of Receiving Messages. In the Edit Parameters of Receiving Messages panel, configure the Receive Times and Polling Period parameters and click OK.

   4. On the Quick Experience page, click Receive Message. A list of messages appears in the Receive Message section.

   5. (Optional) Find a message in the message list and click Details in the Actions column. In the Message Details dialog box, view the information about the message, such as the message content.

   Webhook

   View the invocation logs of the webhook service and the alert notifications pushed to the service.