ListPreferredEcsTypes - Query recommended ECS instance types - Elastic High Performance Computing

Queries ECS instance types recommended by E-HPC.

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 supports 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:ListPreferredEcsTypes

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ZoneId	string	Yes	The zone ID.	cn-hangzhou-b
SpotStrategy	string	No	The spot strategy for the ECS instance. Valid values: NoSpot: pay-as-you-go instance. SpotWithPriceLimit: preemptible instance with a user-defined maximum hourly price. SpotAsPriceGo: preemptible instance that uses the market price as the bid price.	NoSpot
InstanceChargeType	string	No	The billing method of the ECS instances. Valid values: PostPaid PrePaid	PostPaid

Response elements

Element	Type	Description	Example
	object
SupportSpotInstance	boolean	Whether preemptible instances are supported.	true
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Series	object
SeriesInfo	array<object>	Recommended ECS instance types for each node role in the E-HPC cluster.
	array<object>	Recommended ECS instance types for each node role in the E-HPC cluster.
SeriesName	string	The name of the instance series. Valid values: SeriesHighCompute SeriesHighMem SeriesGPU SeriesAll	SeriesAll
SeriesId	string	The ID of the ECS instance series. Valid values: HighCompute: compute-optimized instance families HighMem: memory-optimized instance families GPU: GPU-accelerated instance families All: all instance families	All
Roles	object	Recommended instance types for each node role in an E-HPC cluster.
Manager	object
InstanceTypeId	array	Recommended ECS instance types for management nodes.
	string	Recommended ECS instance types for management nodes.	[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]
Compute	object
InstanceTypeId	array	Recommended ECS instance types for compute nodes.
	string	Recommended ECS instance types for compute nodes.	[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]
Login	object
InstanceTypeId	array	Recommended ECS instance types for login nodes.
	string	Recommended ECS instance types for login nodes.	[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]

Examples

Success response

JSON format

{
  "SupportSpotInstance": true,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Series": {
    "SeriesInfo": [
      {
        "SeriesName": "SeriesAll",
        "SeriesId": "All",
        "Roles": {
          "Manager": {
            "InstanceTypeId": [
              "[ \"ecs.sn1ne.2xlarge\", \"ecs.sn1ne.4xlarge\", \"ecs.n1.tiny\" ]"
            ]
          },
          "Compute": {
            "InstanceTypeId": [
              "[ \"ecs.sn1ne.2xlarge\", \"ecs.sn1ne.4xlarge\", \"ecs.n1.tiny\" ]"
            ]
          },
          "Login": {
            "InstanceTypeId": [
              "[ \"ecs.sn1ne.2xlarge\", \"ecs.sn1ne.4xlarge\", \"ecs.n1.tiny\" ]"
            ]
          }
        }
      }
    ]
  }
}

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
406	DbError	A database service error occurred.	Database request failed.
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.