DescribePrice - 查询集群配置价格

调用DescribePrice查询集群价格配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:DescribePriceRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PriceUnitstring

ECS 实例的计费周期单位。仅当 ChargeType=PrePaid 时该参数有效。取值范围:

  • Month:按月计费
  • Year:按年计费
  • Hour:按小时计费
  • Week:按周计费

默认值:Hour

Hour
ChargeTypestring

集群节点 ECS 实例的计费方式。取值范围:

  • PostPaid:按量付费
  • PrePaid:包年包月

默认值:PostPaid

PostPaid
OrderTypestring

订单类型,仅支持设置为商品购买。取值:INSTANCE-BUY

INSTANCE-BUY
Commoditiesobject []

商品列表。

Amountinteger

第 N 个该类型节点的数量。取值范围:1~1000

默认值:1

N 的取值范围:1~10

2
SystemDiskSizeinteger

第 N 个该节点的系统盘大小。单位:GB

取值范围:40~500

默认值:40

N 的取值范围:1~10

40
SystemDiskPerformanceLevelstring

第 N 个该节点的系统盘类型为 ESSD 云盘时,区分性能等级。仅当 Commodities.N.SystemDiskCategory=cloud_essd 时该参数有效。取值范围:

  • PL0:单盘最高随机读写 IOPS 1 万
  • PL1:单盘最高随机读写 IOPS 5 万
  • PL2:单盘最高随机读写 IOPS 10 万
  • PL3:单盘最高随机读写 IOPS 100 万

默认值:PL1

N 的取值范围:1~10

PL1
NodeTypestring

第 N 个节点类型。取值范围:

  • Compute:计算节点
  • Manager:管控节点
  • Login:登录节点

N 的取值范围:1~10

Compute
SystemDiskCategorystring

第 N 个该节点的系统盘类型。可能值:

  • cloud_efficiency:高效云盘
  • cloud_ssd:SSD 云盘
  • cloud_essd:ESSD 云盘
  • cloud:普通云盘

默认值:cloud_efficiency

N 的取值范围:1~10

cloud_ssd
InternetChargeTypestring

第 N 个该节点的公网付费方式。取值范围:

  • PayByBandwidth:按固定带宽收费
  • PayByTraffic:按流量计费

N 的取值范围:1~10

PayByBandwidth
NetworkTypestring

第 N 个该节点的网络类型,仅支持设置为专有网络 VPC。取值:VPC

N 的取值范围:1~10

VPC
InstanceTypestring

第 N 个该节点的 ECS 实例规格。

N 的取值范围:1~10

ecs.n1.tiny
Periodinteger

第 N 个该节点的 ECS 实例的计费时长。取值范围:

  • 当参数 PriceUnit 取值为 Year 时:1~3
  • 当参数 PriceUnit 取值为 Month 时:1~9
  • 当参数 PriceUnit 取值为 Hour 时:1
  • 当参数 PriceUnit 取值为 Week 时:1~4

默认值:1

N 的取值范围:1~10

1
InternetMaxBandWidthOutinteger

第 N 个该节点公网出带宽最大值。单位为 Mbit/s。

取值范围:0~100

默认值:0

N 的取值范围:1~10

100
DataDisksobject []

随节点创建的数据盘信息列表。

sizeinteger

第 N 个随节点创建的数据盘容量大小。单位:GB

取值范围:40~500

默认值:40

N 的取值范围:0~4

40
categorystring

第 N 个随节点创建的数据盘类型。可能值:

  • cloud_efficiency:高效云盘

  • cloud_ssd:SSD 云盘

  • cloud_essd:ESSD 云盘

  • cloud:普通云盘

默认值:cloud_efficiency

N 的取值范围:0~4

cloud_efficiency
deleteWithInstanceboolean

第 N 个随节点创建的数据盘是否随实例释放。取值范围:

  • true:是

  • false:否

默认值:true

N 的取值范围:0~4

true
performanceLevelstring

第 N 个随节点创建的数据盘类型为 ESSD 云盘时,区分性能等级。仅当 Commodities.N.DataDisks.N.category=cloud_essd 时该参数有效。取值范围:

  • PL0:单盘最高随机读写 IOPS 1 万
  • PL1:单盘最高随机读写 IOPS 5 万
  • PL2:单盘最高随机读写 IOPS 10 万
  • PL3:单盘最高随机读写 IOPS 100 万

默认值:PL1

N 的取值范围:0~4

PL1
encryptedboolean

第 N 个随节点创建的数据盘是否加密。取值范围:

  • true:是

  • false:否

默认值:false

N 的取值范围:0~4

false

返回参数

名称类型描述示例值
object
TotalTradePricefloat

总价格。

单位:元

1258
RequestIdstring

请求 ID。

54FF9025-2C2F-42EB-870D-0DF5B0ACF24E
Pricesobject []

集群价格列表。当请求参数查询集群的多个节点配置价格时,返回值 PriceInfo 内多个元素的顺序与请求参数设置的多个节点信息的顺序依次对应。例如,请求参数中 N=1 的节点信息,对应的返回值为 PriceInfo 内的第一个元素。

OriginalPricefloat

原价。

单位:元

1258
NodeTypestring

节点类型。可能值:

  • Manager:管控节点
  • Login:登录节点
  • Compute:计算节点
Compute
Currencystring

货币单位。可能值:

CNY:人民币

CNY
TradePricefloat

成交价。

单位:元

1258

示例

正常返回示例

JSON格式

{
  "TotalTradePrice": 1258,
  "RequestId": "54FF9025-2C2F-42EB-870D-0DF5B0ACF24E",
  "Prices": {
    "PriceInfo": [
      {
        "OriginalPrice": 1258,
        "NodeType": "Compute",
        "Currency": "<props=\"china\">CNY</props>\n\n<props=\"intl\">USD</props>",
        "TradePrice": 1258
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.无效的参数:%s
404ClusterNotFoundThe specified cluster does not exist.指定的集群不存在,请您检查该参数是否正确。
406EcsErrorAn error occurred while calling the ECS API operation.ECS API调用出错
406DbErrorA database service error occurred.数据库请求失败
406AliyunErrorAn Alibaba Cloud product error occurred.阿里云产品错误
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
407EntityNotExist.RoleThe role does not exist.当前角色不存在
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-27OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 407 变更
    删除错误码:400
    删除错误码:404
    删除错误码:406
    删除错误码:500
    删除错误码:503
2021-12-23OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:406
    删除错误码:407
    删除错误码:500
    删除错误码:503