全部产品
Search
文档中心

云数据库 Redis:DescribePrice - 查询价格

更新时间:Feb 20, 2024

查询创建Redis实例、升级配置或续费等操作产生的费用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribePrice
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID,可调用 DescribeRegions 查询。

cn-hangzhou
Capacitylong

使用实例的存储容量指定规格,单位为 MB。本参数仅查询 Redis 社区版经典部署模式的实例,推荐您使用 InstanceClass 参数精确地指定一个规格。

说明 指定 InstanceClass 参数后,无需再指定本参数。
1024
InstanceClassstring

使用 InstanceClass 编码指定实例规格。

InstanceClass 查询步骤:

  1. 规格查询导航中,根据需要选择实例类型,点击其架构类型列以打开规格文档。
  2. 在规格文档的实例规格表中,选择需要的实例规格,并找到其 InstanceClass 列的编码。

查询云原生版集群架构实例时,需指定本参数为下述指定参数之一,并在 Instances 参数中指定具体待查询的实例规格。

  • Redis 集群架构:redis.cluster.sharding.common.ce
  • Tair 内存型集群架构:tair.rdb.cluster.sharding.common
  • Tair 持久内存型集群架构:tair.scm.cluster.sharding.common.ce
redis.master.small.default
OrderTypestring

订单类型,取值:

  • BUY:新购。
  • UPGRADE:变更配置。
  • RENEW:续费。
  • CONVERT:转换付费类型。
BUY
ZoneIdstring

可用区 ID,可调用 DescribeZones 查询。

cn-hangzhou-e
ChargeTypestring

付费类型,取值:

  • PostPaid(默认):按量付费。
  • PrePaid:包年包月。
PostPaid
NodeTypestring

节点类型,取值:

  • STAND_ALONE:单副本。
  • MASTER_SLAVE(默认):高可用(双副本)。
MASTER_SLAVE
Periodlong

包年包月时长,单位为月。取值范围:1~9122436

3
Quantitylong

购买实例的数量,取值范围:1~30,默认值为 1

1
InstanceIdstring

实例 ID。

说明 OrderTypeUPGRADERENEW 时必传。
r-bp1zxszhcgatnx****
Instancesstring

包含查询云原生版集群架构实例或多个实例的 JSON 格式字符串,更多信息请参见 Instances 参数补充说明。

[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass": "tair.scm.with.proxy.standard.2m.8d","ShardCount": "3","Period": "1","Quantity": "1"}]
BusinessInfostring

活动 ID、业务信息等扩展信息。

000000000000
CouponNostring

优惠码,默认值:youhuiquan_promotion_option_id_for_blank,表示无优惠码。

youhuiquan_promotion_option_id_for_blank
ForceUpgradeboolean

是否强制变配,取值:

  • false:是。
  • true(默认):否。
true
OrderParamOutstring

是否返回订单参数,可选值:

  • false(默认):不返回。
  • true:返回。
true

Instances 参数补充说明

以下说明仅适用于 DescribePrice 接口 Instances 参数的补充说明,不适用于其它接口。

名称类型是否必选示例值描述
InstanceIdStringr-7xv4s7q131smyx****实例 ID,当 OrderType 为 UPGRADE 或 RENEW 时必传。
CapacityLong16384实例的存储容量,单位:MB。
说明:本参数和 InstanceClass 两者中必须传入一项。
InstanceClassStringredis.master.small.default实例规格,请参见规格查询导航
IzNoStringcn-hangzhou-b可用区 ID。
NodeTypeStringMASTER_SLAVE节点类型,取值:
  • STAND_ALONE:单副本。
  • MASTER_SLAVE(默认):高可用(双副本)。
PeriodLong1包年包月时长,单位为月。取值范围:1~9、12、24、36。
QuantityString1购买实例的数量,取值范围:1~30。默认值:1。
VPCIdStringvpc-bp1nme44gek34slfc****VPC ID。
VSwitchIdStringvsw-bp1e7clcw529l773d****虚拟交换机 ID。
AutoPayStringtrue是否自动付款,取值:
  • true(默认):是
  • false:否
InstanceNameStringtest_123实例名称。
ShardClassStringtair.rdb.2g分片规格,本参数仅适用于创建云原生版集群架构实例。
ShardCountString2分片数,本参数仅适用于创建云原生版集群架构实例,您可以通过该参数实现自定义分片数量。
ReadOnlyCountInteger2总只读节点数量,本参数仅适用于创建云盘读写分离架构实例。

Instances 参数请求示例

查询 Tair 云原生版集群架构的请求示例:

{
  "RegionId": "cn-hangzhou",
  "OrderType": "BUY",
  "ChargeType": "PostPaid",
  "Instances": "[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-h", "ShardClass": "tair.rdb.with.proxy.2g", "ShardCount": "3", "Period": "1","Quantity": "1"}]",
  "ZoneId": "cn-hangzhou-h",
  "SourceIp": "192.168.0.1"
}

查询多个实例的请求示例:

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

返回参数

名称类型描述示例值
object
OrderParamsstring

订单参数,当 OrderParamOut 为true时返回。

String
RequestIdstring

请求 ID。

3A40BE4E-1890-4972-889C-FEFA37663635
Orderobject

订单信息。

OriginalAmountstring

订单原价。

0.21
HandlingFeeAmountstring

手续费。

0.1
Currencystring

币种,中国站为 CNY(人民币);国际站为 USD(美元)。

CNY
DiscountAmountstring

订单优惠金额。

0.21
TradeAmountstring

订单实际交易价。

10
Couponsobject []

优惠券信息。

IsSelectedstring

是否选中该优惠券。

true
CouponNostring

优惠券编码。

youhuiquan_promotion_option_id_for_blank
Namestring

优惠券名称。

test
Descriptionstring

优惠券描述。

coupondemo
RuleIdsarray

活动 ID。

string

活动 ID。

1001199213
ShowDiscountInfoboolean

是否展示折扣信息。

Rulesobject []

活动规格。

RuleDescIdlong

策略 ID。

1111111111
Titlestring

策略标题。

test
Namestring

活动名称。

test
SubOrdersobject []

优惠券对应的策略。

OriginalAmountstring

订单原价。

0.21
InstanceIdstring

实例 ID。

r-bp1xxxxxxxxxxxxx
DiscountAmountstring

订单优惠金额。

0.21
TradeAmountstring

订单实际交易价。

10
RuleIdsarray

活动 ID。

string

命中策略的 ID。

RuleId: 1111111111

示例

正常返回示例

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": [
        "1001199213"
      ]
    },
    "ShowDiscountInfo": true
  },
  "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"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400MissingParameterPeriod is mandatory for this action.
400MissingParameterInstanceId is mandatory for this action.
400InvalidInstances.FormatThe Specified parameter Instances is not valid.
400AlreadyHadTemporaryBandwidthThis instance have already had temporary bandwidth, please modify instance spec first.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更