All Products
Search
Document Center

ApsaraDB RDS:DescribePrice

Last Updated:May 22, 2024

Queries the price of an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCz*****
CommodityCodestringNo

The commodity code of the instance. Valid values:

  • bards: The instance is a pay-as-you-go primary instance. This value is available at the China site (aliyun.com).
  • rds: The instance is a subscription primary instance. This is the default value. This value is available at the China site (aliyun.com).
  • rords: The instance is a pay-as-you-go read-only instance. This value is available at the China site (aliyun.com).
  • rds_rordspre_public_cn: The instance is a subscription read-only instance. This value is available at the China site (aliyun.com).
  • bards_intl: The instance is a pay-as-you-go primary instance. This value is available at the International site (alibabacloud.com).
  • rds_intl: The instance is a subscription primary instance. This value is available at the International site (alibabacloud.com).
  • rords_intl: The instance is a pay-as-you-go read-only instance. This value is available at the International site (alibabacloud.com).
  • rds_rordspre_public_intl: The instance is a subscription read-only instance. This value is available on the International site (alibabacloud.com).
Note If you want to query the price of a read-only instance, you must specify this parameter.
rds
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
EnginestringYes

The database engine of the instance. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
MySQL
EngineVersionstringYes

The database engine version of the instance.

  • Valid values if you set Engine to MySQL: 5.5, 5.6, 5.7, and 8.0
  • Valid values if you set Engine to SQLServer: 08r2_ent_ha (cloud disks, discontinued), 2008r2(local disks, discontinued), 2012 (SQL Server EE Basic), 2012_ent_ha, 2012_std_ha, 2012_web, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_ent, 2017_std_ha, 2017_web, 2019_ent, 2019_std_ha, 2019_web, 2022_ent, 2022_std_ha, and 2022_web
  • Valid values if you set Engine to PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, and 15.0
  • Valid value if you set Engine to MariaDB: 10.3
Note The following information describes the valid values when you set Engine to SQLServer: _ent specifies SQL Server EE on RDS Cluster Edition, _ent_ha specifies SQL Server EE, _std_ha specifies SQL Server SE, and _web specifies SQL Server Web.
5.5
DBInstanceClassstringYes

The instance type of the instance. For more information, see Primary ApsaraDB RDS instance types.

rds.mysql.s1.small
DBInstanceStorageintegerYes

The storage capacity of the instance. Unit: GB. You can increase the storage capacity at a step size of 5 GB. For more information, see Primary ApsaraDB RDS instance types.

20
PayTypestringNo

The billing method of the instance. Valid values:

  • Prepaid: subscription
  • Postpaid: pay-as-you-go
Prepaid
ZoneIdstringNo

The zone ID of the primary instance. You can call the DescribeRegions operation to query the most recent zone list.

Note If you specify a virtual private cloud (VPC) and a vSwitch, this parameter is required to identify the zone for the vSwitch.
cn-hangzhou-b
UsedTimeintegerNo

The subscription duration of the instance.

  • If you set the TimeType parameter to Year, the value of the UsedTime parameter ranges from 1 to 100.
  • If you set the TimeType parameter to Month, the value of the UsedTime parameter ranges from 1 to 999.

Default value: 1.

1
TimeTypestringNo

The billing cycle of the subscription instance. This parameter is required when CommodityCode is set to rds, rds_rordspre_public_cn, rds_intl, or rds_rordspre_public_intl. Valid values:

  • Year
  • Month
Year
QuantityintegerYes

The number of instances that you want to purchase. Valid values: 0 to 30.

10
InstanceUsedTypeintegerNo

The role of the instance. Valid values:

  • 0: primary instance
  • 3: read-only instance
0
OrderTypestringNo

The order type. Valid values:

  • BUY: purchase order
  • UPGRADE: specification change order
  • RENEW: renewal order
BUY
DBInstanceStorageTypestringNo

The storage type of the instance. Valid values:

  • local_ssd: local SSD
  • cloud_ssd: standard SSD
  • cloud_essd: PL1 ESSD
  • cloud_essd2: PL2 ESSD
  • cloud_essd3: PL3 ESSD
local_ssd
DBInstanceIdstringNo

The ID of the instance for which you want to change the specifications or the instance that you want to renew.

