DescribePrice - 查詢價格 - Tair (Redis® OSS-Compatible)

查詢建立、升級配置或續約雲資料庫 Tair（相容 Redis）執行個體等操作產生的費用。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribePrice

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區ID，可調用[DescribeRegions](~~473763~~)查詢。	cn-hangzhou
Capacity	integer	否	使用執行個體的儲存容量指定規格，單位為MB。本參數僅查詢Redis開源版經典部署模式的執行個體，推薦您使用InstanceClass參數精確地指定一個規格。 > 指定InstanceClass參數後，無需再指定本參數。	1024
InstanceClass	string	否	使用InstanceClass編碼指定執行個體規格。InstanceClass查詢步驟： 1. 在[規格查詢導航](~~26350~~)中，根據需要選擇執行個體類型，點擊其架構類型列以開啟規格文檔。 2. 在規格文檔的執行個體規格表中，選擇需要的執行個體規格，並找到其InstanceClass列的編碼。 > 以查詢新購情境為例，除其他關鍵參數以外，您至少需要傳入如下參數： > * 查詢經典版執行個體：請傳入本參數。 > * 查詢雲原生版標準架構執行個體：請傳入本參數。 > * 查詢雲原生版叢集架構執行個體：請傳入本參數與ShardCount參數。 > * 查詢雲原生版讀寫分離架構執行個體：請傳入本參數，並傳入Instances參數。 > * 查詢多個不同規格的執行個體，或需查詢Tair ESSD型執行個體（自訂儲存類型和儲存空間）：請傳入Instances參數（無需傳入本參數）。	redis.master.small.default
OrderType	string	是	訂單類型，取值： * BUY：新購。 * UPGRADE：變更配置。 * RENEW：續約。 * CONVERT：轉換付費類型。	BUY
ZoneId	string	否	可用性區域ID，可調用[DescribeZones](~~473764~~)查詢。	cn-hangzhou-e
SecondaryZoneId	string	否	備可用性區域ID，可調用[DescribeZones](~~473764~~)介面查詢。 > 本參數和ZoneId參數傳入的值不能相同。	cn-hangzhou-g
ChargeType	string	否	付費類型，取值： * PostPaid（預設）：隨用隨付。 * PrePaid：訂用帳戶。	PostPaid
NodeType	string	否	節點類型，取值： - STAND_ALONE：單副本。 - MASTER_SLAVE（預設）：高可用（雙副本）。	MASTER_SLAVE
Period	integer	否	訂用帳戶時間長度，單位為月。取值範圍：1~9、12、24、36。	3
Quantity	integer	否	購買執行個體的數量，取值範圍：1~30，預設值為1。	1
InstanceId	string	否	執行個體ID。 > 當OrderType為UPGRADE或RENEW時必傳。	r-bp1zxszhcgatnx****
Instances	string	否	當您需要查詢雲原生版讀寫分離架構、Tair ESSD型執行個體或多個不同規格的執行個體時，需要傳入本參數，為JSON格式字串，更多資訊請參見下方的Instances參數補充說明。	[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass": "tair.scm.with.proxy.standard.2m.8d","ShardCount": "3","Period": "1","Quantity": "1"}]
BusinessInfo	string	否	活動ID、商務資訊等擴充資訊。	000000000000
CouponNo	string	否	優惠碼，預設值：youhuiquan_promotion_option_id_for_blank，表示無優惠碼。	youhuiquan_promotion_option_id_for_blank
ForceUpgrade	boolean	否	是否強制變更配置，取值： * false：是。 * true（預設）：否。	true
OrderParamOut	string	否	是否返回訂單參數，可選值： * false（預設）：不返回。 * true：返回。	true
ShardCount	integer	否	雲原生叢集執行個體中的資料分區節點的數量。	2
EngineVersion	string	否	Redis執行個體的引擎版本，取值：2.8、4.0、5.0或6.0。 Redis執行個體的引擎版本，取值：2.8、4.0或5.0。 Redis執行個體的引擎版本，取值：2.8、4.0或5.0。	5.0

### Instances參數補充說明以下說明僅適用於DescribePrice介面Instances參數的補充說明，不適用於其它介面。

名稱	類型	是否必選	樣本值	描述
RegionId	String	是	cn-hangzhou	地區 ID。
InstanceId	String	否	r-7xv4s7q131smyx****	執行個體ID，當OrderType為UPGRADE或RENEW時必傳。
InstanceClass	String	是	redis.master.small.default	經典版執行個體的執行個體規格，請參見規格查詢導航。
ShardClass	String	是	tair.rdb.2g	雲原生版執行個體的執行個體規格，請參見規格查詢導航。本參數和 InstanceClass 兩者中必須傳入一項。
IzNo	String	否	cn-hangzhou-b	可用性區域ID。
NodeType	String	否	MASTER_SLAVE	節點類型，取值： STAND_ALONE：單副本。 MASTER_SLAVE（預設）：高可用（雙副本）。
Period	Long	否	1	訂用帳戶時間長度，單位為月。取值範圍：1~9、12、24、36。
Quantity	String	否	1	購買執行個體的數量，取值範圍：1~30。預設值：1。
VPCId	String	否	vpc-bp1nme44gek34slfc****	VPC ID。
VSwitchId	String	否	vsw-bp1e7clcw529l773d****	虛擬交換器ID。
AutoPay	String	否	true	是否自動付款，取值： true（預設）：是 false：否
InstanceName	String	否	test_123	執行個體名稱。
ShardCount	String	否	2	分區節點數，預設為1，查詢標準架構、讀寫分離架構執行個體時無需傳入該參數。本參數僅適用於查詢雲原生版叢集架構執行個體，您可以通過該參數實現自訂分區數量。
ReadOnlyCount	Integer	否	2	總唯讀節點數量，本參數僅適用於建立雲原生版讀寫分離架構執行個體。
StorageType	String	否	essd_pl2	Tair ESSD磁碟型的儲存類型，取值為essd_pl0、essd_pl1、essd_pl2和essd_pl3，在指定本參數時，您還需同時指定Capacity為自訂磁碟容量。更多資訊請參見磁碟型執行個體規格。
Capacity	Long	否	512000	Tair ESSD磁碟型的磁碟容量，單位：MB。

### 參數請求樣本查詢新購Tair雲原生版叢集架構的樣本（該情境無需傳入**Instances**參數）：

{
  "RegionId": "cn-hangzhou",
  "InstanceClass": "tair.rdb.with.proxy.2g",
  "OrderType": "BUY",
  "ChargeType": "PrePaid",
  "Period": 1,
  "ShardCount": 3
}

查詢新購Tair ESSD磁碟型自訂儲存類型的樣本：

{
  "RegionId": "cn-hangzhou",
  "OrderType": "BUY",
  "ChargeType": "PostPaid",
  "Instances": "[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-h", "ShardClass": "tair.essd.standard.2xlarge", "ShardCount": "1","Capacity": "512000","StorageType": "essd_pl2"}]",
}

