ListAvailableEcsTypes - Elastic High Performance Computing

You can call ListAvailableEcsTypes to query available ECS instance types.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:ListAvailableEcsTypes

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ZoneId	string	No	The ID of the zone.	cn-hangzhou-b
SpotStrategy	string	No	The preemption policy for the ECS instance. Valid values: NoSpot: The instance is a pay-as-you-go instance. SpotWithPriceLimit: The instance is a spot instance with a user-defined maximum hourly price. SpotAsPriceGo: The instance is a spot instance for which the system automatically bids based on the current market price.	NoSpot
InstanceChargeType	string	No	The billing method of the ECS instance. Valid values: PostPaid: pay-as-you-go PrePaid: subscription	PostPaid
ShowSoldOut	boolean	No	Specifies whether to display sold-out ECS instance types. Valid values: false: The instance type is not sold out. true: The instance type is sold out. Default value: false.	false

Response parameters

Parameter	Type	Description	Example
	object
SupportSpotInstance	boolean	Indicates whether spot instances are supported. Possible values: false: Not supported. true: Supported.	false
RequestId	string	The request ID.	D9DD3AF8-1F91-4075-8669-55D10E45****
InstanceTypeFamilies	object
InstanceTypeFamilyInfo	array<object>	The instance family to which the instance type belongs.
	object
Generation	string	The generation of the instance family.	ecs-3
InstanceTypeFamilyId	string	The ID of the instance family. For more information, see Instance families.	ecs.n4
Types	object
TypesInfo	array<object>	A list of instance types.
	object
Status	string	The status of the ECS instance type. Possible values: SoldOut: The resource is sold out. Available: The resource is available.	Available
InstanceTypeId	string	The ID of the ECS instance type.	ecs.n4.xlarge
InstanceBandwidthRx	integer	The maximum inbound internal bandwidth. Unit: kbit/s.	10240000
GPUSpec	string	The GPU type of the ECS instance.	NVIDIA V100
InstanceBandwidthTx	integer	The maximum outbound internal bandwidth. Unit: kbit/s.	10240000
InstancePpsRx	integer	The inbound packet forwarding rate over the internal network. Unit: pps.	9000000
InstancePpsTx	integer	The outbound packet forwarding rate over the internal network. Unit: pps.	9000000
GPUAmount	integer	The number of GPUs for the ECS instance.	2
CpuCoreCount	integer	The number of vCPU cores.	4
MemorySize	integer	The memory size of the ECS instance. Unit: GiB.	8
EniQuantity	integer	The maximum number of elastic network interfaces (ENIs) that can be attached to the ECS instance.	2
ZoneIds	object
ZoneId	array	A list of zone IDs.
	string	The ID of the zone.	cn-hangzhou-b

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.
406	EcsError	An error occurred while calling the ECS API operation.	ECS API call error. %s
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.