DescribePrice - 查詢執行個體的價格 - ApsaraDB RDS

該介面用於查詢RDS執行個體的價格資訊。

介面說明

適用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rds:DescribePrice

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字元，且該參數值中不能包含非 ASCII 字元。	ETnLKlblzczshOTUbOCz****
CommodityCode	string	否	當前執行個體的商品碼，取值： bards：主執行個體隨用隨付（中國站） rds（預設）：主執行個體訂用帳戶（中國站） rords：唯讀執行個體隨用隨付（中國站） rds_rordspre_public_cn：唯讀執行個體訂用帳戶（中國站） bards_intl：主執行個體隨用隨付（國際站） rds_intl：主執行個體訂用帳戶（國際站） rords_intl：唯讀執行個體隨用隨付（國際站） rds_rordspre_public_intl：唯讀執行個體訂用帳戶（國際站）說明查詢唯讀執行個體時必須傳入本參數。	rds
RegionId	string	否	地區 ID。可調用 DescribeRegions 擷取。	cn-hangzhou
Engine	string	是	資料庫類型，取值： MySQL SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	是	MySQL：5.5、5.6、5.7、8.0 SQL Server：08r2_ent_ha（雲端硬碟版，已停售）、2008r2（高效能本地碟，已停售）、2012（企業版單機）、2012_ent_ha、2012_std_ha、2012_web、2014_ent_ha、2014_std_ha、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、2022_web PostgreSQL：10.0、11.0、12.0、13.0、14.0、15.0 MariaDB：10.3 資料庫版本，取值： MySQL：5.5、5.6、5.7、8.0 SQL Server：08r2_ent_ha（雲端硬碟版，已停售）、2008r2（高效能本地碟，已停售）、2012（企業版單機）、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、2022_web PostgreSQL：10.0、11.0、12.0、13.0、14.0、15.0 MariaDB：10.3 說明 SQL Server 執行個體中`_ent`表示企業叢集版、`_ent_ha`表示企業版、`_std_ha`表示標準版、`_web`表示 Web 版。	8.0
DBInstanceClass	string	是	執行個體規格，詳情請參見主執行個體規格表。	mysql.x2.medium.xc
DBInstanceStorage	integer	是	執行個體儲存空間，單位：GB。每 5 GB 進行遞增，取值範圍請參見執行個體規格表。	20
PayType	string	否	執行個體的付費類型，取值： Prepaid：預付費（訂用帳戶） Postpaid：後付費（隨用隨付）	Prepaid
ZoneId	string	否	主節點可用性區域 ID。可調用 DescribeRegions 擷取。說明指定了 VPC 和交換器時，為匹配交換器對應的可用性區域，該參數必填。	cn-hangzhou-b
UsedTime	integer	否	指定購買時間長度，取值：當參數 TimeType 為 Year 時，UsedTime 取值為1~100。當參數 TimeType 為 Month 時，UsedTime 取值為1~999。預設值：1。	1
TimeType	string	否	訂用帳戶的付費類型，當 CommodityCode 參數的值為 rds、rds_rordspre_public_cn、rds_intl或rds_rordspre_public_intl時必傳。取值： Year：包年 Month：包月	Year
Quantity	integer	是	購買執行個體的數量，取值範圍：0~30。	10
InstanceUsedType	integer	否	執行個體類型，取值： 0：主執行個體 3：唯讀執行個體	0
OrderType	string	否	訂單類型，取值： BUY：購買 RENEW：續約 UPGRADE：升級 DOWNGRADE：降級	BUY
DBInstanceStorageType	string	否	執行個體儲存類型，取值： general_essd：高效能雲端硬碟 local_ssd：高效能本地碟 cloud_ssd：SSD 雲端硬碟 cloud_essd：ESSD PL1 雲端硬碟 cloud_essd2：ESSD PL2 雲端硬碟 cloud_essd3：ESSD PL3 雲端硬碟	local_ssd
DBInstanceId	string	否	變更配置或續約的執行個體 ID。說明需要查詢執行個體變更配置或續約價格時需要傳入該參數。如果為唯讀執行個體，則需要傳入其主執行個體的 ID。	rm-****
DBNode	array<object>	否	節點相關資訊。說明該參數用於 MySQL 叢集系列執行個體。
	object	否	節點詳情。