查詢新購Tair雲原生版讀寫分離架構的樣本：

{
  "RegionId": "cn-hangzhou",
  "InstanceClass": "tair.rdb.with.proxy.2g",
  "OrderType": "BUY",
  "ChargeType": "PrePaid",
  "Period": 1,
  "Instances": "[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass":"tair.rdb.with.proxy.2g","ReadOnlyCount":"2"}]"
}

查詢新購多個執行個體的請求樣本：

{
  "RegionId": "cn-hangzhou",
  "OrderType": "BUY",
  "ChargeType": "PrePaid",
  "Period": 1,
  "Instances": "[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","InstanceClass": "redis.master.small.default"}{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","InstanceClass": "redis.amber.logic.sharding.1g.2db.0rodb.6proxy.multithread"}{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass":"tair.rdb.with.proxy.2g","ShardCount":"3"}]"
}

查詢續約Tair雲原生版叢集架構的樣本（該情境無需傳入**Instances**參數）：

{
  "RegionId": "cn-hangzhou",
  "InstanceClass": "tair.rdb.with.proxy.1g",
  "OrderType": "RENEW",
  "ChargeType": "PrePaid",
  "Period": 12,
  "InstanceId": "r-d7****l3v0xmorw1xp",
  "ShardCount": 3
}

