DescribeDBClusterPrice - PolarDB - Alibaba Cloud Documentation Center

Queries the price of a cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
DBNodeClass	string	No	The node specifications. Required for the BUY scenario. Example format: polar.mysql.x4.large.	polar.mysql.x4.large
DBType	string	No	The database engine type. Required for the BUY scenario. Valid values: MySQL, PostgreSQL, and Oracle.	MySQL
DBVersion	string	No	The database engine version. Required for the BUY scenario. Valid values for MySQL: 5.6, 5.7, and 8.0. Valid values for PostgreSQL: 11 and 14. Valid values for Oracle: 11 and 14.	8.0
PayType	string	No	The billing method. Required for the BUY and CONVERT scenarios. Valid values: Prepaid: subscription. Postpaid: pay-as-you-go.	Prepaid
OrderType	string	Yes	The order type. Valid values: BUY: new purchase. CONVERT: billing method conversion. RENEW: renewal. UPGRADE: upgrade specifications or add nodes. DOWNGRADE: downgrade specifications or remove nodes.	BUY
RegionId	string	Yes	The region ID.	cn-hangzhou
ZoneId	string	No	The zone ID. We recommend that you specify this parameter for the BUY scenario.	cn-hangzhou-h
DBNodeNum	integer	No	The number of nodes. Valid for the BUY scenario. This value includes the read/write node. Minimum value: 1. Default value: 1.	2
CreationCategory	string	No	The cluster edition. Valid values: Normal: Cluster Edition. Basic: Single Node Edition. ArchiveNormal: Archive Database. SENormal: Standard Edition. NormalMultimaster: Multi-master Cluster.	Normal
StorageSpace	string	No	The storage space, in GB. Used for prepaid storage or storage specification change scenarios.	50
StorageType	string	No	The storage type. Valid values: PSL5: high performance. PSL4: standard. ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL	PSL5
StorageChargeType	string	No	The storage billing type. Valid values: Prepaid: subscription. Postpaid: pay-as-you-go.	Prepaid
ProvisionedIops	string	No	The provisioned IOPS. Used for the Standard Edition (SENormal) scenario.	1000
HotStandbyCluster	string	No	Specifies whether to enable the hot standby cluster. Valid values: ON: Enable. OFF: Disable. Valid for the BUY and specification change scenarios.	ON
ServerlessType	string	No	The serverless type. Valid values: AgileServerless.	AgileServerless
DBClusterId	string	No	The cluster ID. Required for non-BUY scenarios.	pc-**************
UsedTime	string	No	The subscription duration. Used together with Period. Valid for the BUY, CONVERT, and RENEW scenarios when the billing method is Prepaid.	1
Period	string	No	The subscription cycle. Valid values: Month: monthly. Year: yearly.	Month
DBNodes	array<object>	No	The list of heterogeneous specification change nodes. Used for specification change scenarios to specify the target specifications for each node.
	object	No	The node information.
DBNodeId	string	No	The node ID.	pi-**************
DBNodeClass	string	No	The target node specifications.	polar.mysql.x4.large
ModifyType	string	No	The specification change direction. Valid values: ADD: add nodes. DELETE: remove nodes. UPGRADE: upgrade specifications. DOWNGRADE: downgrade specifications. HOT_STANDBY: hot standby change. STORAGE: storage space change. STORAGE_TYPE: storage type change.	UPGRADE
DBNodeIds	array	No	The list of node IDs to delete. Used when ModifyType is set to DELETE.	pi-**************
	string	No	The node ID.	pi-***************

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7E2FE3BB-C677-5FF9-9FC5-XXX
ShowDiscount	boolean	Indicates whether discounts are allowed.	False
OrderType	string	The order type. Valid values: BUY: new purchase. UPGRADE: specification change. RENEW: renewal. CONVERT: billing method conversion.	BUY
PriceInfo	object	The price details.
Currency	string	The currency unit.	CNY
OriginalPrice	number	The original price.	1099.0
TradePrice	number	The final price, which is the original price minus the discount.	165.0
DiscountPrice	number	The discount amount.	1978.2
RuleIds	object
RuleId	array
	string		[8]
Coupons	object
Coupon	array<object>
	object
CouponNo	string		779643240541
Name	string		coupon
IsSelected	string		false
Rules	object
Rule	array<object>	The promotion rule.
	object	The promotion rule.
RuleId	integer		rule-xxx
Name	string		rule-xxx

Examples

Success response

JSON format

{
  "RequestId": "7E2FE3BB-C677-5FF9-9FC5-XXX",
  "ShowDiscount": true,
  "OrderType": "BUY",
  "PriceInfo": {
    "Currency": "CNY",
    "OriginalPrice": 1099,
    "TradePrice": 165,
    "DiscountPrice": 1978.2,
    "RuleIds": {
      "RuleId": [
        "[8]"
      ]
    },
    "Coupons": {
      "Coupon": [
        {
          "CouponNo": "779643240541",
          "Name": "coupon",
          "IsSelected": "false"
        }
      ]
    }
  },
  "Rules": {
    "Rule": [
      {
        "RuleId": 0,
        "Name": "rule-xxx"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.