文档

DescribePrice - 查询费用

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

调试

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

授权信息

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

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

请求参数

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

地域 ID,您可以调用 DescribeRegions 接口查询地域 ID。

cn-hangzhou
OrderTypestring

订单类型,取值说明:

  • BUY:创建实例。
  • UPGRADE:变更配置。
  • RENEW:续费实例。
BUY
DBInstancesstring

包含实例中多个信息的 JSON 格式字符串。参数说明以及更多 JSON 格式示例,请参见DescribePrice 接口 DBInstances 参数说明

[ { "DBInstanceId":"dds-bp1b6e54e7cc****", "RegionId":"cn-hangzhou", "ZoneId":"cn-hangzhou-h", "Engine":"MongoDB", "EngineVersion":" 5.0", "DBInstanceClass":"mdb.shard.2x.xlarge.d", "DBInstanceStorage":30, "ChargeType":"PrePaid", "Period":1, "StorageType":"cloud_essd1" } ]
CommodityCodestring

集群代码,取值说明:

  • dds:副本集版按量付费。
  • badds: 副本集版包年包月。
  • dds_sharding: 分片集群版按量付费。
  • badds_sharding: 分片集群版包年包月。
  • badds_sharding_intl: 分片集群版包年包月(国际站)。
  • dds_sharding_intl: 分片集群版按量付费(国际站)。
  • badds_sharding_jp: 分片集群版包年包月(日本站)。
  • badds_intl: 副本集版包年包月(国际站)。
  • dds_intl: 副本集版按量付费(国际站)。
badds
ProductCodestring

产品代码,默认为 dds

dds
BusinessInfostring

附加参数,业务信息。

{"AccountPassword":"Pw123456","DBInstanceDescription":"test"}
CouponNostring

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

  • defaultnull(默认):使用优惠券。
  • youhuiquan_promotion_option_id_for_blank:不使用优惠券。
default
OrderParamOutstring

是否返回订单参数,取值说明:

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

资源组 ID。资源组详情请参见查看资源组基本信息

rg-acfmyiu4ekp****

返回参数

名称类型描述示例值
object

订单信息列表。

Orderobject

订单信息列表。

Couponsobject []

优惠券信息列表。

Descriptionstring

备注。

ceshi
IsSelectedstring

是否选中该优惠券,取值说明:

  • true:选中优惠券。
  • false:不选中优惠券。
true
CouponNostring

优惠券编码。

youhuiquan_promotion_option_id_for_blank
Namestring

优惠券名称。

youhuiquan111
PromotionRuleIdListarray

优惠券对应的规则 ID 列表。

long

优惠券对应的规则 ID。

18772041****
PromotionOptionCodestring

促销信息,促销选项代码。

youhui_quan
OptionCodestring

优惠券代号。

youhui_quan
ActivityCategorystring

优惠券的活动类型,取值说明:

  • payondemand:预付费。
  • payasyougo:后付费。
payondemand
OriginalAmountstring

订单原价。

322.4
DiscountAmountstring

订单优惠金额。

322.4
RuleIdsarray

订单规则信息。

string

活动规则 ID 合集。

{ "RuleId": [ 2075**** ] }
TradeAmountstring

订单实际交易价。

0
Currencystring

币种。

USD
ShowDiscountInfoboolean

是否展示折扣信息。

true
OptionalPromotionsstring

优惠活动信息列表。

"[{\"activityCategory\":\"discount\",\"activityExtInfo\":{\"noUseYouhuiquan\":\"true\",\"activityId\":\"191156098xxxx\",\"activityExtraAttr\":\"{\\\"forbiddenCpsProfit\\\":\\\"true\\\",\\\"forbiddenCouponsRestricted\\\":\\\"true\\\",\\\"forbiddenAmbassadorProfit\\\":\\\"true\\\"}\",\"isActivityIdFromWanHuaTong\":\"true\",\"isContractActivity\":\"false\"},\"canPromFee\":906130,\"optionCode\":\"wanhua_activity\",\"promotionName\":\"FY24--MongoDB 副本集--首购--1年6折--ft首购权益\",\"promotionOptionNo\":\"19115609882xxxx\",\"promotionRuleIdList\":[2091xxxx],\"selected\":true,\"targetArticleItemCodes\":[]},{\"activityCategory\":\"discount\",\"activityExtInfo\":{\"activityId\":\"1018040010xxxxx\",\"wanHuaOrderExpireSec\":\"604800\",\"isActivityIdFromWanHuaTong\":\"true\",\"isContractActivity\":\"false\"},\"canPromFee\":339799,\"optionCode\":\"wanhua_activity\",\"promotionName\":\"FY24--MongoDB年付折扣\",\"promotionOptionNo\":\"10180400107xxxxx\",\"promotionRuleIdList\":[xxxxx],\"selected\":false,\"targetArticleItemCodes\":[]}]"
PromDetailListstring

