GEThttps://api.spotinst.io/azure/compute/group?accountId={ACCOUNT_ID}&name={NAME}®ion={REGION}

 

         List Elastigroup clusters.

URL Parameters

Parameter Type Description
ACCOUNT_ID String

Your Spot accountId associated with your token.

Example: act-123abc
NAME String

Filters to find the elastigroup via a specific name.

REGION String

Filters to find all the groups in a specific region.

Request

Headers
Copied!
Downloaded!
{  
   "Content-Type": "application/json",
   "Authorization": "Bearer ${token}" 
}
Response - Response: 200

Body
Copied!
Downloaded!
{
    "request": {
        "id": "753d6fc1-7359-4de8-bdd4-6d717609cfc9",
        "url": "/azure/compute/group?accountId=act-9ba79a4a",
        "method": "GET",
        "timestamp": "2018-06-20T11:34:42.261Z"
    },
      "response": {
      "status": {
        "code": 200,
        "message": "OK"
      },
      "kind": "spotinst:azure:compute:group",
      "items": [
        {
          "id": "sig-123123",
          "name": "TestGroup",
          "region": "westus2",
          "resourceGroupName": "testResourceGroup",
          "capacity": {
            "target": 3,
            "minimum": 2,
            "maximum": 3
          },
          "strategy": {
            "spotPercentage": 50,
            "drainingTimeout": 3,
            "fallbackToOd": true,
            "revertToSpot": {
              "performAt": "timeWindow"
            },
            "optimizationWindows": [
              "Mon:03:00-Wed:02:30"
            ],
            "signals": [
              {
                "type": "vmReady",
                "timeout": 180
              },
              {
                "type": "vmReadyToShutdown",
                "timeout": 180
              }
            ]
          },
          "scaling": {
            "up": [
              {
                "isEnabled": true,
                "policyName": "scaleUpPolicyName",
                "metricName": "Percentage CPU",
                "statistic": "average",
                "unit": "percent",
                "threshold": 2,
                "namespace": "Microsoft.Compute",
                "period": 300,
                "evaluationPeriods": 4,
                "cooldown": 300,
                "action": {
                  "type": "adjustment",
                  "adjustment": "1"
                },
                "operator": "gt"
              }
            ],
            "down": [
              {
                "isEnabled": true,
                "policyName": "scaleDownPolicyName",
                "metricName": "Percentage CPU",
                "statistic": "count",
                "unit": "percent",
                "threshold": 10,
                "namespace": "Microsoft.Compute",
                "period": 300,
                "evaluationPeriods": 6,
                "cooldown": 300,
                "action": {
                  "type": "adjustment",
                  "adjustment": "1"
                },
                "operator": "lte"
              }
            ]
          },
          "compute": {
            "os": "Linux",
            "vmSizes": {
              "odSizes": [
                "standard_a1_v2"
              ],
              "spotSizes": [
                "standard_a1_v2"
              ]
            },
            "launchSpecification": {
              "customData": "",
              "image": {
                "marketplace": {
                  "publisher": "Canonical",
                  "offer": "UbuntuServer",
                  "sku": "18.04-LTS",
                  "version": "latest"
                }
              },
              "network": {
                "resourceGroupName": "testResourceGroup",
                "virtualNetworkName": "testVirtualNetwork",
                "networkInterfaces": [
                  {
                    "isPrimary": true,
                    "subnetName": "testResourceGroup",
                    "assignPublicIp": true,
                    "publicSku": "STANDARD",
                    "securityGroup": {
                      "name": "testSecurityGroup",
                      "resourceGroupName": "testResourceGroup"
                    },
                    "enableIPForwarding": true,
                    "additionalIpConfigurations": [
                      {
                        "name": "TestIbSecodary"
                      }
                    ]
                  }
                  {
                    "isPrimary": false,
                    "subnetName": "testSubnet",
                    "assignPublicIp": false,
                    "securityGroup": {
                      "name": "testSecurityGroup",
                      "resourceGroupName": "testResourceGroup"
                    },
                    "enableIPForwarding": true,
                    "additionalIpConfigurations": [
                      {
                        "name": "TestIbSecodary"
                      }
                    ]
                  }
                ]
              },
              "login": {
                "sshPublicKey": "ssh-rsa",
                "userName": "test"
              },
              "loadBalancersConfig": {
                "loadBalancers": [
                  {
                    "type": "loadBalancer",
                    "resourceGroupName": "testResourceGroup",
                    "name": "testLoadBalancer",
                    "backendPoolNames": [
                      "testBackendPool1",
                      "testBackendPool2"
                    ],
                    "sku": "Standard"
                  }
                ]
              },
              "tags": [
                {
                  "tagKey": "creator",
                  "tagValue": "tester"
                }
              ],
              "extensions": [
                {
                  "name": "extensionName",
                  "type": "customScript",
                  "publisher": "Microsoft.Azure.Extensions",
                  "apiVersion": "2.0",
                  "minorVersionAutoUpgrade": true,
                  "protectedSettings": {
                    "script": "IyEvYmluL2Jhc2gKZWNobyAibmlyIiA+IC9ob21lL25pci9uaXIudHh0Cg=="
                  }
                }
              ],
              "dataDisks": [
                {
                  "size": 1,
                  "lun": 1,
                  "type": "Standard_LRS"
                }
              ],
              "osDisk": {
                "type": "Standard_LRS",
                "sizeGB": 30
              }
            }
          },
          "health": {
            "healthCheckTypes": [
              "vmState"
            ],
            "gracePeriod": 60,
            "autoHealing": true
          },
          "scheduling": {
            "tasks": [
              {
                "isEnabled": true,
                "type": "scaleUp",
                "cronExpression": "3 * * * *",
                "adjustment": 1
              },
              {
                "isEnabled": true,
                "type": "scaleDown",
                "cronExpression": "58 * * * *",
                "adjustment": 1
              },
              {
                "isEnabled": true,
                "type": "deployment",
                "cronExpression": " 37 * * * *",
                "gracePeriod": 2,
                "batchSizePercentage": 30
              }
            ]
          }
        },
          {
          "id": "sig-123124",
          "name": "TestGroup",
          "region": "westus2",
          "resourceGroupName": "testResourceGroup",
          "capacity": {
            "target": 3,
            "minimum": 2,
            "maximum": 3
          },
          "strategy": {
            "spotPercentage": 50,
            "drainingTimeout": 3,
            "fallbackToOd": true,
            "revertToSpot": {
              "performAt": "timeWindow"
            },
            "optimizationWindows": [
              "Mon:03:00-Wed:02:30"
            ],
            "signals": [
              {
                "type": "vmReady",
                "timeout": 180
              },
              {
                "type": "vmReadyToShutdown",
                "timeout": 180
              }
            ]
          },
          "scaling": {
            "up": [
              {
                "isEnabled": true,
                "policyName": "scaleUpPolicyName",
                "metricName": "Percentage CPU",
                "statistic": "average",
                "unit": "percent",
                "threshold": 2,
                "namespace": "Microsoft.Compute",
                "period": 300,
                "evaluationPeriods": 4,
                "cooldown": 300,
                "action": {
                  "type": "adjustment",
                  "adjustment": "1"
                },
                "operator": "gt"
              }
            ],
            "down": [
              {
                "isEnabled": true,
                "policyName": "scaleDownPolicyName",
                "metricName": "Percentage CPU",
                "statistic": "count",
                "unit": "percent",
                "threshold": 10,
                "namespace": "Microsoft.Compute",
                "period": 300,
                "evaluationPeriods": 6,
                "cooldown": 300,
                "action": {
                  "type": "adjustment",
                  "adjustment": "1"
                },
                "operator": "lte"
              }
            ]
          },
          "compute": {
            "os": "Linux",
            "vmSizes": {
              "odSizes": [
                "standard_a1_v2"
              ],
              "spotSizes": [
                "standard_a1_v2"
              ]
            },
            "launchSpecification": {
              "customData": "",
              "image": {
                "marketplace": {
                  "publisher": "Canonical",
                  "offer": "UbuntuServer",
                  "sku": "18.04-LTS",
                  "version": "latest"
                }
              },
              "network": {
                "resourceGroupName": "testResourceGroup",
                "virtualNetworkName": "testVirtualNetwork",
                "networkInterfaces": [
                  {
                    "isPrimary": true,
                    "subnetName": "testResourceGroup",
                    "assignPublicIp": true,
                    "publicIpSku": "STANDARD",
                    "securityGroup": {
                      "name": "testSecurityGroup",
                      "resourceGroupName": "testResourceGroup"
                    },
                    "enableIPForwarding": true,
                    "additionalIpConfigurations": [
                      {
                        "name": "TestIbSecodary"
                      }
                    ]
                  }
                  {
                    "isPrimary": false,
                    "subnetName": "testSubnet",
                    "assignPublicIp": false,
                    "securityGroup": {
                      "name": "testSecurityGroup",
                      "resourceGroupName": "testResourceGroup"
                    },
                    "enableIPForwarding": true,
                    "additionalIpConfigurations": [
                      {
                        "name": "TestIbSecodary"
                      }
                    ]
                  }
                ]
              },
              "login": {
                "sshPublicKey": "ssh-rsa",
                "userName": "test"
              },
              "loadBalancersConfig": {
                "loadBalancers": [
                  {
                    "type": "loadBalancer",
                    "resourceGroupName": "testResourceGroup",
                    "name": "testLoadBalancer",
                    "backendPoolNames": [
                      "testBackendPool1",
                      "testBackendPool2"
                    ],
                    "sku": "Standard"
                  }
                ]
              },
              "tags": [
                {
                  "tagKey": "creator",
                  "tagValue": "tester"
                }
              ],
              "extensions": [
                {
                  "name": "extensionName",
                  "type": "customScript",
                  "publisher": "Microsoft.Azure.Extensions",
                  "apiVersion": "2.0",
                  "minorVersionAutoUpgrade": true,
                  "protectedSettings": {
                    "script": "IyEvYmluL2Jhc2gKZWNobyAibmlyIiA+IC9ob21lL25pci9uaXIudHh0Cg=="
                  }
                }
              ],
              "dataDisks": [
                {
                  "sizeGB": 1,
                  "lun": 1,
                  "type": "Standard_LRS"
                }
              ],
              "osDisk": {
                "type": "Standard_LRS",
                "sizeGB": 30
              }
            }
          },
          "health": {
            "healthCheckTypes": [
              "vmState"
            ],
            "gracePeriod": 60,
            "autoHealing": true
          },
          "scheduling": {
            "tasks": [
              {
                "isEnabled": true,
                "type": "scaleUp",
                "cronExpression": "3 * * * *",
                "adjustment": 1
              },
              {
                "isEnabled": true,
                "type": "scaleDown",
                "cronExpression": "58 * * * *",
                "adjustment": 1
              },
              {
                "isEnabled": true,
                "type": "deployment",
                "cronExpression": " 37 * * * *",
                "gracePeriod": 2,
                "batchSizePercentage": 30
              }
            ]
          }
        }
        
      ],
    "count": 2
  }
}