返回參數

名稱	類型	描述	樣本值
	object
OrderParams	string	訂單參數，當OrderParamOut為`true`時返回。	String
RequestId	string	請求ID。	3A40BE4E-1890-4972-889C-FEFA37663635
Order	object	訂單資訊。
OriginalAmount	string	訂單原價。	0.21
HandlingFeeAmount	string	手續約。	0.1
Currency	string	幣種，中國站為CNY（人民幣）；國際站為USD（美元）。	CNY
DiscountAmount	string	訂單優惠金額。	0.21
TradeAmount	string	訂單實際交易價。	10
Coupons	object
Coupon	array<object>	優惠券資訊。
	object	優惠券資訊。
IsSelected	string	是否選中該優惠券。	true
CouponNo	string	優惠券編碼。	youhuiquan_promotion_option_id_for_blank
Name	string	優惠券名稱。	test
Description	string	優惠券描述。	coupondemo
RuleIds	object
RuleId	array	活動ID。
	string	活動ID。	[202]
ShowDiscountInfo	boolean	是否展示折扣資訊。
DepreciateInfo	object	活動資訊。
ListPrice	integer	目錄價。	1*
OriginalStandAmount	integer	原始官網總價。	12*
CheapStandAmount	integer	降價後官網總價。	9*
CheapRate	integer	降價比例。	30%
Differential	integer	價差優惠（訂單總價展示）。	**
DifferentialName	string	價差優惠名稱。	XXXXX
MonthPrice	integer	摺合月價。	**
IsContractActivity	boolean	命中合約優惠。	false
IsShow	boolean	是否展示降價幅度。	true
ContractActivity	object	活動資訊。
FinalPromFee	number	優惠總費用。
FinalFee	number	優惠後費用。
ProdFee	number	原價。	****
ActivityId	integer	活動ID。	****
OptionCode	string	優惠ID。	****
ActivityName	string	活動名稱。	合約優惠_整單_xxx折
OptionIds	object
OptionId	array	優惠ID列表。
	integer	優惠ID。	*****
StandDiscountPrice	integer	折扣價格。	****
IsContractActivity	boolean	命中合約優惠。	false
StandPrice	integer	折扣價。	0
Code	string	訂單碼。	""
Message	string	訂單資訊。	""
Rules	object
Rule	array<object>	活動規格。
	object
RuleDescId	integer	策略ID。	1111111111
Title	string	策略標題。	test
Name	string	活動名稱。	test
SubOrders	object
SubOrder	array<object>	優惠券對應的策略。
	array<object>
OriginalAmount	string	訂單原價。	0.21
InstanceId	string	執行個體ID。	r-bp1xxxxxxxxxxxxx
DiscountAmount	string	訂單優惠金額。	0.21
TradeAmount	string	訂單實際交易價。	10
RuleIds	object
RuleId	array	活動ID。
	string	命中策略的ID。	RuleId: 1111111111
OptionalPromotions	object
OptionalPromotion	array<object>	可選擇的優惠選項列表結果。
	array<object>
