文档

DescribePrice - 查询实例的价格

更新时间:

该接口用于查询RDS实例的价格信息。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

ETnLKlblzczshOTUbOCz****
CommodityCodestring

当前实例的商品码,取值:

  • bards:主实例按量付费(中国站)
  • rds(默认):主实例包年包月(中国站)
  • rords:只读实例按量付费(中国站)
  • rds_rordspre_public_cn:只读实例包年包月(中国站)
  • bards_intl:主实例按量付费(国际站)
  • rds_intl:主实例包年包月(国际站)
  • rords_intl:只读实例按量付费(国际站)
  • rds_rordspre_public_intl:只读实例包年包月(国际站)
说明 查询只读实例时必须传入本参数。
rds
RegionIdstring

地域 ID。可调用 DescribeRegions 获取。

cn-hangzhou
Enginestring

数据库类型,取值:

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
MySQL
EngineVersionstring

数据库版本,取值:

  • MySQL5.55.65.78.0
  • SQL Server08r2_ent_ha(云盘版,已停售)、2008r2(本地盘,已停售)、2012(企业版单机)、2012_ent_ha2012_std_ha2012_web2014_ent_ha2014_std_ha2016_ent_ha2016_std_ha2016_web2017_ent2017_std_ha2017_web2019_ent2019_std_ha2019_web2022_ent2022_std_ha2022_web
  • PostgreSQL10.011.012.013.014.015.0
  • MariaDB10.3
说明 SQL Server 实例中_ent表示企业集群版、_ent_ha表示企业版、_std_ha表示标准版、_web表示 Web 版。
8.0
DBInstanceClassstring

实例规格,详情请参见主实例规格表

mysql.x2.medium.xc
DBInstanceStorageinteger

实例存储空间,单位:GB。每 5 GB 进行递增,取值范围请参见实例规格表

20
PayTypestring

实例的付费类型,取值:

  • Prepaid:预付费(包年包月)
  • Postpaid:后付费(按量付费)
Prepaid
ZoneIdstring

主节点可用区 ID。可调用 DescribeRegions 获取。

说明 指定了 VPC 和交换机时,为匹配交换机对应的可用区,该参数必填。
cn-hangzhou-b
UsedTimeinteger

指定购买时长,取值:

  • 当参数 TimeTypeYear 时,UsedTime 取值为1~100
  • 当参数 TimeTypeMonth 时,UsedTime 取值为1~999

默认值:1

1
TimeTypestring

包年包月的付费类型,当 CommodityCode 参数的值为 rdsrds_rordspre_public_cnrds_intlrds_rordspre_public_intl时必传。取值:

  • Year:包年
  • Month:包月
Year
Quantityinteger

购买实例的数量,取值范围:0~30

10
InstanceUsedTypeinteger

实例类型,取值:

  • 0:主实例
  • 3:只读实例
0
OrderTypestring

订单类型,取值:

  • BUY:购买
  • UPGRADE:变配
  • RENEW:续费
BUY
DBInstanceStorageTypestring

实例存储类型,取值:

  • local_ssd:本地 SSD 盘
  • cloud_ssd:SSD 云盘
  • cloud_essd:ESSD PL1 云盘
  • cloud_essd2:ESSD PL2 云盘
  • cloud_essd3:ESSD PL3 云盘
local_ssd
DBInstanceIdstring

变配或续费的实例 ID。

