文档

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-****
    DBNodearray<object>

    节点相关信息。

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

    节点详情。

    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

    返回参数详情。

    OrderParamsstring

    订单参数。

    说明 仅当 OrderParamOut 参数传入 true 时,返回该参数。
    {\"autoPay\":false}"
    RequestIdstring

    请求 ID。

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

    价格信息。

    OriginalPricefloat

    原价。

    10508
    DiscountPricefloat

    折扣。

    0
    Currencystring

    货币单位。

    CNY
    TradePricefloat

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

    10508
    TradeMinRCUAmountfloat

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

    2**
    TradeMaxRCUAmountfloat

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

    1**
    Couponsarray<object>

    优惠信息列表。

    object

    优惠详情信息。

    IsSelectedstring

    是否已选择优惠券。

    true
    CouponNostring

    优惠券编号。

    123456
    Namestring

    优惠券名称。

    test
    Descriptionstring

    优惠券描述。

    test
    RuleIdsarray

    活动 ID 列表。

    string

    活动 ID。

    100119****
    ActivityInfoobject

    价格信息。

    CheckErrMsgstring

    错误描述。

    Error description
    ErrorCodestring

    错误代码。

    123456
    Successstring

    是否成功。

    Success
    OrderLinesstring

    订单信息。

    Order Information
    Rulesarray<object>

    活动规格列表。

    object

    活动详细。

    Namestring

    活动名称。

    Rule1
    Descriptionstring

    活动描述。

    Activity Description
    RuleIdlong

    活动 ID。

    102002100393****
    ShowDiscountboolean

    是否允许使用折扣。

    true
    TradeMaxRCUAmountfloat

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

    2**
    TradeMinRCUAmountfloat

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

    1**
    ServerlessPriceobject

    Serverless 价格信息。

    TotalOriginalMinAmountfloat

    优惠前总价最小值。

    2*.*
    TotalOriginalMaxAmountfloat

    优惠前总价最大值。

    2**.*
    RCUOriginalMinAmountfloat

    minRCU 价格。

    3*.*
    RCUOriginalMaxAmountfloat

    maxRCU 价格。

    2**.*
    RCUDiscountMinAmountfloat

    minRCU 优惠金额。

    1*.*
    RCUDiscountMaxAmountfloat

    maxRCU 优惠金额。

    1**.*
    TradeMinRCUAmountfloat

    minRCU 交易价格。

    2*.*
    TradeMaxRCUAmountfloat

    maxRCU 交易价格。

    1**.*
    StorageOriginalAmountfloat

    磁盘原始价格。

    1*
    storageDiscountAmountfloat

    磁盘折扣价格。

    2.*

    示例

    正常返回示例

    JSON格式

    {
      "OrderParams": "{\\\"autoPay\\\":false}\"\n",
      "RequestId": "CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6",
      "PriceInfo": {
        "OriginalPrice": 10508,
        "DiscountPrice": 0,
        "Currency": "CNY",
        "TradePrice": 10508,
        "TradeMinRCUAmount": 0,
        "TradeMaxRCUAmount": 0,
        "Coupons": {
          "Coupon": [
            {
              "IsSelected": "true",
              "CouponNo": "123456",
              "Name": "test",
              "Description": "test"
            }
          ]
        },
        "RuleIds": {
          "RuleId": [
            "100119****"
          ]
        },
        "ActivityInfo": {
          "CheckErrMsg": "Error description",
          "ErrorCode": " 123456",
          "Success": "Success"
        },
        "OrderLines": "Order Information"
      },
      "Rules": {
        "Rule": [
          {
            "Name": "Rule1",
            "Description": "Activity Description",
            "RuleId": 0
          }
        ]
      },
      "ShowDiscount": true,
      "TradeMaxRCUAmount": 0,
      "TradeMinRCUAmount": 0,
      "ServerlessPrice": {
        "TotalOriginalMinAmount": 0,
        "TotalOriginalMaxAmount": 0,
        "RCUOriginalMinAmount": 0,
        "RCUOriginalMaxAmount": 0,
        "RCUDiscountMinAmount": 0,
        "RCUDiscountMaxAmount": 0,
        "TradeMinRCUAmount": 0,
        "TradeMaxRCUAmount": 0,
        "StorageOriginalAmount": 0,
        "storageDiscountAmount": 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.指定的实例不存在或不支持
    400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
    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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
    400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
    400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
    400Price.CommoditySysCommodity system call exception.商品系统调用异常。
    400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
    400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
    400Api.NotSupportSpecified api is not supported.当前接口不支持。
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
    400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
    400KmsApiErrorUser secret key invalid.用户密钥失效。
    400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
    400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.sql命令执行失败或执行超时
    400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.当前实例引擎版本不支持归档冷数据。
    400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.当前内核版本不支持归档冷数据。
    400IncorrectTargetClasscodeThe current instance type does not support this operation.当前规格不支持此操作。
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.链接地址名重复,请重新设置连接字符串。
    400RequiredParam.NotFoundRequired input param is not found.没有传入必要的参数。
    400Parameters.InvalidParameter error, please check the parameters.参数错误,请检查参数。
    400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.数据归档不支持跨地域备份和秒级快照,请检查备份策略。
    400InvalideStatus.FormatThe instance status does not support this operation.实例状态不支持此操作。
    400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.实例释放后的归档备份保留策略无效。
    400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.DB实例引擎类型不支持此操作。
    400Pay.NoCreditCardNo credit cards.无信用卡。
    400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.vpc网络类型实例不支持此操作。
    400MirrorInsExistsSpecified DB instance mirror ins already existed.当前数据库实例镜像已存在。
    400UnsupportedClassCodeThe specified DB instance class stops selling.实例规格停止售卖。
    400InvalidBackupSetThe specified database does not exist in the backup set.备份集中没有指定的数据库。
    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.帐户没有指定付款方式.
    403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
    403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
    403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
    403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
    403OperationDenied.ZoneResourceThere is no available zone for inventory.没有可用的库存区域。
    403NotInFlowControllerSorry,no permission.非集团上云用户不可用,无权限。
    403InvalidKmsKeyKms key is disabled.Kms key已禁用。
    403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.当前数据库实例级别不支持此操作。
    404InvalidTimeType.NotFoundThe parameter timeType does not exist.请检查 TimeType 参数。可选值为 Year、Month、Day
    404canNotFindSubscriptionSubscription information not found.找不到订购信息。
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
    404Request.NotFoundThe requested resource is not available.请求的资源不可用。
    404HostInfo.NotFoundThe specified host info is not found.指定的主机信息不存在。
    500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。
    500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.请求服务失败,请稍后再试或联系服务人员。

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

    变更历史

    变更时间变更内容概要操作
    2024-05-24OpenAPI 错误码发生变更查看变更详情
    2024-04-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-11-17OpenAPI 错误码发生变更查看变更详情
    2023-09-08OpenAPI 错误码发生变更查看变更详情
    2023-07-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-05-24OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-05-12OpenAPI 错误码发生变更查看变更详情