Selected	boolean	是否外部選中。	false
CouponNo	string	是否使用優惠券，取值說明： - default或null（預設）：使用優惠券。 - youhuiquan_promotion_option_id_for_blank：不使用優惠券。	default
Name	string	優惠券名稱。	****
Description	string	備忘。	****
Show	boolean	優惠是否展示。	False
ActivityExtInfo	object	活動額外資訊。	****
OptionCode	string	活動額外資訊。	****
PromotionName	string	優惠名稱。	****
PromotionOptionNo	string	優惠號。	youhuiquan_promotion_option_id_for_blank
CanPromFee	string	可優惠價格。	****
DepreciateInfo	object	降價資訊。
ListPrice	integer	目錄價。	****
OriginalStandAmount	integer	原始官網總價。	****
CheapStandAmount	integer	降價後官網總價。	****
CheapRate	integer	降價比例。	****
Differential	integer	價差優惠（訂單總價展示）。	****
DifferentialName	string	價差優惠名稱。	****
MonthPrice	integer	摺合月價。	****
IsContractActivity	boolean	命中合約優惠。	false
ContractActivity	object	合約優惠。
FinalPromFee	number	優惠總費用。	****
FinalFee	number	優惠後費用。	****
ProdFee	number	原價。	****
ActivityId	integer	活動id。	1412025702634847
OptionCode	string	優惠id。	****
ActivityName	string	活動名稱。	****
OptionIds	object
OptionId	array	優惠ID列表。
	integer	優惠ID。
StartTime	string	活動開始時間。	2024-11-18T00:00:00Z
StandDiscountPrice	integer	折扣價格。	****
IsContractActivity	boolean	命中合約優惠。	****
StandPrice	integer	折扣價。	****
ModuleInstance	object
ModuleInstance	array<object>	訂單行執行個體配置。
	array<object>	訂單行執行個體配置子物件。
ModuleCode	string	模組code。	****
ModuleId	string	模組Id。	****
StandPrice	number	折扣價。	****
PricingModule	boolean	是否計價項。	****
ModuleName	string	模組名稱。	****
DiscountFee	number	折計費用。	****
TotalProductFee	number	產品原價。	0.0
NeedOrderPay	boolean	在訂單中是否需要支付。	true
PayFee	number	實付金額。	0.0
ModuleAttrs	object
moduleAttr	array<object>	模組屬性。
	object	訂購參數。
Type	integer	屬性類型。	****
Value	string	屬性類型。	****
Code	string	屬性代碼。	****
Name	string	屬性名稱。	****
ContractActivity	boolean	命中合約優惠。	****
DepreciateInfo	object	降價資訊。
ListPrice	number	目錄價。	****
OriginalStandAmount	number	原始官網總價。	****
CheapStandAmount	number	降價後官網總價。	****
CheapRate	number	降價比例。	******
Differential	number	價差優惠（訂單總價展示）。	****
DifferentialName	string	價差優惠名稱。	****
MonthPrice	number	摺合月價。	****
IsContractActivity	boolean	命中合約優惠。	****
IsShow	boolean	是否展示降價幅度。	true
StartTime	string	活動開始時間。	2024-09-23T14:00:01Z
PromDetailList	object
PromDetail	array<object>	優惠明細資訊。
	array<object>	優惠資訊。
PromotionName	string	優惠活動名稱。	****
PromotionId	integer	優惠ID。	****
FinalPromFee	number	優惠金額。	****
OptionCode	string	優惠券代號。	****
PromType	string	優惠子類型。	****
ActivityExtInfo	object	活動額外資訊。	****
DerivedPromType	string	優惠子類型。	****
PromotionCode	string	優惠碼。	****
ContractActivity	boolean	命中合約優惠。	****

樣本

正常返回樣本

JSON格式

