DescribePrice_云数据库 Tair（兼容 Redis®）_API文档-阿里云OpenAPI开发者门户

流控信息

请求速率为200/60(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

kvstore:DescribePrice	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
RegionIdstring	地域 ID，可调用 DescribeRegions 查询。示例值:cn-hangzhou参考取值来源: DescribeRegions
Capacityinteger<int64>	使用实例的存储容量指定规格，单位为 MB。本参数仅查询 Redis 开源版经典部署模式的实例，推荐您使用 InstanceClass 参数精确地指定一个规格。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1024
InstanceClassstring	使用 InstanceClass 编码指定实例规格。InstanceClass 查询步骤：展开详情示例值:redis.master.small.default参考取值来源: DescribeInstances CreateTairInstance
OrderTypestring	订单类型，取值：展开详情示例值:BUY枚举值:BUYUPGRADEDOWNGRADERENEWCONVERT
ZoneIdstring	可用区 ID，可调用 DescribeZones 查询。示例值:cn-hangzhou-e参考取值来源: DescribeZones
ChargeTypestring	付费类型，取值：展开详情示例值:PostPaid枚举值:PrePaidPostPaid
NodeTypestring	节点类型，取值：展开详情示例值:MASTER_SLAVE枚举值:STAND_ALONEMASTER_SLAVE
Periodinteger<int64>	包年包月时长，单位为月。取值范围：1~9、12、24、36。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:3
Quantityinteger<int64>	购买实例的数量，取值范围：1~30，默认值为 1。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1
InstanceIdstring	实例 ID。展开详情示例值:r-bp1zxszhcgatnx****参考取值来源: CreateInstance ModifyInstanceSSL RestoreInstance RestartInstance DescribeInstances
Instancesstring	当您需要查询云原生版读写分离架构、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"}]参考取值来源: CreateInstances DescribeInstances
BusinessInfostring	活动 ID、业务信息等扩展信息。示例值:000000000000
CouponNostring	优惠码，默认值：youhuiquan_promotion_option_id_for_blank，表示无优惠码。示例值:youhuiquan_promotion_option_id_for_blank
ForceUpgradeboolean	是否强制变配，取值：展开详情示例值:true
OrderParamOutstring	是否返回订单参数，可选值：展开详情示例值:true
ShardCountinteger<int32>	云原生集群实例中的数据分片节点的数量。示例值:2
EngineVersionstring	Redis 实例的引擎版本，取值：2.8、4.0、5.0或6.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
}

返回参数

字段名称	字段详情
OrderParamsstring	订单参数，当 OrderParamOut 为`true`时返回。示例值:String
RequestIdstring	请求 ID。示例值:3A40BE4E-1890-4972-889C-FEFA37663635
Orderobject	订单信息。
Rulesobject
SubOrdersobject

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	MissingParameter	Period is mandatory for this action.	诊断
400	InvalidInstances.Format	The Specified parameter Instances is not valid.	诊断
400	AlreadyHadTemporaryBandwidth	This instance have already had temporary bandwidth, please modify instance spec first.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-02-10	新增请求参数EngineVersion
	2024-07-31	新增请求参数ShardCount
	2024-04-10	变更返回参数
	2024-04-07	变更返回参数
	2024-03-26	变更返回参数
	2024-02-28	变更返回参数
	2023-09-18	变更返回参数