文档

DescribePrice - 查询价格

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

地域 ID,可调用 DescribeRegions 查询。

cn-hangzhou
Capacitylong

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

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

使用 InstanceClass 编码指定实例规格。InstanceClass 查询步骤:

  1. 规格查询导航中,根据需要选择实例类型,点击其架构类型列以打开规格文档。
  2. 在规格文档的实例规格表中,选择需要的实例规格,并找到其 InstanceClass 列的编码。
说明 以查询新购场景为例,除其他关键参数以外,您至少需要传入如下参数:
  • 查询经典版实例:请传入本参数。
  • 查询云原生版标准架构实例:请传入本参数。
  • 查询云原生版集群架构实例:请传入本参数与 ShardCount 参数。
  • 查询云原生版读写分离架构实例:请传入本参数,并传入 Instances 参数。
  • 查询多个不同规格的实例,或需查询 Tair ESSD 型实例(自定义存储类型和存储空间):请传入 Instances 参数(无需传入本参数)。
  • 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

    当您需要查询云原生版读写分离架构、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"}]
    BusinessInfostring

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

    000000000000
    CouponNostring

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

    youhuiquan_promotion_option_id_for_blank
    ForceUpgradeboolean

    是否强制变配,取值:

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

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

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

    云原生集群实例中的数据分片节点的数量。

    2

    Instances 参数补充说明

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

    名称类型是否必选示例值描述
    RegionIdStringcn-hangzhou地域 ID。
    InstanceIdStringr-7xv4s7q131smyx****实例 ID,当 OrderType 为 UPGRADE 或 RENEW 时必传。
    InstanceClassStringredis.master.small.default经典版实例的实例规格,请参见规格查询导航
    ShardClassStringtair.rdb.2g云原生版实例的实例规格,请参见规格查询导航
    本参数和 InstanceClass 两者中必须传入一项。
    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实例名称。
    ShardCountString2分片节点数,默认为 1,查询标准架构、读写分离架构实例时无需传入该参数。本参数仅适用于查询云原生版集群架构实例,您可以通过该参数实现自定义分片数量。
    ReadOnlyCountInteger2总只读节点数量,本参数仅适用于创建云原生版读写分离架构实例。
    StorageTypeStringessd_pl2Tair ESSD 磁盘型的存储类型,取值为essd_pl0essd_pl1essd_pl2essd_pl3,在指定本参数时,您还需同时指定Capacity为自定义磁盘容量。更多信息请参见磁盘型实例规格
    CapacityLong512000Tair 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
    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
    Couponsarray<object>

    优惠券信息。

    Couponobject

    优惠券信息。

    IsSelectedstring

    是否选中该优惠券。

    true
    CouponNostring

    优惠券编码。

    youhuiquan_promotion_option_id_for_blank
    Namestring

    优惠券名称。

    test
    Descriptionstring

    优惠券描述。

    coupondemo
    RuleIdsarray

    活动 ID。

    RuleIdstring

    活动 ID。

    ShowDiscountInfoboolean

    是否展示折扣信息。

    DepreciateInfoobject

    活动信息。

    ListPricelong

    目录价。

    1*
    OriginalStandAmountlong

    原始官网总价。

    12*
    CheapStandAmountlong

    降价后官网总价。

    9*
    CheapRatelong

    降价比例。

    30%
    Differentiallong

    差价优惠(订单总价展示)。

    **
    DifferentialNamestring

    差价优惠名称。

    XXXXX
    MonthPricelong

    折合月价。

    **
    IsContractActivityboolean

    命中合同优惠。

    false
    IsShowboolean

    是否展示降价幅度。

    true
    ContractActivityobject

    活动信息。

    FinalPromFeedouble

    优惠总费用。

    FinalFeedouble

    优惠后费用。

    ProdFeedouble

    原价。

    ActivityIdlong

    活动 ID。

    OptionCodestring

    优惠 ID。

    ActivityNamestring

    活动名称。

    合同优惠_整单_xxx折
    OptionIdsarray

    优惠 ID 列表。

    OptionIdlong

    优惠 ID。

    StandDiscountPricelong

    折扣价格。

    IsContractActivityboolean

    命中合同优惠。

    false
    StandPricelong

    折扣价。

    0
    Codestring

    订单码。

    ""
    Messagestring

    订单信息。

    ""
    Rulesarray<object>

    活动规格。

    Ruleobject
    RuleDescIdlong

    策略 ID。

    1111111111
    Titlestring

    策略标题。

    test
    Namestring

    活动名称。

    test
    SubOrdersarray<object>

    优惠券对应的策略。

    SubOrderobject
    OriginalAmountstring

    订单原价。

    0.21
    InstanceIdstring

    实例 ID。

    r-bp1xxxxxxxxxxxxx
    DiscountAmountstring

    订单优惠金额。

    0.21
    TradeAmountstring

    订单实际交易价。

    10
    RuleIdsarray

    活动 ID。

    RuleIdstring

    命中策略的 ID。

    RuleId: 1111111111
    OptionalPromotionsarray<object>

    可选择的优惠选项列表结果。

    OptionalPromotionobject
    Selectedboolean

    是否外部选中。

    false
    CouponNostring

    是否使用优惠券,取值说明:

    • default 或 null(默认):使用优惠券。
    • youhuiquan_promotion_option_id_for_blank:不使用优惠券。
    default
    Namestring

    优惠券名称。

    Descriptionstring

    备注。

    Showboolean

    优惠是否展示。

    ActivityExtInfoobject

    活动额外信息。

    OptionCodestring

    活动额外信息。

    PromotionNamestring

    优惠名称。

    PromotionOptionNostring

    优惠号。

    CanPromFeestring

    可优惠价格。

    DepreciateInfoobject

    降价信息。

    ListPricelong

    目录价。

    OriginalStandAmountlong

    原始官网总价。

    CheapStandAmountlong

    降价后官网总价。

    CheapRatelong

    降价比例。

    Differentiallong

    差价优惠(订单总价展示)。

    DifferentialNamestring

    差价优惠名称。

    MonthPricelong

    折合月价。

    IsContractActivityboolean

    命中合同优惠。

    ContractActivityobject

    合同优惠。

    FinalPromFeedouble

    优惠总费用。

    FinalFeedouble

    优惠后费用。

    ProdFeedouble

    原价。

    ActivityIdlong

    活动 id。

    OptionCodestring

    优惠 id。

    ActivityNamestring

    活动名称。

    OptionIdsarray

    优惠 ID 列表。

    OptionIdlong

    优惠 ID。

    StartTimestring

    活动开始时间。

    StandDiscountPricelong

    折扣价格。

    IsContractActivityboolean

    命中合同优惠。

    StandPricelong

    折扣价。

    ModuleInstancearray<object>

    订单行实例配置。

    ModuleInstanceobject

    订单行实例配置子对象。

    ModuleCodestring

    模块 code。

    ModuleIdstring

    模块 Id。

    StandPricedouble

    折扣价。

    PricingModuleboolean

    是否计价项。

    ModuleNamestring

    模块名称。

    DiscountFeedouble

    折扣费用。

    TotalProductFeedouble

    产品原价。

    0.0
    NeedOrderPayboolean

    在订单中是否需要支付。

    true
    PayFeedouble

    实付金额。

    0.0
    ModuleAttrsarray<object>

    模块属性。

    moduleAttrobject

    订购参数。

    Typelong

    属性类型。

    Valuestring

    属性类型。

    Codestring

    属性代码。

    Namestring

    属性名称。

    ContractActivityboolean

    命中合同优惠。

    DepreciateInfoobject

    降价信息。

    ListPricedouble

    目录价。

    OriginalStandAmountdouble

    原始官网总价。

    CheapStandAmountdouble

    降价后官网总价。

    CheapRatedouble

    降价比例。

    Differentialdouble

    差价优惠(订单总价展示)。

    DifferentialNamestring

    差价优惠名称。

    MonthPricedouble

    折合月价。

    IsContractActivityboolean

    命中合同优惠。

    IsShowboolean

    是否展示降价幅度。

    true
    StartTimestring

    活动开始时间。

    PromDetailListarray<object>

    优惠明细信息。

    PromDetailobject

    优惠信息。

    PromotionNamestring

    优惠活动名称。

    PromotionIdlong

    优惠 ID。

    FinalPromFeedouble

    优惠金额。

    OptionCodestring

    优惠券代号。

    PromTypestring

    优惠子类型。

    ActivityExtInfoobject

    活动额外信息。

    DerivedPromTypestring

    优惠子类型。

    PromotionCodestring

    优惠码。

    ContractActivityboolean

    命中合同优惠。

    示例

    正常返回示例

    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": [
            ""
          ]
        },
        "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": "",
                  "CanPromFee": ""
                }
              ]
            },
            "DepreciateInfo": {
              "ListPrice": 0,
              "OriginalStandAmount": 0,
              "CheapStandAmount": 0,
              "CheapRate": 0,
              "Differential": 0,
              "DifferentialName": "",
              "MonthPrice": 0,
              "IsContractActivity": true,
              "ContractActivity": {
                "FinalPromFee": 0,
                "FinalFee": 0,
                "ProdFee": 0,
                "ActivityId": 0,
                "OptionCode": "",
                "ActivityName": "",
                "OptionIds": {
                  "OptionId": [
                    0
                  ]
                }
              },
              "StartTime": ""
            },
            "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": ""
                  }
                }
              ]
            },
            "PromDetailList": {
              "PromDetail": [
                {
                  "PromotionName": "",
                  "PromotionId": 0,
                  "FinalPromFee": 0,
                  "OptionCode": "",
                  "PromType": "",
                  "ActivityExtInfo": {
                    "test": "test",
                    "test2": 1
                  },
                  "DerivedPromType": "",
                  "PromotionCode": ""
                }
              ]
            },
            "ContractActivity": true
          }
        ]
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    400MissingParameterPeriod is mandatory for this action.-
    400MissingParameterInstanceId is mandatory for this action.-
    400InvalidInstances.FormatThe Specified parameter Instances is not valid.传入的Instances参数是无效的
    400AlreadyHadTemporaryBandwidthThis instance have already had temporary bandwidth, please modify instance spec first.-

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

    变更历史

    变更时间变更内容概要操作
    2024-07-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2024-04-10OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-04-07OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-03-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-02-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-09-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情