命中的优惠活动。

[{\"finalPromFee\":90xxx,\"optionCode\":\"wanhua_activity\",\"promType\":\"discount\",\"promotionId\":2091xxxx,\"promotionName\":\"新用户购买云数据库 MongoDB 副本集1年享6折优惠,限1台\"}]"
RequestIdstring

请求 ID。

27227A3D-6B86-56F3-9E03-9E60F001CE12
SubOrdersobject []

优惠券对应的规则列表。

OriginalAmountstring

订单原价。

322.4
DiscountAmountstring

订单优惠金额。

322.4
RuleIdsarray

活动规则列表。

string

活动规则 ID 合集。

{ "RuleId": [ 2075**** ] }
TradeAmountstring

订单实际交易价格。

0
InstanceIdstring

实例 ID。

dds-bp1b6e54e7cc****
TraceIdstring

调用链 ID。

27227A3D-6B87-56F3-9E03-9E60F001****
OrderParamsstring

订单参数。

说明 仅当 OrderParamOut 参数传入 true 时,返回该参数。
{\"autoPay\":false}"
Rulesobject []

活动规则列表。

RuleDescIdlong

策略 ID。

2075****
Titlestring

规则标题。

demo
Namestring

规则名称。

demoname

示例

正常返回示例

JSON格式

{
  "Order": {
    "Coupons": {
      "Coupon": [
        {
          "Description": "ceshi",
          "IsSelected": "true",
          "CouponNo": "youhuiquan_promotion_option_id_for_blank",
          "Name": "youhuiquan111",
          "PromotionRuleIdList": {
            "PromotionRuleId": [
              0
            ]
          },
          "PromotionOptionCode": "youhui_quan",
          "OptionCode": "youhui_quan",
          "ActivityCategory": "payondemand"
        }
      ]
    },
    "OriginalAmount": "322.4",
    "DiscountAmount": "322.4",
    "RuleIds": {
      "RuleId": [
        "{ \"RuleId\": [ 2075**** ] }"
      ]
    },
    "TradeAmount": "0",
    "Currency": "USD",
    "ShowDiscountInfo": true,
    "OptionalPromotions": "\"[{\\\"activityCategory\\\":\\\"discount\\\",\\\"activityExtInfo\\\":{\\\"noUseYouhuiquan\\\":\\\"true\\\",\\\"activityId\\\":\\\"191156098xxxx\\\",\\\"activityExtraAttr\\\":\\\"{\\\\\\\"forbiddenCpsProfit\\\\\\\":\\\\\\\"true\\\\\\\",\\\\\\\"forbiddenCouponsRestricted\\\\\\\":\\\\\\\"true\\\\\\\",\\\\\\\"forbiddenAmbassadorProfit\\\\\\\":\\\\\\\"true\\\\\\\"}\\\",\\\"isActivityIdFromWanHuaTong\\\":\\\"true\\\",\\\"isContractActivity\\\":\\\"false\\\"},\\\"canPromFee\\\":906130,\\\"optionCode\\\":\\\"wanhua_activity\\\",\\\"promotionName\\\":\\\"FY24--MongoDB 副本集--首购--1年6折--ft首购权益\\\",\\\"promotionOptionNo\\\":\\\"19115609882xxxx\\\",\\\"promotionRuleIdList\\\":[2091xxxx],\\\"selected\\\":true,\\\"targetArticleItemCodes\\\":[]},{\\\"activityCategory\\\":\\\"discount\\\",\\\"activityExtInfo\\\":{\\\"activityId\\\":\\\"1018040010xxxxx\\\",\\\"wanHuaOrderExpireSec\\\":\\\"604800\\\",\\\"isActivityIdFromWanHuaTong\\\":\\\"true\\\",\\\"isContractActivity\\\":\\\"false\\\"},\\\"canPromFee\\\":339799,\\\"optionCode\\\":\\\"wanhua_activity\\\",\\\"promotionName\\\":\\\"FY24--MongoDB年付折扣\\\",\\\"promotionOptionNo\\\":\\\"10180400107xxxxx\\\",\\\"promotionRuleIdList\\\":[xxxxx],\\\"selected\\\":false,\\\"targetArticleItemCodes\\\":[]}]\"",
    "PromDetailList": "[{\\\"finalPromFee\\\":90xxx,\\\"optionCode\\\":\\\"wanhua_activity\\\",\\\"promType\\\":\\\"discount\\\",\\\"promotionId\\\":2091xxxx,\\\"promotionName\\\":\\\"新用户购买云数据库 MongoDB 副本集1年享6折优惠,限1台\\\"}]\"",
    "DepreciateInfo": {
      "ListPrice": 0,
      "OriginalStandAmount": 0,
      "CheapStandAmount": 0,
      "CheapRate": 0,
      "Differential": 0,
      "DifferentialName": "",
      "MonthPrice": 0,
      "IsContractActivity": true,
      "IsShow": ""
    },
    "StandDiscountPrice": 0,
    "StandPrice": 0,
    "IsContractActivity": true
  },
  "RequestId": "27227A3D-6B86-56F3-9E03-9E60F001CE12",
  "SubOrders": {
    "SubOrder": [
      {
        "OriginalAmount": "322.4",
        "DiscountAmount": "322.4",
        "RuleIds": {
          "RuleId": [
            "{ \"RuleId\": [ 2075**** ] }"
          ]
        },
        "TradeAmount": "0",
        "InstanceId": "dds-bp1b6e54e7cc****",
        "DepreciateInfo": {
          "ListPrice": 0,
          "OriginalStandAmount": 0,
          "CheapStandAmount": 0,
          "CheapRate": 0,
          "Differential": 0,
          "DifferentialName": "",
          "MonthPrice": 0,
          "IsContractActivity": true,
          "IsShow": ""
        },
        "ModuleInstance": {
          "ModuleInstance": [
            {
              "CycleFee": "",
              "DepreciateInfo": {
                "ListPrice": 0,
                "OriginalStandAmount": 0,
                "CheapStandAmount": 0,
                "CheapRate": 0,
                "Differential": 0,
                "DifferentialName": "",
                "MonthPrice": 0,
                "IsContractActivity": true,
                "IsShow": ""
              },
              "DiscountFee": "",
              "ModuleAttrs": {
                "moduleAttr": [
                  {
                    "Code": "",
                    "Name": "",
                    "Type": "",
                    "Value": ""
                  }
                ]
              },
              "ModuleCode": "",
              "ModuleId": 0,
              "ModuleName": "",
              "NeedOrderPay": true,
              "PayFee": 0,
              "PricingModule": true,
              "StandPrice": 0,
              "TotalProductFee": 0
            }
          ]
        },
        "IsNewOfficialActivity": "",
        "IsContractActivity": true,
        "OptionalPromotions": {
          "OptionalPromotion": [
            {
              "ActivityCategory": "",
              "ActivityExtInfo": {
                "test": "test",
                "test2": 1
              },
              "CanPromFee": 0,
              "OptionCode": "",
              "PromotionName": "",
              "PromotionOptionNo": "",
              "Selected": true,
              "Show": true,
              "TargetArticleItemCodes": {
                "targetArticleItemCode": [
                  ""
                ]
              }
            }
          ]
        },
        "PromDetailList": {
          "PromDetal": [
            {
              "FinalPromFee": 0,
              "OptionCode": "",
              "PromType": "",
              "PromotionId": 0,
              "PromotionName": ""
            }
          ]
        },
        "StandDiscountPrice": 0,
        "StandPrice": 0
      }
    ]
  },
  "TraceId": "27227A3D-6B87-56F3-9E03-9E60F001****",
  "OrderParams": "{\\\"autoPay\\\":false}\"",
  "Rules": {
    "Rule": [
      {
        "RuleDescId": 0,
        "Title": "demo",
        "Name": "demoname"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400MissingParameterPeriod is mandatory for this action.
400MissingParameterDBInstanceId is mandatory for this action.
400InvalidParamSpecified parameter Period is not valid.
400OriginPriceErrorOrigin price error.

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

变更历史

变更时间变更内容概要操作
2024-02-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2024-01-31OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-09-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