{
  "OrderParams": "String",
  "RequestId": "3A40BE4E-1890-4972-889C-FEFA37663635",
  "Order": {
    "OriginalAmount": "0.21",
    "HandlingFeeAmount": "0.1",
    "Currency": "CNY",
    "DiscountAmount": "0.21",
    "TradeAmount": "10",
    "Coupons": {
      "Coupon": [
        {
          "IsSelected": "true",
          "CouponNo": "youhuiquan_promotion_option_id_for_blank",
          "Name": "test",
          "Description": "coupondemo"
        }
      ]
    },
    "RuleIds": {
      "RuleId": [
        "[202]"
      ]
    },
    "ShowDiscountInfo": true,
    "DepreciateInfo": {
      "ListPrice": 0,
      "OriginalStandAmount": 0,
      "CheapStandAmount": 0,
      "CheapRate": 0,
      "Differential": 0,
      "DifferentialName": "XXXXX",
      "MonthPrice": 0,
      "IsContractActivity": false,
      "IsShow": true,
      "ContractActivity": {
        "FinalPromFee": 0,
        "FinalFee": 0,
        "ProdFee": 0,
        "ActivityId": 0,
        "OptionCode": "****",
        "ActivityName": "合約優惠_整單_xxx折",
        "OptionIds": {
          "OptionId": [
            0
          ]
        }
      }
    },
    "StandDiscountPrice": 0,
    "IsContractActivity": true,
    "StandPrice": 0,
    "Code": "\"\"\n",
    "Message": "\"\""
  },
  "Rules": {
    "Rule": [
      {
        "RuleDescId": 1111111111,
        "Title": "test",
        "Name": "test"
      }
    ]
  },
  "SubOrders": {
    "SubOrder": [
      {
        "OriginalAmount": "0.21",
        "InstanceId": "r-bp1xxxxxxxxxxxxx",
        "DiscountAmount": "0.21",
        "TradeAmount": "10",
        "RuleIds": {
          "RuleId": [
            "RuleId: 1111111111"
          ]
        },
        "OptionalPromotions": {
          "OptionalPromotion": [
            {
              "Selected": false,
              "CouponNo": "default",
              "Name": "****",
              "Description": "****",
              "Show": true,
              "ActivityExtInfo": {
                "test": "test",
                "test2": 1
              },
              "OptionCode": "****",
              "PromotionName": "****",
              "PromotionOptionNo": "youhuiquan_promotion_option_id_for_blank",
              "CanPromFee": "****"
            }
          ]
        },
        "DepreciateInfo": {
          "ListPrice": 0,
          "OriginalStandAmount": 0,
          "CheapStandAmount": 0,
          "CheapRate": 0,
          "Differential": 0,
          "DifferentialName": "****",
          "MonthPrice": 0,
          "IsContractActivity": false,
          "ContractActivity": {
            "FinalPromFee": 0,
            "FinalFee": 0,
            "ProdFee": 0,
            "ActivityId": 1412025702634847,
            "OptionCode": "****",
            "ActivityName": "****",
            "OptionIds": {
              "OptionId": [
                0
              ]
            }
          },
          "StartTime": "2024-11-18T00:00:00Z"
        },
        "StandDiscountPrice": 0,
        "IsContractActivity": true,
        "StandPrice": 0,
        "ModuleInstance": {
          "ModuleInstance": [
            {
              "ModuleCode": "****",
              "ModuleId": "****",
              "StandPrice": 0,
              "PricingModule": true,
              "ModuleName": "****",
              "DiscountFee": 0,
              "TotalProductFee": 0,
              "NeedOrderPay": true,
              "PayFee": 0,
              "ModuleAttrs": {
                "moduleAttr": [
                  {
                    "Type": 0,
                    "Value": "****",
                    "Code": "****",
                    "Name": "****"
                  }
                ]
              },
              "ContractActivity": true,
              "DepreciateInfo": {
                "ListPrice": 0,
                "OriginalStandAmount": 0,
                "CheapStandAmount": 0,
                "CheapRate": 0,
                "Differential": 0,
                "DifferentialName": "****",
                "MonthPrice": 0,
                "IsContractActivity": true,
                "IsShow": true,
                "StartTime": "2024-09-23T14:00:01Z"
              }
            }
          ]
        },
        "PromDetailList": {
          "PromDetail": [
            {
              "PromotionName": "****",
              "PromotionId": 0,
              "FinalPromFee": 0,
              "OptionCode": "****",
              "PromType": "****",
              "ActivityExtInfo": {
                "test": "test",
                "test2": 1
              },
              "DerivedPromType": "****",
              "PromotionCode": "****"
            }
          ]
        },
        "ContractActivity": true
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	MissingParameter	Period is mandatory for this action.
400	InvalidInstances.Format	The Specified parameter Instances is not valid.	傳入的Instances參數是無效的
400	AlreadyHadTemporaryBandwidth	This instance have already had temporary bandwidth, please modify instance spec first.

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

變更歷史

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