Use DescribePrice to query cluster pricing information - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries pricing information for a cluster configuration.

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:DescribePrice

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PriceUnit	string	Yes	The billing cycle of the ECS instances. Takes effect only when ChargeType is set to PrePaid. Valid values: Month: pay-by-month Year: pay-by-year Hour: pay-by-hour Default value: Hour.	Hour
ChargeType	string	No	The billing method of the ECS instances. Valid values: PostPaid: pay-as-you-go PrePaid: subscription Default value: PostPaid.	PostPaid
OrderType	string	No	The order type. Only purchase orders are supported. Valid value: INSTANCE-BUY.	INSTANCE-BUY
Commodities	array<object>	Yes	The service information.
	array<object>	No
Amount	integer	Yes	The number of nodes. Valid values: 1 to 1000. Default value: 1. Valid values of N: 1 to 10	2
SystemDiskSize	integer	No	The system disk size of the node. Unit: GB. Valid values: 40 to 500. Default value: 40. Valid values of N: 1 to 10.	40
SystemDiskPerformanceLevel	string	No	The performance level of the ESSD used as the system disk. Takes effect only when Commodities.N.SystemDiskCategory is set to cloud_essd. Valid values: PL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1: A single ESSD can deliver up to 50,000 IOPS of random read/write. PL2: A single ESSD can deliver up to 100,000 random read/write IOPS. PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS. Default value: PL1. Valid values of N: 1 to 10	PL1
NodeType	string	Yes	The type of the node. Valid values: Compute: compute node Manager: management node Login: logon node Valid values of N: 1 to 10.	Compute
SystemDiskCategory	string	No	The system disk type of the node. Valid values: cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: ESSD cloud: basic disk Default value: cloud_efficiency Valid values of N: 1 to 10.	cloud_ssd
InternetChargeType	string	No	The EIP billing method of the node. Valid values: PayByBandwidth: pay-by-bandwidth PayByTraffic: pay-by-traffic Valid values of N: 1 to 10.	PayByBandwidth
NetworkType	string	No	The network type of the node. Valid value: VPC. Valid values of N: 1 to 10.	VPC
InstanceType	string	Yes	The instance type of the node. Valid values of N: 1 to 10.	ecs.n1.tiny
Period	integer	Yes	The subscription duration of the node. Valid values: If PriceUnit is set to Year, the valid values of the Period parameter are 1, 2, and 3. If PriceUnit is set to Month, the valid values of the Period parameter are 1, 2, 3, 4, 5, 6, 7, 8, and 9. If PriceUnit is set to Hour, the valid value of the Period parameter is 1. Default value: 1. Valid values of N: 1 to 10.	1
InternetMaxBandWidthOut	integer	No	The maximum outbound public bandwidth of the node. Unit: Mbit/s. Valid values: 0 to 100. Default value: 0. Valid values of N: 1 to 10.	100
DataDisks	array<object>	No	The list of data disks.
	object	No
size	integer	No	The size of the data disk. Unit: GB. Valid values: 40 to 500. Default value: 40. Valid values of N: 0 to 4.	40
category	string	No	The type of the data disk. Valid values: cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: ESSD cloud: basic disk Default value: cloud_efficiency. Valid values of N: 0 to 4.	cloud_efficiency
deleteWithInstance	boolean	No	Whether the data disk is released when the node is released. Valid values: true false Default value: true. Valid values of N: 0 to 4.	true
performanceLevel	string	No	The performance level of the ESSD used as the data disk. Takes effect only when Commodities.N.DataDisks.N.category is set to cloud_essd. Valid values: PL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1: A single ESSD can deliver up to 50,000 IOPS of random read/write. PL2: A single ESSD can deliver up to 100,000 random read/write IOPS. PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS. Default value: PL1. Valid values of N: 0 to 4.	PL1
encrypted	boolean	No	Whether to encrypt the data disk. Valid values: true: encrypts the data disk. false: does not encrypt the data disk. Default value: false. Valid values of N: 0 to 4.	false

Response elements

Element	Type	Description	Example
	object
TotalTradePrice	number	The total price. Unit: USD.	1258
RequestId	string	The request ID.	54FF9025-2C2F-42EB-870D-0DF5B0ACF24E
Prices	object
PriceInfo	array<object>	The pricing details for each node in the cluster. Prices are returned in the same order as the nodes specified in the request parameters.
	object
OriginalPrice	number	The original price. Unit: USD.	1258
NodeType	string	The node type. Valid values: Manager: management node Login: logon node Compute: compute node	Compute
Currency	string	The currency unit. Valid values: USD	USD
TradePrice	number	The final price. Unit: USD.	1258

Examples

Success response

JSON format

{
  "TotalTradePrice": 1258,
  "RequestId": "54FF9025-2C2F-42EB-870D-0DF5B0ACF24E",
  "Prices": {
    "PriceInfo": [
      {
        "OriginalPrice": 1258,
        "NodeType": "Compute",
        "Currency": "USD",
        "TradePrice": 1258
      }
    ]
  }
}

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.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
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.
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
407	EntityNotExist.Role	The role does not exist.	The role does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.