All Products
Search
Document Center

Elastic High Performance Computing:ListPreferredEcsTypes

Last Updated:Mar 18, 2025

Queries the Elastic Compute Service (ECS) instance types recommended by Elastic High Performance Computing (E-HPC).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:ListPreferredEcsTypes
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ZoneIdstringYes

The zone ID.

cn-hangzhou-b
SpotStrategystringNo

The bidding policy of the ECS instance. Valid values:

  • NoSpot: The instance is created as a pay-as-you-go instance.
  • SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.
  • SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.
NoSpot
InstanceChargeTypestringNo

The billing method of the ECS instances. Valid values:

  • PostPaid
  • PrePaid
PostPaid

Response parameters

ParameterTypeDescriptionExample
object
SupportSpotInstanceboolean

Indicates whether preemptible instances are supported.

true
RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
Seriesarray<object>

The list of recommended ECS instances. Each SeriesInfo element contains the recommended ECS instance types for various nodes in the E-HPC cluster.

SeriesInfoobject

The list of recommended ECS instances. Each SeriesInfo element contains the recommended ECS instance types for various nodes in the E-HPC cluster.

SeriesNamestring

The name of the instance series. Valid values:

  • SeriesHighCompute
  • SeriesHighMem
  • SeriesGPU
  • SeriesAll
SeriesAll
SeriesIdstring

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
Rolesobject

Recommended instance types for nodes in an E-HPC cluser.

Managerarray

The list of recommended ECS instance types for management nodes.

InstanceTypeIdstring

The list of recommended ECS instance types for management nodes.

[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]
Computearray

The list of recommended ECS instance types for compute nodes.

InstanceTypeIdstring

The list of recommended ECS instance types for compute nodes.

[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]
Loginarray

The list of recommended ECS instance types for logon nodes.

InstanceTypeIdstring

The list of recommended ECS instance types for logon nodes.

[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
406EcsErrorAn error occurred while calling the ECS API operation.ECS API call error. %s
406DbErrorA database service error occurred.Database request failed.
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.

Change history

Change timeSummary of changesOperation
No change history