DescribePrice - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

インスタンスの価格を照会します。

操作説明

サポートされるデータベースエンジン

MySQL
PostgreSQL
SQL Server
MariaDB

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:DescribePrice

get

*DBInstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。	ETnLKlblzczshOTUbOCz****
CommodityCode	string	任意	インスタンスの商品コード。有効値： bards：インスタンスは従量課金のプライマリインスタンスです。この値は中国サイト (aliyun.com) で利用可能です。 rds (デフォルト)：インスタンスはサブスクリプションのプライマリインスタンスです。この値は中国サイト (aliyun.com) で利用可能です。 rords：インスタンスは従量課金の読み取り専用インスタンスです。この値は中国サイト (aliyun.com) で利用可能です。 rds_rordspre_public_cn：インスタンスはサブスクリプションの読み取り専用インスタンスです。この値は中国サイト (aliyun.com) で利用可能です。 bards_intl：インスタンスは従量課金のプライマリインスタンスです。この値は国際サイト (alibabacloud.com) で利用可能です。 rds_intl：インスタンスはサブスクリプションのプライマリインスタンスです。この値は国際サイト (alibabacloud.com) で利用可能です。 rords_intl：インスタンスは従量課金の読み取り専用インスタンスです。この値は国際サイト (alibabacloud.com) で利用可能です。 rds_rordspre_public_intl：インスタンスはサブスクリプションの読み取り専用インスタンスです。この値は国際サイト (alibabacloud.com) で利用可能です。説明読み取り専用インスタンスの価格を照会する場合は、このパラメーターを指定する必要があります。	rds
RegionId	string	任意	リージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
Engine	string	必須	インスタンスのデータベースエンジン。有効値： MySQL SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	必須	インスタンスのデータベースエンジンバージョン。有効値： Engine を MySQL に設定した場合の有効値：5.5、5.6、5.7、8.0 Engine を SQL Server に設定した場合の有効値：08r2_ent_ha (クラウドディスク、提供終了)、2008r2 (パフォーマンス専有型ローカルディスク、提供終了)、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、2022_web Engine を PostgreSQL に設定した場合の有効値：10.0、11.0、12.0、13.0、14.0、15.0 Engine を MariaDB に設定した場合の有効値：10.3 説明 Engine を SQLServer に設定した場合の有効値に関する情報は次のとおりです：`_ent` は RDS Cluster Edition の SQL Server EE を、`_ent_ha` は SQL Server EE を、`_std_ha` は SQL Server SE を、`_web` は SQL Server Web を指定します。	8.0
DBInstanceClass	string	必須	インスタンスのインスタンスタイプ。詳細については、「プライマリ ApsaraDB RDS インスタンスタイプ」をご参照ください。	mysql.x2.medium.xc
DBInstanceStorage	integer	必須	インスタンスのストレージ容量。単位：GB。ストレージ容量は 5 GB 単位で増やすことができます。詳細については、「プライマリ ApsaraDB RDS インスタンスタイプ」をご参照ください。	20
PayType	string	任意	インスタンスの課金方法。有効値： Prepaid：サブスクリプション Postpaid：従量課金	Prepaid
ZoneId	string	任意	プライマリインスタンスのゾーン ID。DescribeRegions 操作を呼び出して、最新のゾーンリストを照会できます。説明 VPC (Virtual Private Cloud) と vSwitch を指定する場合、このパラメーターは vSwitch のゾーンを識別するために必要です。	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：ESSD (エンタープライズ SSD) local_ssd：パフォーマンス専有型ローカル SSD cloud_ssd：標準 SSD cloud_essd：PL1 ESSD cloud_essd2：PL2 ESSD cloud_essd3：PL3 ESSD	local_ssd
DBInstanceId	string	任意	仕様を変更するインスタンス、または更新するインスタンスの ID。説明仕様変更注文または更新注文の価格を照会する場合は、このパラメーターを指定する必要があります。インスタンスが読み取り専用インスタンスの場合、このパラメーターをそのプライマリインスタンスの ID に設定する必要があります。	rm-****
DBNode	array<object>	任意	ノードに関する情報。説明このパラメーターは、RDS Cluster Edition を実行する ApsaraDB RDS for MySQL インスタンスでサポートされています。
	object	任意	ノードの詳細。
ClassCode	string	任意	ノードのインスタンスタイプ。	mysql.x2.medium.xc
ZoneId	string	任意	ノードのゾーン ID。	cn-hangzhou-j
ServerlessConfig	object	任意	サーバーレスインスタンスの設定。説明 ApsaraDB RDS for MariaDB はサーバーレスインスタンスをサポートしていません。
MaxCapacity	number	任意	RDS キャパシティユニット (RCU) の最大数。	8
MinCapacity	number	任意	RCU の最小数。	0.5

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
OrderParams	string	注文パラメーター。説明 OrderParamOut パラメーターが true に設定されている場合、OrderParams パラメーターの値が返されます。	{\"autoPay\":false}"
PriceInfo	object	価格情報。
ActivityInfo	object	プロモーションに関する情報。
CheckErrMsg	string	返されるメッセージ。	Error description
ErrorCode	string	返されるエラーコード。	123456
Success	string	リクエストが成功したかどうかを示します。	Success
Coupons	object
Coupon	array<object>	クーポンに関する情報。
	object	クーポンに関する情報。
CouponNo	string	クーポン ID。	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 時間あたりの推定コスト。	1**
TradeMinRCUAmount	number	指定した RCU の最小数に基づいて計算された、1 時間あたりの推定コスト。	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	サーバーレス RDS インスタンスの価格情報。
RCUDiscountMaxAmount	number	RCU の最大数の割引額。	1*.
RCUDiscountMinAmount	number	RCU の最小数の割引額。	1.
RCUOriginalMaxAmount	number	RCU の最大数の価格。	2*.
RCUOriginalMinAmount	number	RCU の最小数の価格。	3.
StorageOriginalAmount	number	ディスク容量のオリジナル価格。	1*
TotalOriginalMaxAmount	number	割引前の最大合計価格。	2*.
TotalOriginalMinAmount	number	割引前の最小合計価格。	2.
TradeMaxRCUAmount	number	RCU の最大数の取引価格。	1*.
TradeMinRCUAmount	number	RCU の最小数の取引価格。	2.
storageDiscountAmount	number	ディスク容量の割引価格。	2.*
ShowDiscount	boolean	割引が利用可能かどうかを示します。	true
TradeMaxRCUAmount	number	RCU の最大数に基づいて計算された、1 時間あたりの推定料金。	2**
TradeMinRCUAmount	number	RCU の最小数に基づいて計算された、1 時間あたりの推定料金。	1**

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ
400	DBInstanceStorageFormatFault	DBInstanceStorageFormatFault
400	InvalidDBInstanceStorage.Format	InvalidDBInstanceStorage.Format
400	DBNodeParameter.InvalidClassCode	The ClassCode of the item of the specified parameter DBNode is inconsistent.
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.
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.
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.
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.
400	KmsApiError	User secret key invalid.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
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.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
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
400	DBNodeParameter.Required	The DBNode parameter is required for RDS for MySQL Cluster Edition instances.
400	DBNodeParameter.TooFewItems	You must configure at least 2 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.
400	DBNodeParameter.TooManyItems	You can configure up to 9 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.
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.
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.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
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.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidTimeType.NotFound	The parameter timeType does not exist.
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。