All Products
Search
Document Center

Elastic High Performance Computing:ListAvailableEcsTypes

Last Updated:Mar 03, 2024

Queries available Elastic Compute Service (ECS) instance types.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListAvailableEcsTypesREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ZoneIdstringNo

The zone ID.

cn-hangzhou-b
SpotStrategystringNo

The preemption policy of the ECS instances. Valid values:

  • NoSpot: The ECS instances are pay-as-you-go instances.
  • SpotWithPriceLimit: The ECS instances are preemptible instances that have a user-defined maximum hourly price.
  • SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.
NoSpot
InstanceChargeTypestringNo

The billing method of the ECS instances. Valid values:

  • PostPaid: pay-as-you-go
  • PrePaid: subscription
PostPaid
ShowSoldOutbooleanNo

Specifies whether the ECS instances are sold out. Valid values:

  • false: available
  • true: sold out

Default value: false.

false

Response parameters

ParameterTypeDescriptionExample
object
SupportSpotInstanceboolean

Specifies whether preemptible instances are supported. Valid values:

  • false: not supported
  • true: supported
false
RequestIdstring

The request ID.

D9DD3AF8-1F91-4075-8669-55D10E45****
InstanceTypeFamiliesobject []

The instance family to which the instance type belongs.

Generationstring

The instance family.

ecs-3
InstanceTypeFamilyIdstring

The ID of the instance family. For more information, see Instance families.

ecs.n4
Typesobject []

The list of instance types.

Statusstring

The status of the ECS instance. Valid values:

  • SoldOut
  • Available
Available
InstanceTypeIdstring

The ID of the ECS instance type.

ecs.n4.xlarge
InstanceBandwidthRxinteger

The maximum inbound internal bandwidth. Unit: Kbit/s.

10240000
GPUSpecstring

The GPU type of the ECS instance.

NVIDIA V100
InstanceBandwidthTxinteger

The maximum outbound internal bandwidth. Unit: Kbit/s.

10240000
InstancePpsRxinteger

The inbound packet forwarding rate over the internal network. Unit: pps.

9000000
InstancePpsTxinteger

The outbound packet forwarding rate over the internal network. Unit: pps.

9000000
GPUAmountinteger

The number of GPUs of an ECS instance.

2
CpuCoreCountinteger

The number of vCPUs.

4
MemorySizeinteger

The memory size of the ECS instance. Unit: GiB.

8
EniQuantityinteger

The maximum number of elastic network interfaces (ENIs) that can be bound to an ECS instance.

2
ZoneIdsarray

The list of zone IDs.

string
cn-hangzhou-b

Examples

Sample success responses

JSONformat

{
  "SupportSpotInstance": false,
  "RequestId": "D9DD3AF8-1F91-4075-8669-55D10E45****",
  "InstanceTypeFamilies": {
    "InstanceTypeFamilyInfo": [
      {
        "Generation": "ecs-3",
        "InstanceTypeFamilyId": "ecs.n4",
        "Types": {
          "TypesInfo": [
            {
              "Status": "Available",
              "InstanceTypeId": "ecs.n4.xlarge",
              "InstanceBandwidthRx": 10240000,
              "GPUSpec": "NVIDIA V100",
              "InstanceBandwidthTx": 10240000,
              "InstancePpsRx": 9000000,
              "InstancePpsTx": 9000000,
              "GPUAmount": 2,
              "CpuCoreCount": 4,
              "MemorySize": 8,
              "EniQuantity": 2,
              "ZoneIds": {
                "ZoneId": [
                  "cn-hangzhou-b"
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
406EcsErrorAn error occurred while calling the ECS API operation.An error occurred while calling the ECS API operation.
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.