ClassCode	string	否	節點規格。	mysql.x2.medium.xc
ZoneId	string	否	節點可用性區域 ID。	cn-hangzhou-j
ServerlessConfig	object	否	RDS Serverless 執行個體的相關設定。說明 MariaDB 不支援 Serverless 執行個體。
MaxCapacity	number	否	執行個體 RCU（RDS Capacity Unit）的自動擴縮範圍最大值。	8
MinCapacity	number	否	執行個體 RCU（RDS Capacity Unit）的自動擴縮範圍最小值。	0.5

返回參數

名稱	類型	描述	樣本值
	object	返回參數詳情。
OrderParams	string	訂單參數。說明僅當 OrderParamOut 參數傳入 true 時，返回該參數。	{\"autoPay\":false}"
PriceInfo	object	價格資訊。
ActivityInfo	object	價格資訊。
CheckErrMsg	string	錯誤描述。	Error description
ErrorCode	string	錯誤碼。	123456
Success	string	是否成功。	Success
Coupons	object
Coupon	array<object>	優惠資訊列表。
	object	優惠詳情資訊。
CouponNo	string	優惠券編號。	123456
Description	string	優惠券描述。	test
IsSelected	string	是否已選擇優惠券。	true
Name	string	優惠券名稱。	test
Currency	string	貨幣單位。	CNY
DiscountPrice	number	折扣。	0
OrderLines	any	訂單資訊。	Order Information
OriginalPrice	number	原價。	10508
RuleIds	object
RuleId	array	活動 ID 列表。
	string	活動 ID。	100119****
TradeMaxRCUAmount	number	根據使用者所選擇的最大 RCU 計算出的每小時費用預估。	1**
TradeMinRCUAmount	number	根據使用者所選擇的最小 RCU 計算出的每小時費用預估。	2**
TradePrice	number	最終價，為原價減去折扣。	10508
RequestId	string	請求 ID。	CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6
Rules	object
Rule	array<object>	活動規格列表。
	object	活動詳細。
Description	string	活動描述。	Activity Description
Name	string	活動名稱。	Rule1
RuleId	integer	活動 ID。	102002100393****
ServerlessPrice	object	Serverless 價格資訊。
RCUDiscountMaxAmount	number	maxRCU 優惠金額。	1*.
RCUDiscountMinAmount	number	minRCU 優惠金額。	1.
RCUOriginalMaxAmount	number	maxRCU 價格。	2*.
RCUOriginalMinAmount	number	minRCU 價格。	3.
StorageOriginalAmount	number	磁碟原始價格。	1*
TotalOriginalMaxAmount	number	優惠前總價最大值。	2*.
TotalOriginalMinAmount	number	優惠前總價最小值。	2.
TradeMaxRCUAmount	number	maxRCU 交易價格。	1*.
TradeMinRCUAmount	number	minRCU 交易價格。	2.
storageDiscountAmount	number	磁碟折扣價格。	2.*
ShowDiscount	boolean	是否允許使用折扣。	true
TradeMaxRCUAmount	number	根據使用者所選擇的最大 RCU 計算出的每小時費用預估。	2**
TradeMinRCUAmount	number	根據使用者所選擇的最小 RCU 計算出的每小時費用預估。	1**

樣本

正常返回樣本

JSON格式

{
  "OrderParams": "{\\\"autoPay\\\":false}\"\n",
  "PriceInfo": {
    "ActivityInfo": {
      "CheckErrMsg": "Error description",
      "ErrorCode": " 123456",
      "Success": "Success"
    },
    "Coupons": {
      "Coupon": [
        {
          "CouponNo": "123456",
          "Description": "test",
          "IsSelected": "true",
          "Name": "test"
        }
      ]
    },
    "Currency": "CNY",
    "DiscountPrice": 0,
    "OrderLines": "Order Information",
    "OriginalPrice": 10508,
    "RuleIds": {
      "RuleId": [
        "100119****"
      ]
    },
    "TradeMaxRCUAmount": 0,
    "TradeMinRCUAmount": 0,
    "TradePrice": 10508
  },
  "RequestId": "CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6",
  "Rules": {
    "Rule": [
      {
        "Description": "Activity Description",
        "Name": "Rule1",
        "RuleId": 0
      }
    ]
  },
  "ServerlessPrice": {
    "RCUDiscountMaxAmount": 0,
    "RCUDiscountMinAmount": 0,
    "RCUOriginalMaxAmount": 0,
    "RCUOriginalMinAmount": 0,
    "StorageOriginalAmount": 0,
    "TotalOriginalMaxAmount": 0,
    "TotalOriginalMinAmount": 0,
    "TradeMaxRCUAmount": 0,
    "TradeMinRCUAmount": 0,
    "storageDiscountAmount": 0
  },
  "ShowDiscount": true,
  "TradeMaxRCUAmount": 0,
  "TradeMinRCUAmount": 0
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	DBInstanceStorageFormatFault	DBInstanceStorageFormatFault
400	InvalidDBInstanceStorage.Format	InvalidDBInstanceStorage.Format	執行個體儲存大小不符合要求，請檢查。
400	DBNodeParameter.InvalidClassCode	The ClassCode of the item of the specified parameter DBNode is inconsistent.	參數DBNode中的ClassCode配置不一致。
400	Price.WanHuaTong.sys	Inquiry error.	詢價錯誤。
400	SYSTEM.SaleValidateFailed	The request not refer to the correct order period. please check your Period or UsedTime param.	該請求未提及正確的訂購期限。請檢查您的Period或UsedTime參數。
400	Price.HsfTimeoutError	Inquiry error.	詢價錯誤。
400	Rule.HsfTimeoutError	Request rule service error.	請求規則服務錯誤。
400	InvalidDBInstanceClassNotFound	Specified DB instance class is not found.	指定的執行個體不存在或不支援
400	System.SaleValidateFailed	Sales expression validation system error.	銷售運算式校正系統錯誤。
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐執行個體不允許單獨操作。
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	定價計劃價格結果沒有找到。
400	Order.NoRealNameAuthentication	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.	您還未通過實名認證，不符合購買條件，請登入費用與成本進行實名認證。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的賬戶可用額度小於0，請先儲值後再嘗試購買。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	調用商品服務返回失敗。
400	RegionDissolvedEOM	Dear 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.	客戶您好，阿里雲計劃對當前地區進行最佳化調整，該地區雲端服務將停止營運，為確保您的商務持續性及資料移轉工作的平穩過渡，您目前無法操作新購類型的訂單，感謝理解與支援。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您購買的模組不合法，請重新購買。
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	客戶您好，該地區已裁撤。
400	Price.CommoditySys	Commodity system call exception.	商品系統調用異常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	您選購的周期有問題，請重新選購。
400	pay.noCreditCard	Account not bound to credit card.	賬戶未綁定信用卡。
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	您選購的服務存在未支付訂單，請支付或作廢后再下單。
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	沒有為您的賬戶指定付款條件。我們建議您添加一種付款條件。
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	您的基本資料未完善，請在操作前先完善您的基本資料。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的賬戶出現異常，詳情請聯絡客服。
400	Api.NotSupport	Specified api is not supported.	當前介面不支援。
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	存在禁止下單的標籤，請聯絡您的分銷商處理
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	提供的DBInstanceId不存在。
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	當前執行個體規格不支援該儲存類型。
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	指定的 wal_level 參數無效。執行個體中仍然存在複製槽，因此無法將其設定為replica。
400	KmsApiError	User secret key invalid.	使用者密鑰失效。
400	Abs.InvalidAccount.NotFound	account is not found.	賬戶不存在。
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	sql命令執行失敗或執行逾時
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	當前執行個體引擎版本不支援歸檔冷資料。
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	當前核心版本不支援歸檔冷資料。
400	IncorrectTargetClasscode	The current instance type does not support this operation.	當前規格不支援此操作。
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	連結地址名重複，請重新設定連接字串。
400	RequiredParam.NotFound	Required input param is not found.	沒有傳入必要的參數。
400	Parameters.Invalid	Parameter error, please check the parameters.	參數錯誤，請檢查參數。
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	資料歸檔不支援跨地區備份和秒級快照，請檢查備份策略。
400	InvalideStatus.Format	The instance status does not support this operation.	執行個體狀態不支援此操作。
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	執行個體釋放後的歸檔備份保留原則無效。
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	DB執行個體引擎類型不支援此操作。
400	Pay.NoCreditCard	No credit cards.	無信用卡。
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	vpc網路類型執行個體不支援此操作。
400	MirrorInsExists	Specified DB instance mirror ins already existed.	當前資料庫執行個體鏡像已存在。
400	UnsupportedClassCode	The specified DB instance class stops selling.	執行個體規格停止售賣。
400	InvalidBackupSet	The specified database does not exist in the backup set.	備份組中沒有指定的資料庫。
400	OrdTCommodityQueryError	Failed to query for product.	查詢產品失敗。
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	執行個體已釋放，請核實後下單。
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	指定的地區無效。
400	DBNodeFormatFault	The specified parameter DBNode is malformed	dbNode格式不正確
400	DBNodeParameter.Required	The DBNode parameter is required for RDS for MySQL Cluster Edition instances.	RDS MySQL叢集系列執行個體，參數DBNode為必填項。
400	DBNodeParameter.TooFewItems	You must configure at least 2 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.	RDS MySQL叢集系列執行個體，參數DBNode最少需配置2個節點。
400	DBNodeParameter.TooManyItems	You can configure up to 9 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.	RDS MySQL叢集系列執行個體，參數DBNode最大支援配置9個節點。
500	ExternalFailure	The request processing has failed due to external service failure.	請求服務失敗，請稍後重試。
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	請求服務失敗，請稍後再試或聯絡服務人員。
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	由於rds api服務失敗，請求處理失敗。
403	CASH.BOOK.INSUFFICIENT	No payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000.	賬戶沒有指定付款條件.
403	RegionDissolvedInduEOFS	Alibaba Cloud plans to optimize and adjust the region in India. Cloud services in this region will stop operating. you are currently unable to operate new purchase, renewal, and configuration change orders.	客戶您好，阿里雲計劃對印度地區進行最佳化調整，該地區雲端服務將停止營運，為確保您的商務持續性及資料移轉工作的平穩過渡，您目前無法操作新購、續約、變更配置類型的訂單，感謝理解與支援。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	執行個體當前存在未支付訂單，請支付後重試。
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	縮容目標容量不能小於當前儲存空間使用量
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	SSD盤不支援此操作，請升級至ESSD。
403	InvalidUserOperatorPermission	The user permission does not support this operation.	使用者權限不支援此操作。
403	InvalidVswitchId	Specified conn vswitch id is not valid.	指定的VSwitchId格式不正確或為空白
403	IncorrectMinorVersion	Current engine minor version does not support operations.	當前引擎小版本不支援此操作。
403	OperationDenied.ZoneResource	There is no available zone for inventory.	沒有可用的庫存地區。
403	NotInFlowController	Sorry,no permission.	非集團上雲使用者不可用，無許可權。
403	InvalidKmsKey	Kms key is disabled.	Kms key已禁用。
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	當前資料庫執行個體層級不支援此操作。
404	InvalidTimeType.NotFound	The parameter timeType does not exist.	請檢查 TimeType 參數。可選值為 Year、Month、Day
404	canNotFindSubscription	Subscription information not found.	找不到訂購資訊。
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	當前執行個體未授權存取金鑰管理服務。
404	Request.NotFound	The requested resource is not available.	請求的資源不可用。
404	HostInfo.NotFound	The specified host info is not found.	指定的主機資訊不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。