Queries the price configuration 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribePrice

The operation that you want to perform. Set the value to DescribePrice.

Commodities.N.Amount Integer Yes 2

The number of the nth node of this type. Valid values: 1 to 1000.

Default value: 1.

Valid values of N: 1 to 10.

Commodities.N.InstanceType String Yes ecs.n1.tiny

The Elastic Compute Service (ECS) instance type of the nth node.

Valid values of N: 1 to 10.

Commodities.N.NodeType String Yes Compute

The type of the nth node. Valid values:

  • Compute: compute node
  • Manager: management node
  • Login: logon node.

Valid values of N: 1 to 10.

Commodities.N.Period Integer Yes 1

The billing duration of the ECS instance in the nth node. Valid values:

  • Valid values when PriceUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • Valid values when PriceUnit is set to Year: 1, 2, and 3
  • Valid values when PriceUnit is set to Hour: 1

Default value: 1.

Valid values of N: 1 to 10.

PriceUnit String Yes Hour

The billing cycle for the ECS instance. 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

Valid values of N: 1 to 10.

Commodities.N.NetworkType String No VPC

The network type of the nth node. You can set this parameter only to Virtual Private Cloud (VPC). Set the value to VPC.

Valid values of N: 1 to 10.

Commodities.N.SystemDiskCategory String No cloud_ssd

The type of the system disk of the nth node. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: SSD
  • cloud_essd: enhanced SSD (ESSD)
  • cloud: basic disk

Default value: cloud_efficiency.

Valid values of N: 1 to 10.

Commodities.N.SystemDiskSize Integer No 40

The system disk size of the nth node. Unit: GB.

Valid values: 40 to 500.

Default value: 40

Valid values of N: 1 to 10.

Commodities.N.InternetChargeType String No PayByBandwidth

The billing method of the public Internet for the nth node. Valid values:

  • PayByBandwidth: pay-by bandwidth
  • PayByTraffic: pay-by-traffic

Valid values of N: 1 to 10.

Commodities.N.InternetMaxBandWidthOut Integer No 100

The maximum outbound Internet bandwidth of the nth node. Unit: Mbit/s.

Valid values: 0 to 100.

Default value: 0.

Valid values of N: 1 to 10.

Commodities.N.SystemDiskPerformanceLevel String No PL1

The performance level of the system disk of the nth node when it is an ESSD. This parameter is valid only when the Commodities.N.SystemDiskCategory paramter 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 random read/write IOPS.
  • 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.

ChargeType String No PostPaid

The billing method that is used for ECS instances in the cluster. Valid values:

  • PostPaid: pay-as-you-go.
  • PrePaid: subscription.

Default value: PostPaid.

OrderType String No instance-buy

The type of the purchase order can only be set to instance-buy. Set the value to instance-buy.

Response parameters

Parameter Type Example Description
Prices Array of PriceInfo

The array of prices of clusters. When request parameters query the configuration prices of multiple nodes in the cluster, the sequence of multiple elements in the returned value PriceInfo corresponds to the sequence of multiple node information set by the request parameters in sequence. For example, if N=1 is returned to the node information in the request parameters, the corresponding value is the first element of PriceInfo.

PriceInfo
Currency String CNY

The currency unit. Valid values:

  • CNY
  • USD
NodeType String Compute

The type of the node. Valid values:

  • Manager: management node
  • Login: logon node.
  • Compute: compute node
OriginalPrice Float 1258

The original price.

Unit: USD

TradePrice Float 1258

The transaction price.

Unit: USD

RequestId String 54FF9025-2C2F-42EB-870D-0DF5B0ACF24E

The ID of the request.

TotalTradePrice Float 1258

The total price.

Unit: USD

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribePrice
&Commodities.1.Amount=2
&Commodities.1.InstanceType=ecs.n1.tiny
&Commodities.1.1odeType=compute
&Commodities.1.Period=1
&PriceUnit=Hour
&<Common request parameters>

Sample success responses

XML format

<DescribePriceResponse>
      <Prices>
            <PriceInfo>
                  <OriginalPrice>1258</OriginalPrice>
                  <TradePrice>1258</TradePrice>
                  <Currency>CNY</Currency>
                  <NodeType>Compute</NodeType>
            </PriceInfo>
      </Prices>
      <TotalTradePrice>1258</TotalTradePrice>
      <RequestId>54FF9025-2C2F-42EB-870D-0DF5B0ACF24E</RequestId>
</DescribePriceResponse>

JSON format

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

Error codes

HttpCode Error code Error message Description
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The server is temporarily unavailable.

For a list of error codes, visit the API Error Center.