Note
  • If you want to query the price of a specification change order or a renewal order, you must specify this parameter.
  • If the instance is a read-only instance, you must set this parameter to the ID of its primary instance.
  • rm-*****
    DBNodeobject []No

    The information about the node.

    Note This parameter is supported for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.
    ClassCodestringNo

    The instance type of the node.

    mysql.n2.small.xc
    ZoneIdstringNo

    The zone ID of the node.

    cn-hangzhou-j
    ServerlessConfigobjectNo

    The settings of the serverless instance.

    Note ApsaraDB RDS for MariaDB does not support serverless instances.
    MaxCapacitydoubleNo

    The maximum number of RDS Capacity Units (RCUs).

    8
    MinCapacitydoubleNo

    The minimum number of RCUs.

    0.5

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    OrderParamsstring

    Order parameters.

    {\"autoPay\":false}"
    RequestIdstring

    The ID of the request.

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

    The price information.

    OriginalPricefloat

    The original price.

    2504
    DiscountPricefloat

    The discount.

    0
    Currencystring

    The currency unit.

    CNY
    TradePricefloat

    The transaction price, which is equal to the original price minus the discount.

    2504
    TradeMinRCUAmountfloat

    Estimated hourly cost calculated based on the minimum RCU selected by the user.

    2**
    TradeMaxRCUAmountfloat

    Estimated hourly cost calculated based on the maximum RCU selected by the user.

    1**
    Couponsobject []

    The information about the coupon.

    IsSelectedstring

    Indicates whether the coupon is selected.

    true
    CouponNostring

    The coupon ID.

    123456
    Namestring

    The coupon name.

    test
    Descriptionstring

    The description of the coupon.

    test
    RuleIdsarray

    An array that consists of the ID of the promotion rule.

    string

    The ID of the promotion rule.

    1001199213
    ActivityInfoobject

    The information about the promotion.

    CheckErrMsgstring

    The returned message.

    Error description
    ErrorCodestring

    The error code that is returned.

    123456
    Successstring

    Indicates whether the request was successful.

    Success
    OrderLinesstring

    Order Information

    Order Information
    Rulesobject []

    The details of the promotion rule.

    Namestring

    The name of the promotion rule.

    Rule1
    Descriptionstring

    The description of the promotion rule.

    Activity Description
    RuleIdlong

    The ID of the promotion rule.

    1020021003939076
    ShowDiscountboolean

    Indicates whether discounts can be used.

    True
    TradeMaxRCUAmountfloat

    The estimated hourly fee that is calculated based on the maximum number of RCUs.

    2**
    TradeMinRCUAmountfloat

    The estimated hourly fee that is calculated based on the minimum number of RCUs.

    1**
    ServerlessPriceobject

    Serverless price information.

    TotalOriginalMinAmountfloat

    The minimum total price before the discount.

    2*.*
    TotalOriginalMaxAmountfloat

    Maximum total price before discount.

    2**.*
    RCUOriginalMinAmountfloat

    MinRCU price.

    3*.*
    RCUOriginalMaxAmountfloat

    MaxRCU price.

    2**.*
    RCUDiscountMinAmountfloat

    MinRCU discount amount.

    1*.*
    RCUDiscountMaxAmountfloat

    MaxRCU discount amount.

    1**.*
    TradeMinRCUAmountfloat

    MinRCU transaction price.

    2*.*
    TradeMaxRCUAmountfloat

    MaxRCU transaction price.

    1**.*
    StorageOriginalAmountfloat

    Original price of the disk.

    1*
    storageDiscountAmountfloat

    Disk discount price.

    2.*

    Examples

    Sample success responses

    JSONformat

    {
      "OrderParams": "{\\\"autoPay\\\":false}\"\n",
      "RequestId": "CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6",
      "PriceInfo": {
        "OriginalPrice": 2504,
        "DiscountPrice": 0,
        "Currency": "CNY",
        "TradePrice": 2504,
        "TradeMinRCUAmount": 0,
        "TradeMaxRCUAmount": 0,
        "Coupons": {
          "Coupon": [
            {
              "IsSelected": "true",
              "CouponNo": "123456",
              "Name": "test",
              "Description": "test"
            }
          ]
        },
        "RuleIds": {
          "RuleId": [
            "1001199213"
          ]
        },
        "ActivityInfo": {
          "CheckErrMsg": "Error description",
          "ErrorCode": " 123456",
          "Success": "Success"
        },
        "OrderLines": "Order Information"
      },
      "Rules": {
        "Rule": [
          {
            "Name": "Rule1",
            "Description": "Activity Description",
            "RuleId": 1020021003939076
          }
        ]
      },
      "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
      }
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400DBInstanceStorageFormatFaultDBInstanceStorageFormatFault-
    400InvalidDBInstanceStorage.FormatInvalidDBInstanceStorage.FormatThe storage capacity is invalid. Check the storage capacity.
    400DBNodeParameter.InvalidClassCodeThe ClassCode of the item of the specified parameter DBNode is inconsistent.The ClassCode configuration is invalid for the DBNode parameter.
    400DBNodeParameter.RequiredThe specified parameter DBNode is required.You must specify the DBNode parameter.
    400DBNodeParameter.TooFewItemsThe specified parameter DBNode has too few items.A small number of DBNode parameter items are configured.
    400DBNodeParameter.TooManyItemsThe specified parameter DBNode has too many items.A large number of DBNode parameter items are configured.
    400Price.WanHuaTong.sysInquiry error.-
    400SYSTEM.SaleValidateFailedThe request not refer to the correct order period. please check your Period or UsedTime param.-
    400Price.HsfTimeoutErrorInquiry error.-
    400Rule.HsfTimeoutErrorRequest rule service error.-
    400InvalidDBInstanceClassNotFoundSpecified DB instance class is not found.The specified instance does not exist or does not support
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
    400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing 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.You 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.Your account available limit is less than 0, please recharge before trying to purchase.
    400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
    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.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.The 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.Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
    400Price.CommoditySysCommodity system call exception.Commodity system call exception.
    400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There 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.There 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.Your basic information is not complete, please complete your basic information before operation.
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
    400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    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.No payment method is specified for the account.
    403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
    404InvalidTimeType.NotFoundThe parameter timeType does not exist.Check the TimeType parameter. Valid values: Year, Month, and Day.
    404canNotFindSubscriptionSubscription information not found.-

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

    Change history

    Change timeSummary of changesOperation
    2024-04-11The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Output ParametersThe response structure of the API has changed.
    2023-11-17The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-09-08The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
      delete Error Codes: 403
    2023-07-03The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ServerlessConfig
    Output ParametersThe response structure of the API has changed.
    2023-05-24The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Output ParametersThe response structure of the API has changed.
    2023-05-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
      Added Error Codes: 403