说明
  • 需要查询实例变配或续费价格时需要传入该参数。
  • 如果为只读实例,则需要传入其主实例的 ID。
  • rm-****
    DBNodeobject []

    节点相关信息。

    说明 该参数用于 MySQL 集群系列实例。
    ClassCodestring

    节点规格。

    mysql.x2.medium.xc
    ZoneIdstring

    节点可用区 ID。

    cn-hangzhou-j
    ServerlessConfigobject

    RDS Serverless 实例的相关设置。

    说明 MariaDB 不支持 Serverless 实例。
    MaxCapacitydouble

    实例 RCU(RDS Capacity Unit)的自动扩缩范围最大值。

    8
    MinCapacitydouble

    实例 RCU(RDS Capacity Unit)的自动扩缩范围最小值。

    0.5

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    RequestIdstring

    请求 ID。

    CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6
    PriceInfoobject

    价格信息。

    OriginalPricefloat

    原价。

    10508
    DiscountPricefloat

    折扣。

    0
    Currencystring

    货币单位。

    CNY
    TradePricefloat

    最终价,为原价减去折扣。

    10508
    Couponsobject []

    优惠信息列表。

    IsSelectedstring

    是否已选择优惠券。

    true
    CouponNostring

    优惠券编号。

    123456
    Namestring

    优惠券名称。

    test
    Descriptionstring

    优惠券描述。

    test
    RuleIdsarray

    活动 ID 列表。

    string

    活动 ID。

    100119****
    ActivityInfoobject

    价格信息。

    CheckErrMsgstring

    错误描述。

    Error description
    ErrorCodestring

    错误代码。

    123456
    Successstring

    是否成功。

    Success
    Rulesobject []

    活动规格列表。

    Namestring

    活动名称。

    Rule1
    Descriptionstring

    活动描述。

    Activity Description
    RuleIdlong

    活动 ID。

    102002100393****
    ShowDiscountboolean

    是否允许使用折扣。

    true
    TradeMaxRCUAmountfloat

    根据用户所选择的最大 RCU 计算出的每小时费用预估。

    2**
    TradeMinRCUAmountfloat

    根据用户所选择的最小 RCU 计算出的每小时费用预估。

    1**

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6",
      "PriceInfo": {
        "OriginalPrice": 10508,
        "DiscountPrice": 0,
        "Currency": "CNY",
        "TradePrice": 10508,
        "Coupons": {
          "Coupon": [
            {
              "IsSelected": "true",
              "CouponNo": "123456",
              "Name": "test",
              "Description": "test"
            }
          ]
        },
        "RuleIds": {
          "RuleId": [
            "100119****"
          ]
        },
        "ActivityInfo": {
          "CheckErrMsg": "Error description",
          "ErrorCode": " 123456",
          "Success": "Success"
        }
      },
      "Rules": {
        "Rule": [
          {
            "Name": "Rule1",
            "Description": "Activity Description",
            "RuleId": 0
          }
        ]
      },
      "ShowDiscount": true,
      "TradeMaxRCUAmount": 0,
      "TradeMinRCUAmount": 0
    }

    错误码

    HTTP status code错误码错误信息描述
    400DBInstanceStorageFormatFaultDBInstanceStorageFormatFault-
    400InvalidDBInstanceStorage.FormatInvalidDBInstanceStorage.Format实例存储大小不符合要求,请检查。
    400DBNodeParameter.InvalidClassCodeThe ClassCode of the item of the specified parameter DBNode is inconsistent.参数DBNode中的ClassCode配置不一致。
    400DBNodeParameter.RequiredThe specified parameter DBNode is required.参数DBNode是必需的。
    400DBNodeParameter.TooFewItemsThe specified parameter DBNode has too few items.参数DBNode中的配置项过少。
    400DBNodeParameter.TooManyItemsThe specified parameter DBNode has too many items.参数DBNode中的配置项过多。
    400Price.WanHuaTong.sysInquiry error.询价错误。
    400SYSTEM.SaleValidateFailedThe request not refer to the correct order period. please check your Period or UsedTime param.该请求未提及正确的订购期限。 请检查您的Period或UsedTime参数。
    400Price.HsfTimeoutErrorInquiry error.询价错误。
    400Rule.HsfTimeoutErrorRequest rule service error.请求规则服务错误。
    400InvalidDBInstanceClassNotFoundSpecified DB instance class is not found.指定的实例不存在或不支持
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
    400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
    403CASH.BOOK.INSUFFICIENTNo payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000.帐户没有指定付款方式.
    404InvalidTimeType.NotFoundThe parameter timeType does not exist.请检查 TimeType 参数。可选值为 Year、Month、Day
    404canNotFindSubscriptionSubscription information not found.找不到订购信息。

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

    变更历史

    变更时间变更内容概要操作
    2023-11-17OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
    2023-09-08OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      错误码 404 变更
      删除错误码:403
    2023-07-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:ServerlessConfig
    出参OpenAPI 返回结构发生变更
    2023-05-24OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2023-05-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
      新增错误码:403
    • 本页导读 (1)
    文档反馈