DescribePrice - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries the pricing information of a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:DescribePrice	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PriceUnit	string	Yes	The billing cycle of the Elastic Compute Service (ECS) instances. This parameter takes effect only when the ChargeType parameter 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 type of the order. The order can be set only as a purchase order. Valid value: INSTANCE-BUY.	INSTANCE-BUY
Commodities	object []	Yes	The information about the service.
Amount	integer	Yes	The node quantity of the type. 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. This parameter takes effect only when the Commodities.N.SystemDiskCategory parameter 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	object []	No	The list of data disks.
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	Specifies 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. This parameter takes effect only when the Commodities.N.DataDisks.N.category parameter 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	Specifies 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 parameters

Parameter	Type	Description	Example
	object
TotalTradePrice	float	The total price. Unit: USD.	1258
RequestId	string	The request ID.	54FF9025-2C2F-42EB-870D-0DF5B0ACF24E
Prices	object []	The array of cluster prices. If you query the prices of multiple nodes in the cluster, the sequence of the prices in the returned value of PriceInfo is the same as the sequence of the nodes in the request parameters. For example, the first price in the value of PriceInfo is the price of the first node specified in the request parameters.
OriginalPrice	float	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 that is used to measure the price. Valid values: USD	USD
TradePrice	float	The final price. Unit: USD.	1258

Examples

Sample success responses

JSONformat

{
  "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.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
406	EcsError	An error occurred while calling the ECS API operation.	An error occurred while calling the ECS API operation.
406	DbError	A database service error occurred.	Database request failed.
406	AliyunError	An Alibaba Cloud product error occurred.	An Alibaba Cloud product error occurred.
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.
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.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-03-27

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 407 change
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 406
	delete Error Codes: 500
	delete Error Codes: 503

2021-12-23

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 406
	delete Error Codes: 407
	delete Error Codes: 500
	delete Error Codes: 503