DescribeInstanceTypes

1. API Description

This API (DescribeInstanceTypes) is used to query the model configuration of an instance.

Note

Use DescribeInstanceTypes to query the configuration and performance information of an instance model. If you need to check the available instance models in a specific zone, please call DescribeAvailableResources.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
imageId	No	String	Instance models that support specified image.
instanceTypeIds	No	Array of String	Instance model ID. Maximum number: 100
minimumCpuCoreCount	No	Integer	Desired minimum number of CPU cores. Value range: positive integer.
maximumCpuCoreCount	No	Integer	Desired maximum number of CPU cores. Value range: positive integer.
minimumMemorySize	No	Integer	Desired minimum memory size. Value range: positive integer. Unit: GB.
maximumMemorySize	No	Integer	Desired maximum memory size. Value range: positive integer. Unit: GB.
minimumBandwidth	No	Integer	Desired minimum public inbound bandwidth cap. Unit: Mbps.
supportRaids	No	Array of Integer	Supported RAID levels. Value range: 0, 1, 5, 10.
supportSubnet	No	Boolean	Subnet supported or not.
minimumDiskSize	No	Integer	Desired minimum disk size. Value range: positive integer. Unit: GB.
maximumDiskSize	No	Integer	Desired maximum memory size. Value range: positive integer. Unit: GB.
isHA	No	Boolean	High availability supported or not.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
instanceTypes	Array of InstanceType	Information on instance model.

4. Code Example

Example

Query the instance models

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeInstanceTypes
<Common Request Params>

Response:
{
  "requestId": "TE056C563-E5B1-46B5-9C5A-514B7501F420",
  "response": {
    "requestId": "TE056C563-E5B1-46B5-9C5A-514B7501F420",
    "instanceTypes": [
      {
        "imageIds": [
          "e3f1cf2e-8929-4b8a-8747-d0b779b770f7",
          "6059cf45-daf7-4954-80a2-346e8c3c5fd7"
        ],
        "instanceTypeId": "M9O",
        "description": "2x6248",
        "cpuCoreCount": 80,
        "cpuDetail": "1 × Intel® Xeon® CPU E3-1230 v5",
        "cpuCores": 2,
        "cpuThreads": 8,
        "baseFrequency": "3.40 GHz (Turbo 3.80 GHz)",
        "memorySize": 256,
        "maximumBandwidth": 10000,
        "supportRaids": [0,1,5,10],
        "supportSubnet": true,
        "isHA": true,
        "diskInfo": {
          "totalDiskSize": 4000,
          "diskDescription": "4x1.2TB SAS",
          "disks": [
            {
              "diskSize": 1000,
              "diskCount": 4
            }
          ]
        }
      },
      {
        "imageIds": [
          "f9f9f8a2-24a1-44dd-9f60-36c3bc5c0dae"
        ],
        "instanceTypeId": "MGI",
        "description": "2x6248",
        "cpuCoreCount": 80,
        "cpuDetail": "1 × Intel® Xeon® CPU E3-1230 v5",
        "cpuCores": 2,
        "cpuThreads": 8,
        "baseFrequency": "3.40 GHz (Turbo 3.80 GHz)",
        "memorySize": 256,
        "maximumBandwidth": 10000,
        "supportRaids": [0,1],
        "supportSubnet": true,
        "isHA": true,
        "diskInfo": {
          "totalDiskSize": 2000,
          "diskDescription": "2x1.2TB SAS",
          "disks": [
            {
              "diskSize": 1000,
              "diskCount": 2
            }
          ]
        }
      }
    ]
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs，to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code	Error Code	Description