ListEcsSpecs - Platform For AI - Alibaba Cloud Documentation Center

Retrieves a list of 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 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

paidsw:ListEcsSpecs

get

*All Resource

*

None

Request syntax

GET /api/v2/ecsspecs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AcceleratorType	string	Yes	The type of accelerator. CPU: No accelerator is used. Only the CPU is used for computing. GPU: A GPU is used for computing acceleration.	CPU
PageNumber	integer	No	The page number of the ECS instance type list. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of ECS instance types to display on each page for a paged query.	10
SortBy	string	No	This parameter is deprecated. Do not use it.	gmtCreate
Order	string	No	The sort order. Valid values: ASC: ascending order. DESC: descending order.	DESC

Response elements

Element	Type	Description	Example
	object	The list of ECS instance types.
RequestId	string	The request ID.	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Message	string	The returned message.	"XXX"
Code	string	The status code. Valid values: InternalError: An internal error occurred. All errors except parameter validation errors are classified as internal errors. ValidationError: A parameter validation error occurred.	null
HttpStatusCode	integer	The HTTP status code. Valid values: 400 404	null
TotalCount	integer	The total number of instances.	35
EcsSpecs	array<object>	The list of instances requested on the current page.
	array<object>	The ECS instance type.
InstanceType	string	The instance type.	ecs.gn5-c28g1.7xlarge
GPUType	string	The GPU type. Valid values: V100 A100 A10 T4 P100	v100
CPU	integer	The number of CPU cores.	32
GPU	integer	The number of GPUs.	4
Memory	number	The memory size in GB.	32
SystemDiskCapacity	integer	The system disk size in GB.	500
AcceleratorType	string	The resource type.	CPU
Price	number	The price.	22.8
Currency	string	The currency unit.	CNY
InstanceBandwidthRx	integer	The inbound bandwidth of the instance.	5120000
Labels	array<object>	The list of ECS instance type labels.	{'foo': 'bar'}
	object	The label.
Key	string	The key of the ECS instance type tag.	SupportResourcePackDeduction
Value	string	The value of the ECS instance type tag.	true
IsAvailable	boolean	Indicates whether the resource is available.	True
GPUMemorySize	number
SpotStockStatus	string

Examples

Success response

JSON format

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "TotalCount": 35,
  "EcsSpecs": [
    {
      "InstanceType": "ecs.gn5-c28g1.7xlarge",
      "GPUType": "v100",
      "CPU": 32,
      "GPU": 4,
      "Memory": 32,
      "SystemDiskCapacity": 500,
      "AcceleratorType": "CPU",
      "Price": 22.8,
      "Currency": "CNY",
      "InstanceBandwidthRx": 5120000,
      "Labels": [
        {
          "Key": "SupportResourcePackDeduction",
          "Value": "true"
        }
      ],
      "IsAvailable": true,
      "GPUMemorySize": 0,
      "SpotStockStatus": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.