Sets up and enables Cost Intelligence functionality on a Spot account. The Spot account must already have credentials and be linked to a valid cloud provider account (e.g. AWS account, Azure subscription, etc).
Returns all instances types that match the given filters. These instance types will be used if the cluster is configured with these filters.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-12345abc
Identifier of the Ocean cluster.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
required
object (InstanceTypesFilters)
List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
@@ -2806,12 +2825,12 @@
virtualizationTypes
Array of strings
Items Enum:"hvm""paravirtual"
The filtered instance types will support at least one of the virtualization types from this list.
Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately and run it in defined batches.
+
Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately and run it in defined batches.
Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
@@ -2844,12 +2863,12 @@
respectPdb
boolean
Default: false
During the roll, if the parameter is set to true we honor PDB during the instance replacement.
Provides Kubernetes cluster resource usage and costs over a time interval which can be grouped and/or filtered by label/annotaion. For example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).
+
Provides Kubernetes cluster resource usage and costs over a time interval which can be grouped and/or filtered by label/annotaion. For example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).
The response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation. Within the group, resource costs are broken down per resource kind (Deployment, DaemonSet etc.).
Time Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call. For example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
@@ -2890,7 +2909,7 @@
startTime
required
string
Beginning date value using either the date format "yyyy-MM-dd'T'HH:mm:ss'Z'" or ms "1494751821472".
Provides Kubernetes cluster summary usage and costs over a time interval which can be grouped and/or filtered by label/annotaion, for example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).
+
Provides Kubernetes cluster summary usage and costs over a time interval which can be grouped and/or filtered by label/annotaion, for example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).
The response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation.
Time Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call. For example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
@@ -2901,7 +2920,7 @@
startTime
required
string
Beginning date value using either the date format "yyyy-MM-dd'T'HH:mm:ss'Z'" or ms "1494751821472".
Update the Ocean EKS cluster's VNGs with the latest image or the image matching the control plane's version after upgrading, by specifying ‘patch' or 'minorVersion’.
+
Update the Ocean EKS cluster's VNGs with the latest image or the image matching the control plane's version after upgrading, by specifying ‘patch' or 'minorVersion’.
Performing this request will update the VNGs with new AMI if available, and run a cluster roll if set.
If the response is successful, the old and new AMIs will be included in the response along with the updated VNGs.
If a cluster roll is set in the request, the first response for a successful request will indicate the start of a roll.
@@ -2914,7 +2933,7 @@
patch
boolean
Default: false
When set to 'true', the auto-update process will update the VNGs’ images with the latest security patches. Either "patch" or "minorVersion" must be true.
Instance Types Filters Simulation For Virtual Node Group
Returns all instance types that match the given filters. These instance types will be used if the Virtual Node Group is configured with these filters.
Authorizations:
auth
path Parameters
launchSpecId
required
string
Ocean cluster Virtual Node Group identifier.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
required
object (InstanceTypesFilters)
List of instance types filters. The instance types that match with all filters compose the Virtual Node Group's instanceTypes parameter. The architectures that come from the Virtual Node Group's images will be taken into account when using this parameter. Cannot be configured together with Virtual Node Group's instanceTypes and with the Cluster's whitelist/blacklist/filters.
@@ -3030,12 +3049,12 @@
virtualizationTypes
Array of strings
Items Enum:"hvm""paravirtual"
The filtered instance types will support at least one of the virtualization types from this list.
Returns an Ocean Virtual Node Group (VNG) configuration in a given AWS autoscaling group (ASG). The returned value ("Imported VNG") can then be used as input to the Create Virtual Node Group API in order to create an actual VNG in your Ocean cluster.
Returns an Ocean Virtual Node Group (VNG) configuration in a given AWS autoscaling group (ASG). The returned value ("Imported VNG") can then be used as input to the Create Virtual Node Group API in order to create an actual VNG in your Ocean cluster.
Import EKS Cluster Node Group To Ocean Virtual Node Group
Returns an Ocean Virtual Node Group (VNG) configuration based on a given AWS EKS Cluster Node Group.
The returned value ("Imported VNG") can then be used as input to the Create Virtual Node Group API in order to create an actual VNG in your Ocean cluster.
Notes:
Make sure to have the necessary permissions in your Spot policy: eks:ListNodegroups, eks:DescribeNodegroup.
@@ -3065,14 +3084,14 @@
Create Ocean cluster object from an existing ECS cluster with at least one container instance to be used as input for create cluster. Import the configuration from the latest instance id launched with in the cluster (out of the first batch of 100 instances ECS returns). This route will not register the ECS cluster to Ocean.
Create Ocean cluster object from an existing ECS cluster with at least one container instance to be used as input for create cluster. Import the configuration from the latest instance id launched with in the cluster (out of the first batch of 100 instances ECS returns). This route will not register the ECS cluster to Ocean.
Authorizations:
auth
path Parameters
EcsClusterName
required
string
Example: ecsName
ECS Cluster name
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
instanceId
string
Indicate the container instance id that the configuration will be taken from. This is an optional field
Returns all instances types that match the given filters. These instance types will be used if the cluster is configured with these filters.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-12345abc
Identifier of the Ocean cluster.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
required
object (InstanceTypesFilters)
List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
@@ -3226,17 +3245,17 @@
virtualizationTypes
Array of strings
Items Enum:"hvm""paravirtual"
The filtered instance types will support at least one of the virtualization types from this list.
Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately according to defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API using the roll identifier.
Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately according to defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API using the roll identifier.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-12345abc
Identifier of the Ocean cluster.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
One of
object
batchMinHealthyPercentage
integer
Default: 50
Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
@@ -3244,12 +3263,12 @@
comment
string
Add a brief description for the roll. The comment is limited to 256 chars.
Import a Fargate service into an existing Ocean ECS cluster.
Upon Fargate service import, Spot clones the selected Fargate services and runs them with the same VPC & Subnet settings on EC2 spot Instances.
Ocean will automatically and seamlessly predict and replace spot instances before they are interrupted, ensuring the uptime of the cluster and providing cost-savings of up to 90% over Fargate-enabled ECS clusters.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-12345abc
Identifier of the Ocean cluster.
@@ -3358,17 +3377,17 @@
simpleNewServiceNames
boolean
Default: false
Flag to align imported service names in the following format: sfm_
This API copies the configuration from a Fargate service into the corresponding fields of an Ocean object.
(This process is commonly referred to as importing.)
The API returns an Ocean object that is suitable for use in the Create API to create a new Ocean cluster based on your Fargate configuration.
If you are migrating a Fargate service that has tags, you must run the Opt In procedure on your Amazon account or IAM role.
@@ -3392,7 +3411,7 @@
Provides Ecs cluster resource usage and costs over a time interval which can be grouped and/or filtered by AWS tags, for example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).
+
Provides Ecs cluster resource usage and costs over a time interval which can be grouped and/or filtered by AWS tags, for example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).
The response will group the cluster usage costs based on the preselected default of Ecs Group Type which is composed of Service, Headroom, Custom Object,
Idle and Standalone, or user selected AWS tags. Within the default grouping, costs are broken down for the Service group, and for tag grouping the costs will be broken up by tag value.
Time Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call. For example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.
@@ -3404,7 +3423,7 @@
startTime
required
string
Beginning date value using either the date format "yyyy-MM-dd'T'HH:mm:ss'Z'" or ms "1494751821472".
The Ocean Controller is used to monitor the cluster resources and report back to Ocean.|
To install the Ocean Controller, complete and run the following script on a machine with the kubectl command line tool installed and configured:
#!/usr/bin/env bash
@@ -3451,21 +3470,21 @@
object (Ocean GKE Scheduling)
Schedule an action such as a planned shutdown or a cluster roll.
All Ocean parameters are updatable, excluding the Name and controllerClusterId. This API supports partial updates, so specific fields can be updated separately.
All Ocean parameters are updatable, excluding the Name and controllerClusterId. This API supports partial updates, so specific fields can be updated separately.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
required
object
The specification of the Ocean cluster.
@@ -3475,12 +3494,12 @@
object (Ocean GKE Scheduling)
Schedule an action such as a planned shutdown or a cluster roll.
Provides Kubernetes cluster resource usage and costs over a time interval which can be grouped and/or filtered by label/annotaion. For example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory) and storage.
+
Provides Kubernetes cluster resource usage and costs over a time interval which can be grouped and/or filtered by label/annotaion. For example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory) and storage.
The response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation. Within the group, resource costs are broken down per resource kind (Deployment, DaemonSet etc.).
Time Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call. For example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
@@ -3518,7 +3537,7 @@
startTime
required
string
Beginning date value using either the date format "yyyy-MM-dd'T'HH:mm:ss'Z'" or ms "1494751821472".
Provides Kubernetes cluster summary usage and costs over a time interval which can be grouped and/or filtered by label/annotaion, for example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).
+
Provides Kubernetes cluster summary usage and costs over a time interval which can be grouped and/or filtered by label/annotaion, for example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).
The response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation.
Time Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call. For example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
@@ -3529,7 +3548,7 @@
startTime
required
string
Beginning date value using either the date format "yyyy-MM-dd'T'HH:mm:ss'Z'" or ms "1494751821472".
Returns all instances types that match the given filters. These instance types will be used if the cluster is configured with these filters.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-12345abc
Identifier of the Ocean cluster.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
required
object (InstanceTypesFilters)
List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
Returns an Ocean Virtual Node Group (VNG) configuration based on a given GCP GKE Cluster Node Pool. The returned value ("Imported VNG") can then be used as input to the Create VNG API in order to create an actual VNG in your Ocean cluster.
Returns an Ocean Virtual Node Group (VNG) configuration based on a given GCP GKE Cluster Node Pool. The returned value ("Imported VNG") can then be used as input to the Create VNG API in order to create an actual VNG in your Ocean cluster.
Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceNames. Performing this request will start the roll immediately, and the roll will take place according to defined batches.
Note that the first response for a successful request will notify about the start of a roll. In order to check the status of a roll, you can use the GET Cluster Roll API using the roll identifier.
Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceNames. Performing this request will start the roll immediately, and the roll will take place according to defined batches.
Note that the first response for a successful request will notify about the start of a roll. In order to check the status of a roll, you can use the GET Cluster Roll API using the roll identifier.
Authorizations:
auth
path Parameters
oceanId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
object
Settings for roll operation
@@ -3627,12 +3646,12 @@
respectPdb
boolean
Default: false
During the roll, if the parameter is set to true we honor PDB during the instance replacement.
Prerequisites | Perform the following validations prior to upgrade executions: | * Group identifier cannot be null. * Group identifier exists in Elastigroup. * Group should be a GKE Elastigroup with defined scaling policy. * Group identifier is already managed by Ocean.
Prerequisites | Perform the following validations prior to upgrade executions: | * Group identifier cannot be null. * Group identifier exists in Elastigroup. * Group should be a GKE Elastigroup with defined scaling policy. * Group identifier is already managed by Ocean.
Returns an Ocean Cluster configuration, and optionally Virtual Node Group (VNG) configurations based on a given GKE Cluster and its Node Pools. The returned values ("Imported Cluster/VNGs") can then be used as inputs to the Create Cluster/VNG APIs in order to create the respectful resources.
Returns an Ocean Cluster configuration, and optionally Virtual Node Group (VNG) configurations based on a given GKE Cluster and its Node Pools. The returned values ("Imported Cluster/VNGs") can then be used as inputs to the Create Cluster/VNG APIs in order to create the respectful resources.
Authorizations:
auth
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
clusterName
required
string
Example: clusterName=test-gke
Name of the GKE Cluster.
includeLaunchSpecs
boolean
Default: true
Example: includeLaunchSpecs=true
When set to "true", GKE cluster node pools will be imported to Ocean custom VNG ("customLaunchSpec") configurations.
The Import Cluster API call returns a JSON formatted Ocean cluster specification for a given AKS cluster and import identifier.
The returned specification is ready to use in the Ocean AKS Cluster Create API call.
Authorizations:
auth
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
aksClusterName
required
string
Example: aksClusterName=test-cluster
The name of the aks cluster.
resourceGroupName
required
string
Example: resourceGroupName=test-clust_group
The name of the resource group of the AKS cluster.
Object specifying the automatic scaling of an Ocean VNG.
availabilityZones
Array of strings
An Array holding Availability Zones, this configures the availability zones the Ocean may launch nodes in per VNG. Select zone 0 if you have a workload that requires no availability zone redundancy (AZ=null). You can select this option either alone or together with other availability zones. In case zone 0 is selected together with other availability zones, nodes of zone 0 will be scaled only for workloads that demand it.
The Import Ocean Virtual Node Group (VNG) returns a JSON formatted Ocean Virtual Node Group specification based on a given AKS Node Pool.
The returned specification is ready to use in the Ocean AKS Virtual Node Group Create API call.
Roll an entire Ocean cluster or roll subsets of the cluster by specifying vngIds, nodePoolNames or nodeNames. Performing this request will start the roll immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API.
Roll an entire Ocean cluster or roll subsets of the cluster by specifying vngIds, nodePoolNames or nodeNames. Performing this request will start the roll immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
One of
batchMinHealthyPercentage
integer
Default: 50
Indicates the threshold of minimum healthy nodes in single batch. If the amount of healthy nodes in single batch is under the threshold, the roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
@@ -3875,31 +3894,31 @@
respectRestrictScaleDown
boolean
Default: false
During the roll, if the parameter is set to true we honor Restrict Scale Down label during the nodes replacement.
Migrate to ocean workloads that run on unmanaged nodes by specifying nodePoolNames or nodeNames. Performing this request will start the migration immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a migration. In order to check the status of a migration, you can use the GET migration API.
Migrate to ocean workloads that run on unmanaged nodes by specifying nodePoolNames or nodeNames. Performing this request will start the migration immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a migration. In order to check the status of a migration, you can use the GET migration API.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
One of
batchMinHealthyPercentage
integer [ 1 .. 100 ]
Default: 50
Indicates the threshold of minimum healthy nodes in single batch. If the amount of healthy nodes in single batch is under the threshold, the migration will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
@@ -3912,25 +3931,25 @@
shouldTerminateNodes
boolean
Default: true
If the parameter is set to true we will terminate the node after the migration has finished successfully. If the parameter is set to false we will leave the nodes. example: true
Update the Ocean AKS cluster's VNGs with the latest version of the control plane's version after upgrading by specifying the scope. Performing this request will update the VNGs with a new version if available and run a cluster roll if set. If the response is successful, the old and new versions will be included in the response along with the updated VNGs. If a cluster roll is set in the request, the first response for a successful request will indicate the start of a roll. In order to check the status of the roll, you can use the GET Roll API.
Update the Ocean AKS cluster's VNGs with the latest version of the control plane's version after upgrading by specifying the scope. Performing this request will update the VNGs with a new version if available and run a cluster roll if set. If the response is successful, the old and new versions will be included in the response along with the updated VNGs. If a cluster roll is set in the request, the first response for a successful request will indicate the start of a roll. In order to check the status of the roll, you can use the GET Roll API.
Provides Kubernetes cluster resource usage and costs over a time interval which can be grouped and/or filtered by label/annotaion, for example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory) and storage.
+
Provides Kubernetes cluster resource usage and costs over a time interval which can be grouped and/or filtered by label/annotaion, for example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory) and storage.
The response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation. Within the group, resource costs are broken down per resource kind (Deployment, DaemonSet etc.).
Time Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call. For example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
@@ -3969,7 +3988,7 @@
startTime
required
string
Beginning date value using either the date format "yyyy-MM-dd'T'HH:mm:ss'Z'" or ms "1494751821472".
Provides Kubernetes cluster summary usage and costs over a time interval which can be grouped and/or filtered by label/annotaion, for example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).
+
Provides Kubernetes cluster summary usage and costs over a time interval which can be grouped and/or filtered by label/annotaion, for example - application name (webapp, backend), environment (production, staging), version etc. The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).
The response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation.
Time Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call. For example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.
Authorizations:
auth
path Parameters
oceanClusterId
required
string
Example: o-abcd1234
Identifier of the Ocean cluster.
@@ -3980,7 +3999,7 @@
startTime
required
string
Beginning date value using either the date format "yyyy-MM-dd'T'HH:mm:ss'Z'" or ms "1494751821472".
Insights allows Spot users on AWS to connect a Kubernetes cluster and within minutes get the cluster analyzed with insights
about the current state of infrastructure in the cluster, and the potential effect of migrating the specific cluster into Ocean.
Through its powerful features, Ocean presents significant opportunities for infrastructure optimization and automation, which are on display in the Insights console.
Connected to Kubernetes clusters and running a continuous analysis, Ocean Insights delivers a holistic picture of your cluster and workloads behavior, from expected cloud costs and resource utilization.
@@ -4001,21 +4020,21 @@
Ocean CD is a fully managed continuous delivery ('CD') solution for Kubernetes applications. Designed for end-to-end automation and verification of frequent application-deployment processes at scale.
+
Ocean CD is a fully managed continuous delivery ('CD') solution for Kubernetes applications. Designed for end-to-end automation and verification of frequent application-deployment processes at scale.
Ocean CD architecture and API enable a simple and secured installation that seamlessly fits into any Kubernetes environment. Users get key features like granular visibility, SaaS logic that manage the rollout process, verifications of the applied workloads and automatic rollbacks.
To enable Ocean CD, install the controller with one simple command in the Kubernetes cluster and create the following entities using the API:
Hosts all of the supported service meshes needed to enable more fine-grained traffic routing. In case SpotDeployments contains more than one SpotDeployment the traffic manager may not be configured
Full update Ocean CD Rollout Spec configuration.
All non included fields will be nullified
Authorizations:
auth
path Parameters
rolloutSpecName
required
string
Example: app-rolloutspec
The identifier name of the Ocean CD Rollout Spec
Request Body schema: application/json
required
object (Ocean CD Rollout Spec)
Ocean CD rollout spec entity
@@ -4150,7 +4169,7 @@
object (Ocean CD Rollout Spec Traffic)
Hosts all of the supported service meshes needed to enable more fine-grained traffic routing. In case SpotDeployments contains more than one SpotDeployment the traffic manager may not be configured
Partial update Ocean CD Rollout Spec configuration.
Authorizations:
auth
path Parameters
rolloutSpecName
required
string
Example: app-rolloutspec
The identifier name of the Ocean CD Rollout Spec
Request Body schema: application/json
required
object (Ocean CD Rollout Spec)
Ocean CD rollout spec entity
object (Ocean CD Rollout Spec Failure Policy)
Holds information on how to react when failure happens
@@ -4160,7 +4179,7 @@
object (Ocean CD Rollout Spec Traffic)
Hosts all of the supported service meshes needed to enable more fine-grained traffic routing. In case SpotDeployments contains more than one SpotDeployment the traffic manager may not be configured
Ocean for Apache Spark is a managed cloud-native Spark platform that can be deployed in your cloud account.
Running on top of Ocean, Spot’s serverless infrastructure engine for containers, Ocean Spark makes it easy for your data teams to be successful with Apache Spark on Kubernetes, without dealing with the complexity of managing servers.
Removing a cluster will disconnect it from Ocean for Spark. This action is permanent and cannot be undone.
The Ocean for Spark resources will be uninstalled from the cluster, but the Ocean cluster itself (and related Kubernetes resources) will not be deleted.
Authorizations:
auth
path Parameters
clusterId
required
string (oceanSparkClusterId)
Example: osc-20fac3f1
A unique identifier for the Ocean Spark cluster
@@ -4299,30 +4318,30 @@
object (oceanSparkClusterConfigWebhook)
The object specifying the Ocean Spark Webhook configuration.
Aggregates the number of apps reaching a terminal state (completed, failed, killed, ...) within time buckets.
Authorizations:
auth
path Parameters
clusterId
required
string (oceanSparkClusterId)
Example: osc-20fac3f1
A unique identifier for the Ocean Spark cluster
query Parameters
accountId
string
Example: accountId=act-123456789
The ID of the account associated with your token. If omitted the oldest account in the organization will be used.
since
required
string <date-time>
Example: since=2021-11-22
Date at which to start the analysis. If the time range up to now is less or equal to a day, values are reported grouped per hours. Otherwise, values are reported grouped per days.
Reports the number of applications in pending and running state within time buckets.
Authorizations:
auth
path Parameters
clusterId
required
string (oceanSparkClusterId)
Example: osc-20fac3f1
A unique identifier for the Ocean Spark cluster
query Parameters
accountId
string
Example: accountId=act-123456789
The ID of the account associated with your token. If omitted the oldest account in the organization will be used.
since
required
string <date-time>
Example: since=2021-11-22
Date at which to start the analysis. If the time range up to now is less or equal to a day, values are reported grouped per hours. Otherwise, values are reported grouped per days.
Returns a summary of the cluster usage since a given date in the past.
Authorizations:
auth
path Parameters
clusterId
required
string (oceanSparkClusterId)
Example: osc-20fac3f1
A unique identifier for the Ocean Spark cluster
query Parameters
accountId
string
Example: accountId=act-123456789
The ID of the account associated with your token. If omitted the oldest account in the organization will be used.
since
required
string <date-time>
Example: since=2021-11-22
Date at which to start the analysis. If the time range up to now is less or equal to a day, values are reported grouped per hours. Otherwise, values are reported grouped per days.
Create a new Stateful Elastigroup – this Elastigroup will have the same configuration and state of the imported instance.
Authorizations:
auth
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
required
object
Array of objects
An Array holding an object of availabilityZones, this configures the availability zones the group may launch instances in. If this is not passed, the availability zone configuration is taken from the imported instance. Note: This field must be null if statefulMigrationGroup.shouldKeepPrivateIp is true, and must have a minimum of one availability zone.
name
required
string
Specify the new Elastigroup name.
@@ -4710,45 +4729,45 @@
spotInstanceTypes
Array of strings
An Array holding the types of instances to be used in the Elastigroup.
You can fetch a group's (Elastigroup/Ocean/Stateful Node) elastilog via the Spot API, in order to be able to consume elastilog from various tools used for log storing and analyzing. Logs have retention of 3 months back, so minimal fromDate should be up to 3 months back at runtime.
You can fetch a group's (Elastigroup/Ocean/Stateful Node) elastilog via the Spot API, in order to be able to consume elastilog from various tools used for log storing and analyzing. Logs have retention of 3 months back, so minimal fromDate should be up to 3 months back at runtime.
Authorizations:
auth
path Parameters
groupId
required
string
Example: sig-12345
The Spot Elastigroup ID you want to update
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
fromDate
required
string
Example: fromDate=1540036800000
Epoch number that represents the date from which to collect the log (millisecond format)
@@ -4758,7 +4777,7 @@
toDate
required
string
Example: toDate=1542715200000
Epoch number that represents the date until which log is collected (millisecond format)
The names of the processes that will be suspended. Valid values are: AUTO_SCALE, AUTO_HEALING, OUT_OF_STRATEGY, PREVENTIVE_REPLACEMENT, REVERT_PREFERRED, SCHEDULING
The list of processes to remove from suspension. Valid values are: AUTO_SCALE, AUTO_HEALING, OUT_OF_STRATEGY, PREVENTIVE_REPLACEMENT, REVERT_PREFERRED, SCHEDULING
"description": "Imported from auto scaling group TESTING_ASG",
"capacity": {
"target": 1,
"minimum": 0,
"maximum": 5,
"unit": "instance"
},
"strategy": {
"risk": 100,
"drainingTimeout": 0
},
"compute": {
"instanceTypes": {
"ondemand": "m3.medium",
"spot": [
"c3.large"
]
},
"availabilityZones": [
{
"name": "us-west-2b",
"subnetIds": "subnet-2e967065"
}
],
"product": "Linux/UNIX",
"launchSpecification": {
"loadBalancersConfig": {
"loadBalancers": {
"name": "TESTING_ASG",
"type": "CLASSIC"
}
},
"healthCheckType": "EC2",
"healthCheckGracePeriod": 600,
"securityGroupIds": [
"sg-451f8b3a"
],
"monitoring": false,
"imageId": "ami-485eef30",
"ebsOptimized": true,
"blockDeviceMappings": [
{
"deviceName": "/dev/sda1",
"ebs": {
"deleteOnTermination": true,
"volumeSize": 30,
"volumeType": "gp2"
}
}
]
}
},
"scaling": { },
"createdAt": "2020-10-01T05:23:59.302Z",
"updatedAt": "2020-10-01T05:23:59.302Z"
}
],
"count": 1
}
}
Instance Type By Region
Get the available spot instances types available in a specific region
Authorizations:
auth
query Parameters
region
required
string
Example: region=us-east-2
The AWS region
Responses
https://api.spotinst.io/aws/ec2/spotType
Response samples
200
Content type
application/json
{
"request": {
"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/aws/ec2/spotType?region=us-west-2",
"method": "GET",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:spot:type",
"items": [
[
{
"instanceType": "hi1.4xlarge"
},
{
"instanceType": "r5d.4xlarge"
},
{
"instanceType": "r5ad.12xlarge"
},
{
"instanceType": "r4.4xlarge"
},
{
"instanceType": "m1.xlarge"
},
{
"instanceType": "a1.4xlarge"
},
{
"instanceType": "m5a.4xlarge"
},
{
"instanceType": "m3.large"
},
{
"instanceType": "x1e.4xlarge"
},
{
"instanceType": "m5d.4xlarge"
},
{
"instanceType": "m5a.24xlarge"
},
{
"instanceType": "m5a.large"
},
{
"instanceType": "r5d.8xlarge"
},
{
"instanceType": "m3.medium"
},
{
"instanceType": "p2.xlarge"
},
{
"instanceType": "m4.large"
},
{
"instanceType": "m5.24xlarge"
},
{
"instanceType": "r5a.4xlarge"
},
{
"instanceType": "c5.large"
},
{
"instanceType": "m5ad.xlarge"
},
{
"instanceType": "m5d.large"
},
{
"instanceType": "r5d.12xlarge"
},
{
"instanceType": "r5a.2xlarge"
},
{
"instanceType": "m3.2xlarge"
},
{
"instanceType": "t3a.large"
},
{
"instanceType": "t2.medium"
},
{
"instanceType": "i3.2xlarge"
},
{
"instanceType": "p3.2xlarge"
},
{
"instanceType": "cc2.8xlarge"
},
{
"instanceType": "i3.xlarge"
},
{
"instanceType": "r3.2xlarge"
},
{
"instanceType": "i3.8xlarge"
},
{
"instanceType": "c4.8xlarge"
},
{
"instanceType": "r5.metal"
},
{
"instanceType": "m4.10xlarge"
},
{
"instanceType": "m1.large"
},
{
"instanceType": "r5d.2xlarge"
},
{
"instanceType": "t1.micro"
},
{
"instanceType": "i2.4xlarge"
},
{
"instanceType": "r5a.24xlarge"
},
{
"instanceType": "z1d.2xlarge"
},
{
"instanceType": "r5.xlarge"
},
{
"instanceType": "m5ad.large"
},
{
"instanceType": "h1.4xlarge"
},
{
"instanceType": "m5d.12xlarge"
},
{
"instanceType": "c5.2xlarge"
},
{
"instanceType": "x1e.8xlarge"
},
{
"instanceType": "d2.8xlarge"
},
{
"instanceType": "r5.8xlarge"
},
{
"instanceType": "c3.large"
},
{
"instanceType": "r4.xlarge"
},
{
"instanceType": "m5ad.24xlarge"
},
{
"instanceType": "t3a.xlarge"
},
{
"instanceType": "d2.4xlarge"
},
{
"instanceType": "c5.24xlarge"
},
{
"instanceType": "c5.metal"
},
{
"instanceType": "c1.medium"
},
{
"instanceType": "m1.medium"
},
{
"instanceType": "g3.8xlarge"
},
{
"instanceType": "r4.2xlarge"
},
{
"instanceType": "i3en.6xlarge"
},
{
"instanceType": "t3.small"
},
{
"instanceType": "i3en.large"
},
{
"instanceType": "i3en.24xlarge"
},
{
"instanceType": "t2.xlarge"
},
{
"instanceType": "t3a.medium"
},
{
"instanceType": "m4.16xlarge"
},
{
"instanceType": "x1.32xlarge"
},
{
"instanceType": "r5a.12xlarge"
},
{
"instanceType": "c5d.4xlarge"
},
{
"instanceType": "i3en.12xlarge"
},
{
"instanceType": "c5d.large"
},
{
"instanceType": "g3.16xlarge"
},
{
"instanceType": "c3.2xlarge"
},
{
"instanceType": "x1e.2xlarge"
},
{
"instanceType": "a1.2xlarge"
},
{
"instanceType": "r5ad.xlarge"
},
{
"instanceType": "m5a.xlarge"
},
{
"instanceType": "t2.large"
},
{
"instanceType": "r5ad.large"
},
{
"instanceType": "i3.metal"
},
{
"instanceType": "t3.nano"
},
{
"instanceType": "r5ad.2xlarge"
},
{
"instanceType": "f1.16xlarge"
},
{
"instanceType": "h1.8xlarge"
},
{
"instanceType": "m5.12xlarge"
},
{
"instanceType": "a1.medium"
},
{
"instanceType": "i3en.3xlarge"
},
{
"instanceType": "m5d.8xlarge"
}
]
],
"count": 322
}
}
Simulate an Instance Interruption
The simulate instance interruption API is used for simulating a spot interruption in AWS, so that customers can verify specific applicative behaviors in case an interruption takes place. Once the interruption api is called, instances posted in the API body will be terminated in AWS, thus mocking a spot interruption.
+
https://api.spotinst.io/aws/ec2/spotType
Response samples
200
Content type
application/json
{
"request": {
"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/aws/ec2/spotType?region=us-west-2",
"method": "GET",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:spot:type",
"items": [
[
{
"instanceType": "hi1.4xlarge"
},
{
"instanceType": "r5d.4xlarge"
},
{
"instanceType": "r5ad.12xlarge"
},
{
"instanceType": "r4.4xlarge"
},
{
"instanceType": "m1.xlarge"
},
{
"instanceType": "a1.4xlarge"
},
{
"instanceType": "m5a.4xlarge"
},
{
"instanceType": "m3.large"
},
{
"instanceType": "x1e.4xlarge"
},
{
"instanceType": "m5d.4xlarge"
},
{
"instanceType": "m5a.24xlarge"
},
{
"instanceType": "m5a.large"
},
{
"instanceType": "r5d.8xlarge"
},
{
"instanceType": "m3.medium"
},
{
"instanceType": "p2.xlarge"
},
{
"instanceType": "m4.large"
},
{
"instanceType": "m5.24xlarge"
},
{
"instanceType": "r5a.4xlarge"
},
{
"instanceType": "c5.large"
},
{
"instanceType": "m5ad.xlarge"
},
{
"instanceType": "m5d.large"
},
{
"instanceType": "r5d.12xlarge"
},
{
"instanceType": "r5a.2xlarge"
},
{
"instanceType": "m3.2xlarge"
},
{
"instanceType": "t3a.large"
},
{
"instanceType": "t2.medium"
},
{
"instanceType": "i3.2xlarge"
},
{
"instanceType": "p3.2xlarge"
},
{
"instanceType": "cc2.8xlarge"
},
{
"instanceType": "i3.xlarge"
},
{
"instanceType": "r3.2xlarge"
},
{
"instanceType": "i3.8xlarge"
},
{
"instanceType": "c4.8xlarge"
},
{
"instanceType": "r5.metal"
},
{
"instanceType": "m4.10xlarge"
},
{
"instanceType": "m1.large"
},
{
"instanceType": "r5d.2xlarge"
},
{
"instanceType": "t1.micro"
},
{
"instanceType": "i2.4xlarge"
},
{
"instanceType": "r5a.24xlarge"
},
{
"instanceType": "z1d.2xlarge"
},
{
"instanceType": "r5.xlarge"
},
{
"instanceType": "m5ad.large"
},
{
"instanceType": "h1.4xlarge"
},
{
"instanceType": "m5d.12xlarge"
},
{
"instanceType": "c5.2xlarge"
},
{
"instanceType": "x1e.8xlarge"
},
{
"instanceType": "d2.8xlarge"
},
{
"instanceType": "r5.8xlarge"
},
{
"instanceType": "c3.large"
},
{
"instanceType": "r4.xlarge"
},
{
"instanceType": "m5ad.24xlarge"
},
{
"instanceType": "t3a.xlarge"
},
{
"instanceType": "d2.4xlarge"
},
{
"instanceType": "c5.24xlarge"
},
{
"instanceType": "c5.metal"
},
{
"instanceType": "c1.medium"
},
{
"instanceType": "m1.medium"
},
{
"instanceType": "g3.8xlarge"
},
{
"instanceType": "r4.2xlarge"
},
{
"instanceType": "i3en.6xlarge"
},
{
"instanceType": "t3.small"
},
{
"instanceType": "i3en.large"
},
{
"instanceType": "i3en.24xlarge"
},
{
"instanceType": "t2.xlarge"
},
{
"instanceType": "t3a.medium"
},
{
"instanceType": "m4.16xlarge"
},
{
"instanceType": "x1.32xlarge"
},
{
"instanceType": "r5a.12xlarge"
},
{
"instanceType": "c5d.4xlarge"
},
{
"instanceType": "i3en.12xlarge"
},
{
"instanceType": "c5d.large"
},
{
"instanceType": "g3.16xlarge"
},
{
"instanceType": "c3.2xlarge"
},
{
"instanceType": "x1e.2xlarge"
},
{
"instanceType": "a1.2xlarge"
},
{
"instanceType": "r5ad.xlarge"
},
{
"instanceType": "m5a.xlarge"
},
{
"instanceType": "t2.large"
},
{
"instanceType": "r5ad.large"
},
{
"instanceType": "i3.metal"
},
{
"instanceType": "t3.nano"
},
{
"instanceType": "r5ad.2xlarge"
},
{
"instanceType": "f1.16xlarge"
},
{
"instanceType": "h1.8xlarge"
},
{
"instanceType": "m5.12xlarge"
},
{
"instanceType": "a1.medium"
},
{
"instanceType": "i3en.3xlarge"
},
{
"instanceType": "m5d.8xlarge"
}
]
],
"count": 322
}
}
Simulate an Instance Interruption
The simulate instance interruption API is used for simulating a spot interruption in AWS, so that customers can verify specific applicative behaviors in case an interruption takes place. Once the interruption api is called, instances posted in the API body will be terminated in AWS, thus mocking a spot interruption.
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.
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.
Authorizations:
auth
query Parameters
accountId
string
Example: accountId=act-123abc
ID of the account associated with your token
Request Body schema: application/json
instanceId
string
The instance ID the signal refers to.
signal
string
The specific signal you want to trigger. Valid Values - INSTANCE_READY, INSTANCE_READY_TO_SHUTDOWN
Responses
https://api.spotinst.io/aws/ec2/instance/signal
Request samples
Payload
Content type
application/json
{
"instanceId": "i-123456",
"signal": "INSTANCE_READY"
}
Response samples
200
Content type
application/json
{
"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
}
}
}
Instance Standby
Instance Standby enables you to put an instance in Standby state , update or troubleshoot the instance, and then return the instance to service. Instances that are on standby are still part of the Elastigroup, but they don't get application traffic.
+
https://api.spotinst.io/aws/ec2/instance/signal
Request samples
Payload
Content type
application/json
{
"instanceId": "i-123456",
"signal": "INSTANCE_READY"
}
Response samples
200
Content type
application/json
{
"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
}
}
}
Instance Standby
Instance Standby enables you to put an instance in Standby state , update or troubleshoot the instance, and then return the instance to service. Instances that are on standby are still part of the Elastigroup, but they don't get application traffic.
Whenever instance is standby state -
It will be de-registered from all the ELBs / ALBs in the Elastigroup It won't be affected from Scale down activities in the Elastigroup The instance health won't be checked, and it won't be replaced When the instance exits the Standby state -
The instance will be register back to all the ELBs / ALBs that are defined in the Elastigroup It will be considered and affected from all the Elastigroup activities (helth checks, scaling, etc.)
Deploy your Elastigroup (triggers Blue/Green Deployment that replaces the existing instances in the Elastigroup). Note: If configured with health check, the grace period will be ignored
Deploy your Elastigroup (triggers Blue/Green Deployment that replaces the existing instances in the Elastigroup). Note: If configured with health check, the grace period will be ignored
Authorizations:
auth
path Parameters
groupId
required
string
Example: sig-12345
The Spot Elastigroup ID you want to update
query Parameters
accountId
string
Example: accountId=act-123abc
ID of the account associated with your token
Request Body schema: application/json
batchSizePercentage
required
integer
Indicates (in percentage) the batch size of the deployment (meaning, how many instances to replace in each batch)
Initiate a cluster roll for an Elastigroup with ECS cluster
Authorizations:
auth
path Parameters
groupId
required
string
Example: sig-12345
Elastigroup ID
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
required
object
batchMinHealthyPercentage
integer
Default: 50
Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
@@ -4948,77 +4967,77 @@
comment
string
Add a comment description for the roll. comment should be limit to 256 chars.
Get your Beanstalk environment configuration from AWS. This call is typically used as the initial step in importing your existing Beanstalk configuration to an Elastigroup.
Note: To optimize the availability of your Beanstalk workload on Elastigroup, instance types similar to those running in your existing configuration are automatically added to the response under instanceTypes. Should these instance types not meet your requirements you may remove them.
Get your Beanstalk environment configuration from AWS. This call is typically used as the initial step in importing your existing Beanstalk configuration to an Elastigroup.
Note: To optimize the availability of your Beanstalk workload on Elastigroup, instance types similar to those running in your existing configuration are automatically added to the response under instanceTypes. Should these instance types not meet your requirements you may remove them.
Trigger a Blue-Green deployment to your Elastigroup, this will initiate a deployment that will replace the existing instances(blue) with new ones(green).
Trigger a Blue-Green deployment to your Elastigroup, this will initiate a deployment that will replace the existing instances(blue) with new ones(green).
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {
"wrapping": {
"sourceClusterId": "c-1234"
},
"new": {
"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {
"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {
"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {
"ebsRootVolumeSize": 4,
"availabilityZones": [
{
"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [
{
"masterGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [
{
"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": [
"sg-123456789"
],
"additionalSlaveSecurityGroups": [
"sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [
{
"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [
{
"name": "Hue",
"args": [
"string"
],
"version": "1.0"
}
],
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {
"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {
"tasks": [
{
"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {
"up": [
{
"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [
{
"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [
{
"statements": [
{
"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}
Create Scaler
Create a new EMR cluster.
+
https://api.spotinst.io/aws/emr/mrScaler
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"items": [
{
"mrScaler": {
"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {
"wrapping": {
"sourceClusterId": "c-1234"
},
"new": {
"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {
"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {
"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {
"ebsRootVolumeSize": 4,
"availabilityZones": [
{
"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [
{
"masterGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [
{
"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": [
"sg-123456789"
],
"additionalSlaveSecurityGroups": [
"sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [
{
"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [
{
"name": "Hue",
"args": [
"string"
],
"version": "1.0"
}
],
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {
"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {
"tasks": [
{
"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {
"up": [
{
"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [
{
"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [
{
"statements": [
{
"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}
Create Scaler
Create a new EMR cluster.
Authorizations:
auth
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
required
object
object (EMR Cluster Object)
Allowed only when the new strategy is chosen.
object (Compute Object)
describes the compute resources for the MR scaler
@@ -5031,62 +5050,62 @@
Array of objects (Termination Policy Object)
Termination policies for EMR clusters based on CloudWatch Metrics.
Responses
https://api.spotinst.io/aws/emr/mrScaler
Request samples
Payload
Content type
application/json
{
"mrScaler": {
"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {
"wrapping": {
"sourceClusterId": "c-1234"
},
"new": {
"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {
"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {
"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {
"ebsRootVolumeSize": 4,
"availabilityZones": [
{
"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [
{
"masterGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [
{
"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": [
"sg-123456789"
],
"additionalSlaveSecurityGroups": [
"sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [
{
"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [
{
"name": "Hue",
"args": [
"string"
],
"version": "1.0"
}
],
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {
"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {
"tasks": [
{
"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {
"up": [
{
"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [
{
"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [
{
"statements": [
{
"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"items": [
{
"mrScaler": {
"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {
"wrapping": {
"sourceClusterId": "c-1234"
},
"new": {
"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {
"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {
"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {
"ebsRootVolumeSize": 4,
"availabilityZones": [
{
"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [
{
"masterGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [
{
"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": [
"sg-123456789"
],
"additionalSlaveSecurityGroups": [
"sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [
{
"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [
{
"name": "Hue",
"args": [
"string"
],
"version": "1.0"
}
],
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {
"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {
"tasks": [
{
"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {
"up": [
{
"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [
{
"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [
{
"statements": [
{
"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}
Create Scaler Operator
mrScaler – required will have the same configuration as in createMrScaler with one exception:
+
https://api.spotinst.io/aws/emr/mrScaler
Request samples
Payload
Content type
application/json
{
"mrScaler": {
"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {
"wrapping": {
"sourceClusterId": "c-1234"
},
"new": {
"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {
"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {
"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {
"ebsRootVolumeSize": 4,
"availabilityZones": [
{
"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [
{
"masterGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [
{
"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": [
"sg-123456789"
],
"additionalSlaveSecurityGroups": [
"sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [
{
"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [
{
"name": "Hue",
"args": [
"string"
],
"version": "1.0"
}
],
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {
"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {
"tasks": [
{
"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {
"up": [
{
"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [
{
"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [
{
"statements": [
{
"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"items": [
{
"mrScaler": {
"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {
"wrapping": {
"sourceClusterId": "c-1234"
},
"new": {
"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {
"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {
"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {
"ebsRootVolumeSize": 4,
"availabilityZones": [
{
"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [
{
"masterGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [
{
"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": [
"sg-123456789"
],
"additionalSlaveSecurityGroups": [
"sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [
{
"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [
{
"name": "Hue",
"args": [
"string"
],
"version": "1.0"
}
],
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {
"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {
"tasks": [
{
"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {
"up": [
{
"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [
{
"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [
{
"statements": [
{
"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}
Create Scaler Operator
mrScaler – required will have the same configuration as in createMrScaler with one exception:
we will only work with strategy of “new”, no “clone”/”warp” will be allowed.
Authorizations:
auth
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
required
object
name
string
Responses
https://api.spotinst.io/aws/emr/mrScalerOperator
Request samples
Payload
Content type
application/json
{
"name": "GuyEmrOperatorTest",
"mrScaler": {
"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {
"wrapping": {
"sourceClusterId": "c-1234"
},
"new": {
"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {
"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {
"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {
"ebsRootVolumeSize": 4,
"availabilityZones": [
{
"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [
{
"masterGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [
{
"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": [
"sg-123456789"
],
"additionalSlaveSecurityGroups": [
"sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [
{
"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [
{
"name": "Hue",
"args": [
"string"
],
"version": "1.0"
}
],
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {
"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {
"tasks": [
{
"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {
"up": [
{
"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [
{
"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [
{
"statements": [
{
"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"items": [
{
"mrScaler": {
"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {
"wrapping": {
"sourceClusterId": "c-1234"
},
"new": {
"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {
"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {
"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {
"ebsRootVolumeSize": 4,
"availabilityZones": [
{
"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [
{
"masterGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [
{
"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": [
"sg-123456789"
],
"additionalSlaveSecurityGroups": [
"sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [
{
"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [
{
"name": "Hue",
"args": [
"string"
],
"version": "1.0"
}
],
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {
"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {
"tasks": [
{
"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {
"up": [
{
"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [
{
"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [
{
"statements": [
{
"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}
Get Scaler
Get a description of a specific MR Scaler and its configuration.
+
https://api.spotinst.io/aws/emr/mrScalerOperator
Request samples
Payload
Content type
application/json
{
"name": "GuyEmrOperatorTest",
"mrScaler": {
"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {
"wrapping": {
"sourceClusterId": "c-1234"
},
"new": {
"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {
"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {
"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {
"ebsRootVolumeSize": 4,
"availabilityZones": [
{
"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [
{
"masterGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [
{
"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": [
"sg-123456789"
],
"additionalSlaveSecurityGroups": [
"sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [
{
"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [
{
"name": "Hue",
"args": [
"string"
],
"version": "1.0"
}
],
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {
"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {
"tasks": [
{
"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {
"up": [
{
"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [
{
"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [
{
"statements": [
{
"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"items": [
{
"mrScaler": {
"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {
"wrapping": {
"sourceClusterId": "c-1234"
},
"new": {
"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {
"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {
"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {
"ebsRootVolumeSize": 4,
"availabilityZones": [
{
"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {
"file": {
"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [
{
"masterGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {
"instanceTypes": [
"m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {
"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {
"ebsBlockDeviceConfigs": [
{
"volumeSpecification": {
"volumeType": "io1",
"dynamicVolumeSize": {
"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [
{
"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": [
"sg-123456789"
],
"additionalSlaveSecurityGroups": [
"sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [
{
"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [
{
"name": "Hue",
"args": [
"string"
],
"version": "1.0"
}
],
"configurations": [
{
"classification": "mapred-site",
"properties": {
"mapred.tasktracker.map.tasks.maximum": 2
},
"configurations": [
{
"classification": "hadoop-env",
"properties": {
"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {
"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {
"tasks": [
{
"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {
"up": [
{
"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [
{
"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {
"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [
{
"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [
{
"statements": [
{
"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}
Get Scaler
Get a description of a specific MR Scaler and its configuration.
(Applies only if shouldTerminateInstances is on) The draining timeout (in seconds) before terminating the instance. If no draining timeout is defined, the group's draining timeout applies.
@@ -5205,23 +5224,23 @@
shouldTerminateInstances
boolean
Indicates whether to terminate the instances or not.
Deploy the Elastigroup. This triggers a Blue/Green deployment that replaces the existing VMs in the Elastigroup.
Authorizations:
auth
path Parameters
groupId
required
string
Example: sig-12345
The Spot Elastigroup ID you want to update
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
object (groupVmDeployment)
batchMinHealthyPercentage
integer [ 1 .. 100 ]
Default: 50
Indicates the threshold of minimum healthy virtual machines in a single batch. If the amount of healthy virtual machines in a single batch is under the threshold, the deployment will fail. The value of the parameter should represent the number in percentage (%) of the batch.
@@ -5331,64 +5350,64 @@
healthCheckTypes
Array of strings
Items Enum:"vmState""applicationGateway"
Define a health check type. Can be null. If no value is set, the deployment will use the group's auto-healing health check.
The VM signal API is used for notifying Spot about the VM state so that Spot can act accordingly. Supported signals are vmReady – Whenever this signal is sent, Spot will register the instance to the relevant Load Balancer and Application Gateway. vmReadyToShutdown – When this signal is received after a vm is detached; we will immediately terminate the vm. You must define the expected signals for your Elastigroup in the group configuration.
The VM signal API is used for notifying Spot about the VM state so that Spot can act accordingly. Supported signals are vmReady – Whenever this signal is sent, Spot will register the instance to the relevant Load Balancer and Application Gateway. vmReadyToShutdown – When this signal is received after a vm is detached; we will immediately terminate the vm. You must define the expected signals for your Elastigroup in the group configuration.
Authorizations:
auth
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Request Body schema: application/json
resourceGroupName
required
string
This is the resource group of the Elastigroup or Stateful Node.
signalType
required
string
Enum:"vmReady""vmReadyToShutdown"
The specific signal you want to trigger.
vmName
required
string
The virtual machine ID the signal refers to.
Responses
https://api.spotinst.io/azure/compute/vm/signal
Request samples
Payload
Content type
application/json
{
"vmName": "vm-123456",
"signalType": "vmReady",
"resourceGroupName": "TestResourceGroup"
}
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
}
}
}
Virtual Machine Protection
Protect virtual machines in Elastigroup cluster.
+
https://api.spotinst.io/azure/compute/vm/signal
Request samples
Payload
Content type
application/json
{
"vmName": "vm-123456",
"signalType": "vmReady",
"resourceGroupName": "TestResourceGroup"
}
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
}
}
}
Virtual Machine Protection
Protect virtual machines in Elastigroup cluster.
Authorizations:
auth
path Parameters
groupId
required
string
Example: sig-12345
The Spot Elastigroup ID you want to update
vmName
required
string
Example: i-f2a44ba41875
The virtual machine name to protect.
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
ttlInMinutes
integer
Example: ttlInMinutes=180
Specify a TTL (in minutes) for this protection, meaning, for how long the protection will be valid for. (If null, infinite protection)
You can fetch a Elastigroup's Elastilog via the Spot API, in order to be able to consume elastilog from various tools used for log storing and analyzing. Logs have retention of 3 months back from today, so minimal fromDate should be up to 3 months back at runtime.
You can fetch a Elastigroup's Elastilog via the Spot API, in order to be able to consume elastilog from various tools used for log storing and analyzing. Logs have retention of 3 months back from today, so minimal fromDate should be up to 3 months back at runtime.
Authorizations:
auth
path Parameters
groupId
required
string
Example: sig-12345
The Spot Elastigroup ID you want to update
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
fromDate
required
string
Example: fromDate=2020-09-01 or fromDate=1598918400000
Get items on or after this date (ISO 8601 or Unix timestamp)
@@ -5398,7 +5417,7 @@
toDate
required
string
Example: toDate=2020-09-01 or fromDate=1598918400000
Get items on or before this date (ISO 8601 or Unix timestamp)
Stateful Node is a Spot solution for launching and managing a single compute instance.
On the AWS cloud, for a standard single instance workload, an On-Demand EC2 instance is launched.
The instance is expected to be highly available, easily manageable, and integrate well with additional services and monitoring tools.
For more information please review the concepts section.
@@ -5563,11 +5582,11 @@
region
required
string
The AWS region your resource will be created in.
object (MI Scheduling)
object (MI Strategy)
Responses
https://api.spotinst.io/aws/ec2/managedInstance
Request samples
Payload
Content type
application/json
{
"managedInstance": {
"name": "mi-test",
"description": "This is my Stateful Node",
"region": "us-east-1",
"strategy": {
"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": [
"Mon:03:00-Wed:02:30"
],
"revertToSpot": {
"performAt": "timeWindow"
}
},
"compute": {
"subnetIds": [
"subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"volumeAttachments": {
"volumes": [
{
"volumeId": "vol-1234567",
"deviceName": "/dev/sdb"
}
]
},
"launchSpecification": {
"instanceTypes": {
"preferredType": "t2.micro",
"preferredTypes": [
[
"t2.micro",
"t3.micro",
"t2.medium",
"t3.medium"
]
],
"types": [
"t2.micro"
],
"resourceRequirements": {
"requiredGpu": {
"minimum": 1,
"maximum": 16
},
"requiredVCpu": {
"minimum": 1,
"maximum": 64
},
"requiredMemory": {
"minimum": 1,
"maximum": 512
},
"excludedInstanceTypes": [
[
"c4.large"
]
],
"excludedInstanceFamilies": [
[
"A",
"C",
"D"
]
],
"excludedInstanceGenerations": [
[
"1",
"2",
"3"
]
]
}
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {
"name": "name",
"arn": "arn"
},
"securityGroupIds": [
"sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [
{
"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {
"volumes": {
"shouldTag": false
},
"snapshots": {
"shouldTag": true
},
"enis": {
"shouldTag": false
},
"amis": {
"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {
"cpuCredits": "unlimited"
},
"networkInterfaces": [
{
"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [
{
"deviceName": "/dev/xvdcz",
"ebs": {
"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"encrypted": true,
"volumeSize": 12,
"volumeType": "gp2",
"kmsKeyId": "string",
"snapshotId": "string"
}
}
],
"metadataOptions": {
"httpTokens": "optional",
"httpPutResponseHopLimit": "33",
"instanceMetadataTags": "Enabled"
}
}
},
"integrations": {
"loadBalancersConfig": {
"loadBalancers": [
{
"name": "name",
"arn": "arn",
"type": "CLASSIC"
}
]
},
"route53": {
"domains": [
{
"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [
{
"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {
"tasks": [
{
"taskType": "recycle",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
},
"persistence": {
"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {
"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
}
}
}
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"items": [
{
"managedInstance": {
"name": "mi-test",
"description": "This is my Stateful Node",
"region": "us-east-1",
"strategy": {
"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": [
"Mon:03:00-Wed:02:30"
],
"revertToSpot": {
"performAt": "timeWindow"
}
},
"compute": {
"subnetIds": [
"subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"volumeAttachments": {
"volumes": [
{
"volumeId": "vol-1234567",
"deviceName": "/dev/sdb"
}
]
},
"launchSpecification": {
"instanceTypes": {
"preferredType": "t2.micro",
"preferredTypes": [
[
"t2.micro",
"t3.micro",
"t2.medium",
"t3.medium"
]
],
"types": [
"t2.micro"
],
"resourceRequirements": {
"requiredGpu": {
"minimum": 1,
"maximum": 16
},
"requiredVCpu": {
"minimum": 1,
"maximum": 64
},
"requiredMemory": {
"minimum": 1,
"maximum": 512
},
"excludedInstanceTypes": [
[
"c4.large"
]
],
"excludedInstanceFamilies": [
[
"A",
"C",
"D"
]
],
"excludedInstanceGenerations": [
[
"1",
"2",
"3"
]
]
}
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {
"name": "name",
"arn": "arn"
},
"securityGroupIds": [
"sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [
{
"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {
"volumes": {
"shouldTag": false
},
"snapshots": {
"shouldTag": true
},
"enis": {
"shouldTag": false
},
"amis": {
"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {
"cpuCredits": "unlimited"
},
"networkInterfaces": [
{
"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [
{
"deviceName": "/dev/xvdcz",
"ebs": {
"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"encrypted": true,
"volumeSize": 12,
"volumeType": "gp2",
"kmsKeyId": "string",
"snapshotId": "string"
}
}
],
"metadataOptions": {
"httpTokens": "optional",
"httpPutResponseHopLimit": "33",
"instanceMetadataTags": "Enabled"
}
}
},
"integrations": {
"loadBalancersConfig": {
"loadBalancers": [
{
"name": "name",
"arn": "arn",
"type": "CLASSIC"
}
]
},
"route53": {
"domains": [
{
"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [
{
"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {
"tasks": [
{
"taskType": "recycle",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
},
"persistence": {
"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {
"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
}
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:managedInstance"
}
}
List Stateful Nodes
List all Stateful Node resources in the account.
+
https://api.spotinst.io/aws/ec2/managedInstance
Request samples
Payload
Content type
application/json
{
"managedInstance": {
"name": "mi-test",
"description": "This is my Stateful Node",
"region": "us-east-1",
"strategy": {
"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": [
"Mon:03:00-Wed:02:30"
],
"revertToSpot": {
"performAt": "timeWindow"
}
},
"compute": {
"subnetIds": [
"subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"volumeAttachments": {
"volumes": [
{
"volumeId": "vol-1234567",
"deviceName": "/dev/sdb"
}
]
},
"launchSpecification": {
"instanceTypes": {
"preferredType": "t2.micro",
"preferredTypes": [
[
"t2.micro",
"t3.micro",
"t2.medium",
"t3.medium"
]
],
"types": [
"t2.micro"
],
"resourceRequirements": {
"requiredGpu": {
"minimum": 1,
"maximum": 16
},
"requiredVCpu": {
"minimum": 1,
"maximum": 64
},
"requiredMemory": {
"minimum": 1,
"maximum": 512
},
"excludedInstanceTypes": [
[
"c4.large"
]
],
"excludedInstanceFamilies": [
[
"A",
"C",
"D"
]
],
"excludedInstanceGenerations": [
[
"1",
"2",
"3"
]
]
}
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {
"name": "name",
"arn": "arn"
},
"securityGroupIds": [
"sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [
{
"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {
"volumes": {
"shouldTag": false
},
"snapshots": {
"shouldTag": true
},
"enis": {
"shouldTag": false
},
"amis": {
"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {
"cpuCredits": "unlimited"
},
"networkInterfaces": [
{
"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [
{
"deviceName": "/dev/xvdcz",
"ebs": {
"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"encrypted": true,
"volumeSize": 12,
"volumeType": "gp2",
"kmsKeyId": "string",
"snapshotId": "string"
}
}
],
"metadataOptions": {
"httpTokens": "optional",
"httpPutResponseHopLimit": "33",
"instanceMetadataTags": "Enabled"
}
}
},
"integrations": {
"loadBalancersConfig": {
"loadBalancers": [
{
"name": "name",
"arn": "arn",
"type": "CLASSIC"
}
]
},
"route53": {
"domains": [
{
"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [
{
"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {
"tasks": [
{
"taskType": "recycle",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
},
"persistence": {
"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {
"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
}
}
}
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"items": [
{
"managedInstance": {
"name": "mi-test",
"description": "This is my Stateful Node",
"region": "us-east-1",
"strategy": {
"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": [
"Mon:03:00-Wed:02:30"
],
"revertToSpot": {
"performAt": "timeWindow"
}
},
"compute": {
"subnetIds": [
"subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"volumeAttachments": {
"volumes": [
{
"volumeId": "vol-1234567",
"deviceName": "/dev/sdb"
}
]
},
"launchSpecification": {
"instanceTypes": {
"preferredType": "t2.micro",
"preferredTypes": [
[
"t2.micro",
"t3.micro",
"t2.medium",
"t3.medium"
]
],
"types": [
"t2.micro"
],
"resourceRequirements": {
"requiredGpu": {
"minimum": 1,
"maximum": 16
},
"requiredVCpu": {
"minimum": 1,
"maximum": 64
},
"requiredMemory": {
"minimum": 1,
"maximum": 512
},
"excludedInstanceTypes": [
[
"c4.large"
]
],
"excludedInstanceFamilies": [
[
"A",
"C",
"D"
]
],
"excludedInstanceGenerations": [
[
"1",
"2",
"3"
]
]
}
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {
"name": "name",
"arn": "arn"
},
"securityGroupIds": [
"sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [
{
"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {
"volumes": {
"shouldTag": false
},
"snapshots": {
"shouldTag": true
},
"enis": {
"shouldTag": false
},
"amis": {
"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {
"cpuCredits": "unlimited"
},
"networkInterfaces": [
{
"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [
{
"deviceName": "/dev/xvdcz",
"ebs": {
"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"encrypted": true,
"volumeSize": 12,
"volumeType": "gp2",
"kmsKeyId": "string",
"snapshotId": "string"
}
}
],
"metadataOptions": {
"httpTokens": "optional",
"httpPutResponseHopLimit": "33",
"instanceMetadataTags": "Enabled"
}
}
},
"integrations": {
"loadBalancersConfig": {
"loadBalancers": [
{
"name": "name",
"arn": "arn",
"type": "CLASSIC"
}
]
},
"route53": {
"domains": [
{
"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [
{
"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {
"tasks": [
{
"taskType": "recycle",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
},
"persistence": {
"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {
"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
}
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:managedInstance"
}
}
List Stateful Nodes
List all Stateful Node resources in the account.
Authorizations:
auth
query Parameters
accountId
required
string
Example: accountId=act-123456789
The ID of the account associated with your token.
Responses
https://api.spotinst.io/aws/ec2/managedInstance
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"items": [
{
"createdAt": "2020-04-10T21:41:31.000Z",
"updatedAt": "2020-05-12T22:37:18.000Z",
"id": "smi-34ae3a42",
"config": {
"name": "mi-test",
"region": "us-east-1",
"strategy": {
"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": [
"Mon:03:00-Wed:02:30"
],
"revertToSpot": {
"performAt": "timeWindow"
}
},
"persistence": {
"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {
"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
},
"compute": {
"subnetIds": [
"subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"volumeAttachments": {
"volumes": [
{
"volumeId": "vol-1234567",
"deviceName": "/dev/sdb"
}
]
},
"launchSpecification": {
"instanceTypes": {
"preferredType": "t2.micro",
"preferredTypes": [
[
"t2.micro",
"t3.micro",
"t2.medium",
"t3.medium"
]
],
"types": [
"t2.micro"
],
"resourceRequirements": {
"requiredGpu": {
"minimum": 1,
"maximum": 16
},
"requiredVCpu": {
"minimum": 1,
"maximum": 64
},
"requiredMemory": {
"minimum": 1,
"maximum": 512
},
"excludedInstanceTypes": [
[
"c4.large"
]
],
"excludedInstanceFamilies": [
[
"A",
"C",
"D"
]
],
"excludedInstanceGenerations": [
[
"1",
"2",
"3"
]
]
}
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {
"name": "name",
"arn": "arn"
},
"securityGroupIds": [
"sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [
{
"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {
"volumes": {
"shouldTag": false
},
"snapshots": {
"shouldTag": true
},
"enis": {
"shouldTag": false
},
"amis": {
"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {
"cpuCredits": "unlimited"
},
"networkInterfaces": [
{
"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [
{
"deviceName": "/dev/xvdcz",
"ebs": {
"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"encrypted": true,
"volumeSize": 12,
"volumeType": "gp2",
"kmsKeyId": "string",
"snapshotId": "string"
}
}
],
"metadataOptions": {
"httpTokens": "optional",
"httpPutResponseHopLimit": "33",
"instanceMetadataTags": "Enabled"
}
}
},
"integrations": {
"loadBalancersConfig": {
"loadBalancers": [
{
"name": "name",
"arn": "arn",
"type": "CLASSIC"
}
]
},
"route53": {
"domains": [
{
"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [
{
"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {
"tasks": [
{
"taskType": "recycle",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
}
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:managedInstance"
}
}
Update Stateful Node
Update one or more attributes in your Stateful Node.
+
https://api.spotinst.io/aws/ec2/managedInstance
Response samples
200
Content type
application/json
{
"request": {
"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"items": [
{
"createdAt": "2020-04-10T21:41:31.000Z",
"updatedAt": "2020-05-12T22:37:18.000Z",
"id": "smi-34ae3a42",
"config": {
"name": "mi-test",
"region": "us-east-1",
"strategy": {
"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": [
"Mon:03:00-Wed:02:30"
],
"revertToSpot": {
"performAt": "timeWindow"
}
},
"persistence": {
"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {
"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
},
"compute": {
"subnetIds": [
"subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"volumeAttachments": {
"volumes": [
{
"volumeId": "vol-1234567",
"deviceName": "/dev/sdb"
}
]
},
"launchSpecification": {
"instanceTypes": {
"preferredType": "t2.micro",
"preferredTypes": [
[
"t2.micro",
"t3.micro",
"t2.medium",
"t3.medium"
]
],
"types": [
"t2.micro"
],
"resourceRequirements": {
"requiredGpu": {
"minimum": 1,
"maximum": 16
},
"requiredVCpu": {
"minimum": 1,
"maximum": 64
},
"requiredMemory": {
"minimum": 1,
"maximum": 512
},
"excludedInstanceTypes": [
[
"c4.large"
]
],
"excludedInstanceFamilies": [
[
"A",
"C",
"D"
]
],
"excludedInstanceGenerations": [
[
"1",
"2",
"3"
]
]
}
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {
"name": "name",
"arn": "arn"
},
"securityGroupIds": [
"sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [
{
"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {
"volumes": {
"shouldTag": false
},
"snapshots": {
"shouldTag": true
},
"enis": {
"shouldTag": false
},
"amis": {
"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {
"cpuCredits": "unlimited"
},
"networkInterfaces": [
{
"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [
{
"deviceName": "/dev/xvdcz",
"ebs": {
"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"encrypted": true,
"volumeSize": 12,
"volumeType": "gp2",
"kmsKeyId": "string",
"snapshotId": "string"
}
}
],
"metadataOptions": {
"httpTokens": "optional",
"httpPutResponseHopLimit": "33",
"instanceMetadataTags": "Enabled"
}
}
},
"integrations": {
"loadBalancersConfig": {
"loadBalancers": [
{
"name": "name",
"arn": "arn",
"type": "CLASSIC"
}
]
},
"route53": {
"domains": [
{
"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [
{
"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {
"tasks": [
{
"taskType": "recycle",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
}
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:managedInstance"
}
}
Update Stateful Node
Update one or more attributes in your Stateful Node.
This API supports partial updates, so only specific fields can be updated separately.
In order to remove a setting from the instance config, set the object value to null.
For a Full List of the Elastigroup JSON object reference please see Stateful Node Create.
Import multiple stateful instances from AWS into Stateful Node, preserving both instance data and persistence settings.
This call initiates migration for all instances and returns the associated migration IDs.
To check the status of multiple migrations, use the `Get Multiple Instance Migration Status` call.
Note: The response contains a `failures` field. In the event that one or more instances failed to migrate, this field will provide the corresponding resource IDs and error messages. If all migrations were successful, this field will return an empty list.
@@ -5657,7 +5676,7 @@
spotInstanceTypes
Array of strings
List of possible instance types for the Stateful Node
Gets audit events that have response status of 200. This is the default when the responseStatus parameter is not included in the query. When you use responseStatus in the query, you can get all audit events without regard to status.
Gets audit events that have response status of 200. This is the default when the responseStatus parameter is not included in the query. When you use responseStatus in the query, you can get all audit events without regard to status.
The API requires one of the following permissions to be defined in Spot:
Permission: Organization Viewer (See User Roles) or
A Spot Notifications service enables you a fast, flexible, fully managed push notification service that lets you know about major events that happened in your Spot account.ֿ Spot Notifications makes it simple and cost-effective to get push notifications to your email address, HTTP, HTTPS or AWS SNS (Simple Notifications Service).
A Spot Notifications service enables you a fast, flexible, fully managed push notification service that lets you know about major events that happened in your Spot account.ֿ Spot Notifications makes it simple and cost-effective to get push notifications to your email address, HTTP, HTTPS or AWS SNS (Simple Notifications Service).
The endpoint the notification will be sent to. url in case of http/https/web, email address in case of email/email-json and sns-topic-arn in case of aws-sns.
-For example: YOUR@EMAIL.COM or https://YOUR_ENDPOINT.COM or SNS_TOPIC_ARN
The endpoint the notification will be sent to. url in case of http/https/web, email address in case of email/email-json and sns-topic-arn in case of aws-sns
Describe Potential Savings for AWS resources like - ASG (Auto-scaling groups), Beanstalk, ELB, ECS, EMR and tagged instances. The response will provide Potential monthly savings in USD
Describe Potential Savings for AWS resources like - ASG (Auto-scaling groups), Beanstalk, ELB, ECS, EMR and tagged instances. The response will provide Potential monthly savings in USD
Authorizations:
auth
query Parameters
accountId
string
Example: accountId=act-123456789
ID of the account associated with your token
Responses
https://api.spotinst.io/aws/potentialSavings
Response samples
200
Content type
application/json
{
"request": {
"url": "/aws/ec2/group/sig-12345/suspension",
"method": "GET"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"kind": "spotinst:cs:aws:potentialSavings",
"items": [
[
{
"resourceType": "Auto Scaling Group",
"name": "Prod_ASG",
"region": "us-west-1",
"instances": 5,
"instanceTypes": [
"c4.4xlarge"
],
"potentialSavings": 2700
}
]
],
"count": 1
}
}
Instances Potential Savings
Describe potential savings for the listed instances. You can provide multiple instance IDs separated by a comma. The response will provide potential monthly savings in USD.
+
https://api.spotinst.io/aws/potentialSavings
Response samples
200
Content type
application/json
{
"request": {
"url": "/aws/ec2/group/sig-12345/suspension",
"method": "GET"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"kind": "spotinst:cs:aws:potentialSavings",
"items": [
[
{
"resourceType": "Auto Scaling Group",
"name": "Prod_ASG",
"region": "us-west-1",
"instances": 5,
"instanceTypes": [
"c4.4xlarge"
],
"potentialSavings": 2700
}
]
],
"count": 1
}
}
Instances Potential Savings
Describe potential savings for the listed instances. You can provide multiple instance IDs separated by a comma. The response will provide potential monthly savings in USD.
Retrieve costs up to one year back per specified account over a specified time period.
Authorizations:
auth
query Parameters
accountId
string
Example: accountId=act-123456789
ID of the account associated with your token
aggregationPeriod
string
Example: aggregationPeriod=daily
Optional. The time period over which data is aggregated. Can only be "daily". For example, the figures in each data set are per day
fromDate
string
Example: fromDate=2018-06-20
Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472).
@@ -5788,7 +5807,7 @@
*Data is shown until the past day (Does not include today's costs)
Responses
https://api.spotinst.io/aws/costs
Response samples
200
Content type
application/json
{
"request": {
"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/aws/costs",
"method": "GET",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:costs",
"items": [
[
{
"timestamp": "2020-03-06T00:00:00.000Z",
"spot": {
"runningHours": 1470.8,
"actualCosts": 107.3,
"potentialCosts": 378.41,
"savingsPercentage": 71.64
}
}
]
],
"count": 1
}
}
Suggested Instance Type
Get suggested instance types by required resources.
+
https://api.spotinst.io/aws/costs
Response samples
200
Content type
application/json
{
"request": {
"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/aws/costs",
"method": "GET",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {
"status": {
"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:costs",
"items": [
[
{
"timestamp": "2020-03-06T00:00:00.000Z",
"spot": {
"runningHours": 1470.8,
"actualCosts": 107.3,
"potentialCosts": 378.41,
"savingsPercentage": 71.64
}
}
]
],
"count": 1
}
}
Suggested Instance Type
Get suggested instance types by required resources.
Note that request must include region, and at least one of the following values - baselineInstanceType, requiredVCpu, requiredMemoryGib
Get the savings of the organization between the input time range.
Authorizations:
auth
query Parameters
fromDate
string
Example: fromDate=2022-06-20
Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472).
*Minimum from date can be one year ago.
toDate
string
Example: toDate=2022-11-20
Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472).
*Data is shown until the past day (Does not include today's costs)
Checks whether given Alias name is available for use
for the selected service in the current organization.
Authorizations:
auth
path Parameters
service
required
string
Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)
Retrieve a list of all enabled connectors (integration or resource), excluding those that are
exclusively trigger-based. For each connector, extract essential settings from its schema and
determine a boolean status indicating whether it's configured or not.
Fetch quotas for organization and provide information on their limits and current status.
Authorizations:
auth
Responses
https://api.spotinst.io/connect/settings/quotas
Response samples
200
Content type
application/json
{
"body": {
"current_tier": "string",
"executions": {
"available": 0,
"current_usage": 0,
"workflow_limit": 0
},
"plan_renew": "2019-08-24T14:15:22Z",
"workflows": {
"available": 0,
"current_usage": 0,
"workflow_limit": 0
}
},
"statusCode": 0
}
Get Schema
Get the JSON schema for the given integration or resource.
+
https://api.spotinst.io/connect/settings/quotas
Response samples
200
Content type
application/json
{
"body": {
"current_tier": "string",
"executions": {
"available": 0,
"current_usage": 0,
"workflow_limit": 0
},
"plan_renew": "2019-08-24T14:15:22Z",
"workflows": {
"available": 0,
"current_usage": 0,
"workflow_limit": 0
}
},
"statusCode": 0
}
Get Schema
Get the JSON schema for the given integration or resource.
Authorizations:
auth
path Parameters
service
required
string
Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)
After the user installs/authorizes the Spot Connect Slack app in their workspace,
they will be redirected back to the Slack integration page in the Fylamynt web app
with an authorization code. The web app will then call this API endpoint with that
'code' in the query parameter. Instead, if the user rejects to authorize the Fylamynt
@@ -5967,17 +5986,17 @@
Endpoint to fetch the list of trigger connectors each containing the name, display name, snippet name, and
configuration status of the respective connector.
Authorizations:
auth
Responses
https://api.spotinst.io/connect/settings/triggers
Response samples
200
Content type
application/json
{
"body": {
"triggers": [
{
"display_name": "string",
"is_configured": true,
"name": "string",
"snippet_name": "string"
}
]
},
"statusCode": 0
}
The Fylamynt web app will make a POST request to this endpoint that contains an
authorization code in the query parameter. Once we receive this request,
+
https://api.spotinst.io/connect/settings/triggers
Response samples
200
Content type
application/json
{
"body": {
"triggers": [
{
"display_name": "string",
"is_configured": true,
"name": "string",
"snippet_name": "string"
}
]
},
"statusCode": 0
}
The Fylamynt web app will make a POST request to this endpoint that contains an
authorization code in the query parameter. Once we receive this request,
we will use the auth code and exchange it for an OAuth token with a
request type 'authorization_code' by calling back to Zoom.
If we successfully exchange the auth code for a token, we will then save
@@ -5992,7 +6011,7 @@
The Example model contains models for all services that can be created.
When calling this endpoint for a specific service, only the credentials
for that service should be provided in the payload.
Get the details of the selected integration/resource instance.
Note: The JSON response will contain credentials specific to the selected service and integration,
unlike the response model which shows all possible fields for all services. The model is provided
to illustrate the complete set of fields that may be present in the response, depending on which
@@ -6037,7 +6056,7 @@
Update the Integration/Resource secrets for a given service and given integration instance.
Note: The displayed request and response models show the structure for each service.
When calling this endpoint, only the credentials for the specific service being updated
should be provided in the payload under the 'credentials' key. The response will contain
@@ -6073,13 +6092,13 @@
Move Workflow and its Integrations to Another Workpace
It moves a workflow and all integrations it uses
in new workspace. Following things are needed -
Permissions the user needs in both workspaces:
updateWorkflow
@@ -6219,7 +6238,7 @@
A cyber security compliance determines how compliant an asset is. It checks against specific security standards.
This API returns list of all compliances supported in Spot.
A compliance consists of one or more controls.
A control is countermeasures to avoid, detect, counteract, or minimize security risks of cloud assets.
A control may be part of one or more compliances. A control is verified in one or more rules.
This API returns the list of controls mapped to a specific compliance.
Rules are configuration checks that detect misconfigurations in your cloud environment.
Rules are cloud service provider specific. A rule is mapped to one or more controls.
This API returns the list of rules that can determine the state of a specific control.
Rules are configuration checks that detect misconfigurations in your cloud environment.
Rules are cloud service provider specific. A rule is mapped to one or more controls.
This API returns the list of rules that can determine the state of a specific control.
