DescribePrice - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the price of an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribePrice

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Call the DescribeRegions operation to query the region ID.	cn-hangzhou
OrderType	string	Yes	The order type. Valid values: BUY: Create an instance. UPGRADE: Change the configuration of an instance. RENEW: Renew an instance.	BUY
DBInstances	string	Yes	A JSON string that contains information about the instance. For parameter details and more examples, see DBInstances parameter in the DescribePrice operation.	[ { "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" } ]
CommodityCode	string	No	The commodity code of the instance. Valid values: dds: pay-as-you-go replica set instance. badds: subscription replica set instance. dds_sharding: pay-as-you-go sharded cluster instance. badds_sharding: subscription sharded cluster instance. badds_sharding_intl: subscription sharded cluster instance on the international site (alibabacloud.com). dds_sharding_intl: pay-as-you-go sharded cluster instance on the international site (alibabacloud.com). badds_sharding_jp: subscription sharded cluster instance on the Japan site. badds_intl: subscription replica set instance on the international site (alibabacloud.com). dds_intl: pay-as-you-go replica set instance on the international site (alibabacloud.com).	badds
ProductCode	string	No	The product code. The default value is dds.	dds
BusinessInfo	string	No	Additional business information.	{"AccountPassword":"Pw123456","DBInstanceDescription":"test"}
CouponNo	string	No	Specifies whether to use a coupon. Valid values: default or null (default): A coupon is used. youhuiquan_promotion_option_id_for_blank: No coupon is used.	default
OrderParamOut	string	No	Specifies whether to return order parameters. Valid values: false (default): The order parameters are not returned. true: The order parameters are returned.	true
ResourceGroupId	string	No	The resource group ID. For more information about resource groups, see View basic information of a resource group.	rg-acfmyiu4ekp****

Response elements

Element	Type	Description	Example
	object	The order details.
Order	object	The order details.
Coupons	object
Coupon	array<object>	A list of coupons.
	array<object>	The coupon details.
Description	string	The description.	ceshi
IsSelected	string	Indicates whether the coupon is selected. Valid values: true: The coupon is selected. false: The coupon is not selected.	true
CouponNo	string	The coupon code.	youhuiquan_promotion_option_id_for_blank
Name	string	The name of the coupon.	youhuiquan111
PromotionRuleIdList	object
PromotionRuleId	array	A list of rule IDs for the coupon.
	integer	The rule ID for the coupon.	18772041****
PromotionOptionCode	string	The code of the promotion option.	youhui_quan
OptionCode	string	The coupon code.	youhui_quan
ActivityCategory	string	The type of the promotion. Valid values: payondemand: subscription. payasyougo: pay-as-you-go.	payondemand
OriginalAmount	string	The original price of the order.	322.4
DiscountAmount	string	The discount amount for the order.	322.4
RuleIds	object
RuleId	array	The rule information for the order.
	string	A collection of promotion rule IDs.	{ "RuleId": [ 2075**** ] }
TradeAmount	string	The final price of the order.	0
Currency	string	The currency.	USD
ShowDiscountInfo	boolean	Indicates whether to show the discount information.	true
OptionalPromotions	string	A list of promotions.	"[{\"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年*折--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	string	The matched promotions.	[{\"finalPromFee\":90xxx,\"optionCode\":\"wanhua_activity\",\"promType\":\"discount\",\"promotionId\":2091xxxx,\"promotionName\":\"新用户购买云数据库 MongoDB 副本集1年享*折优惠，限1台\"}]"
DepreciateInfo	object	The price reduction details.
ListPrice	number	The list price.	1*
OriginalStandAmount	number	The original total price.	12*
CheapStandAmount	number	The total price after the price reduction.	9*
CheapRate	number	The price reduction percentage.	30%
Differential	number	The price difference discount, which is reflected in the total price of the order.	**
DifferentialName	string	The name of the price difference discount.	XXXXX
MonthPrice	number	The monthly price.	**
IsContractActivity	boolean	Indicates whether a contract-based promotion is matched.	false
IsShow	string	Indicates whether to show the price reduction.	true
ContractActivity	object	The contract-based promotion.
FinalPromFee	number	The total discount amount.	3621.6
FinalFee	number	The discounted price.	20522.4
ProdFee	number	The original price.	24144.0
ActivityId	integer	The promotion ID.	41120065996xxxxx
OptionCode	string	The option code.	wanhua_activity
ActivityName	string	The name of the promotion.	合同优惠_整单_xxx折
OptionIds	object
OptionId	array	A list of option IDs.
	integer	The option ID.	200000614xxxx
StandDiscountPrice	number	The discount.	0
StandPrice	number	The discounted price.	0
ContractActivity	boolean	Indicates whether a contract-based promotion is matched.	false
Code	string	The order code.	""
Message	string	The order message.	""
IsContractActivity	boolean	Indicates whether a contract-based promotion is matched.	false
TotalCostAmount	number	The total cost of the order.	483.14
RequestId	string	The request ID.	27227A3D-6B86-56F3-9E03-9E60F001CE12
SubOrders	object
SubOrder	array<object>	A list of rules that correspond to the coupon.
	array<object>	The rule information for the coupon.
OriginalAmount	string	The original price of the order.	322.4
DiscountAmount	string	The discount amount for the order.	322.4
RuleIds	object
RuleId	array	A list of promotion rules.
	string	A collection of promotion rule IDs.	{ "RuleId": [ 2075**** ] }
TradeAmount	string	The final price of the order.	0
InstanceId	string	The instance ID.	dds-bp1b6e54e7cc****
DepreciateInfo	object	The price reduction details.
ListPrice	number	The list price.	1*
OriginalStandAmount	number	The original total price.	12*
CheapStandAmount	number	The total price after the price reduction.	9*
CheapRate	number	The price reduction percentage.	30%
Differential	number	The price difference discount, which is reflected in the total price of the order.	**
DifferentialName	string	The name of the price difference discount.	XXXXX
MonthPrice	number	The monthly price.	**
IsContractActivity	boolean	Indicates whether a contract-based promotion is matched.	false
IsShow	string	Indicates whether to show the price reduction.	true
ContractActivity	object	The promotion information.
FinalPromFee	number	The total discount amount.	3621.6
FinalFee	number	The discounted price.	20522.4
ProdFee	number	The original price.	24144.0
ActivityId	integer	The promotion ID.	41120065996xxxxx
OptionCode	string	The option code.	wanhua_activity
ActivityName	string	The name of the promotion.	合同优惠_整单_xxx折
OptionIds	object
OptionId	array	A list of option IDs.
	integer	The option ID.	2388xxxx
StartTime	string	The start time of the promotion.	2024-02-29 10:30:00
IsNewOfficialActivity	string	Indicates whether a price reduction promotion is matched.	命中降价优惠。
ModuleInstance	object
ModuleInstance	array<object>	The instance configurations for the order item.
	array<object>	The sub-object of the instance configuration for the order item.
CycleFee	string	The cycle fee of the module.	0.0
PromDetailList	object
PromDetail	array<object>	The discount details.
	array<object>	The discount information.
FinalPromFee	number	The discount amount.	0.0
ActivityExtInfo	object	The extended information about the discount.	{ "activityId": "1512010241743170" }
OptionCode	string	The commodity code of the coupon.	wanhua_activity
PromType	string	The sub-type of the discount.	discount
PromotionId	integer	The promotion ID.	8105187xxxx
PromotionName	string	The name of the promotion.	【xxxx-x月降价项目】MongoDB全规格--xxxxx
PromotionCode	string	The coupon code.	aliwood-xxx
DerivedPromType	string	The sub-type of the discount.	subPrice
DepreciateInfo	object	The promotion information.
ListPrice	number	The list price.	1*
OriginalStandAmount	number	The original total price.	12*
CheapStandAmount	number	The total price after the price reduction.	9*
CheapRate	number	The price reduction percentage.	30%
Differential	number	The price difference discount, which is reflected in the total price of the order.	**
DifferentialName	string	The name of the price difference discount.	XXXXX
MonthPrice	number	The monthly price.	**
IsContractActivity	boolean	Indicates whether a contract-based promotion is matched.	false
IsShow	string	Indicates whether to show the price reduction.	true
DiscountFee	string	The discount amount.	0.0
ModuleAttrs	object
moduleAttr	array<object>	The module attributes.
	object	Order parameters.
Code	string	The property code.	dds_dbtype
Name	string	The name of the property.	MongoDB
Type	string	The property type.	3
Value	string	The value of the property.	MongoDB
ModuleCode	string	The module code.	dds_dbtype
ModuleId	integer	The module ID.	1017110000415xxx
ModuleName	string	The name of the module.	数据库类型
NeedOrderPay	boolean	Indicates whether the order must be paid.	true
PayFee	number	The amount paid.	0.0
PricingModule	boolean	Indicates if you are charged for the item.	false
StandPrice	number	The discount price.	0
TotalProductFee	number	The original price of the product.	0.0
ContractActivity	boolean	A contract discount was hit.	false
StandDiscountPrice	number	The discount price.	451.00
priceUnit	string	The unit of the price.	xxxx
priceType	string	The price type.	monthPrice
UnitPriceUnit4Buy	string	The unit of the price.	CNY/Hour
ContractActivity	boolean	The contract discount was applied.	false
OptionalPromotions	object
OptionalPromotion	array<object>	A list of selectable promotion options.
	array<object>
ActivityCategory	string	The activity type.	discount
ActivityExtInfo	object	Additional information about the activity.	{ "activityId": "1512010241743170" }
CanPromFee	number	The discount amount.	4560789
OptionCode	string	The promotion type.	wanhua_activity
PromotionName	string	The name of the promotion.	【xxx月降价项目】MongoDB全规格--xxx
PromotionOptionNo	string	The promotion ID.	1512010241xxxxx
Selected	boolean	Indicates whether the promotion is selected externally.	false
Show	boolean	Indicates whether the promotion is displayed.	true
TargetArticleItemCodes	object
targetArticleItemCode	array	A list of specification codes for the target articles.
	string	The specification code for the target article item.	""
PromotionRuleIdList	object
promotionRuleId	array	A list of promotion IDs.
	string	The ID of the promotion rule.	43289909
PromDetailList	object
PromDetail	array<object>	The promotion details.
	array<object>	The promotional information.
FinalPromFee	number	The discount amount.	0.0
ActivityExtInfo	object	Additional information about the activity.	{ "activityId": "1512010241743170" }
OptionCode	string	The coupon code.	youhui_quan
PromType	string	The subtype of the promotion.	discount
PromotionId	integer	The ID of the promotion.	233xxxxx
PromotionName	string	The name of the promotion.	【xxxx-x月降价项目】MongoDB全规格--xxxxx
PromotionCode	string	The coupon code.	ali-wood
DerivedPromType	string	The promotion subtype.	subPrice
StandDiscountPrice	number	The discount price.	8687
StandPrice	number	The discounted price.	62982
IsContractActivity	boolean	Indicates whether a contract discount is hit.	false
TraceId	string	The trace ID.	27227A3D-6B87-56F3-9E03-9E60F001****
OrderParams	string	The order parameters. Note This parameter is returned only when the OrderParamOut parameter is set to true.	{\"autoPay\":false}"
Rules	object
Rule	array<object>	The list of promotional rules.
	object	Information about the promotional rule.
RuleDescId	integer	The policy ID.	2075****
Title	string	The title of the rule.	demo
Name	string	The name of the rule.	demoname

Examples

Success response

JSON format

{
  "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年*折--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年享*折优惠，限1台\\\"}]\"",
    "DepreciateInfo": {
      "ListPrice": 0,
      "OriginalStandAmount": 0,
      "CheapStandAmount": 0,
      "CheapRate": 0,
      "Differential": 0,
      "DifferentialName": "XXXXX",
      "MonthPrice": 0,
      "IsContractActivity": false,
      "IsShow": "true",
      "ContractActivity": {
        "FinalPromFee": 3621.6,
        "FinalFee": 20522.4,
        "ProdFee": 24144,
        "ActivityId": 0,
        "OptionCode": "wanhua_activity",
        "ActivityName": "合同优惠_整单_xxx折",
        "OptionIds": {
          "OptionId": [
            0
          ]
        }
      }
    },
    "StandDiscountPrice": 0,
    "StandPrice": 0,
    "ContractActivity": false,
    "Code": "\"\"",
    "Message": "\"\"",
    "IsContractActivity": false,
    "TotalCostAmount": 483.14
  },
  "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": "XXXXX",
          "MonthPrice": 0,
          "IsContractActivity": false,
          "IsShow": "true",
          "ContractActivity": {
            "FinalPromFee": 3621.6,
            "FinalFee": 20522.4,
            "ProdFee": 24144,
            "ActivityId": 0,
            "OptionCode": "wanhua_activity",
            "ActivityName": "合同优惠_整单_xxx折",
            "OptionIds": {
              "OptionId": [
                0
              ]
            }
          },
          "StartTime": "2024-02-29 10:30:00"
        },
        "IsNewOfficialActivity": "命中降价优惠。",
        "ModuleInstance": {
          "ModuleInstance": [
            {
              "CycleFee": "0.0",
              "PromDetailList": {
                "PromDetail": [
                  {
                    "FinalPromFee": 0,
                    "ActivityExtInfo": {
                      "activityId": "1512010241743170"
                    },
                    "OptionCode": "wanhua_activity",
                    "PromType": "discount",
                    "PromotionId": 0,
                    "PromotionName": "【xxxx-x月降价项目】MongoDB全规格--xxxxx",
                    "PromotionCode": "aliwood-xxx",
                    "DerivedPromType": "subPrice"
                  }
                ]
              },
              "DepreciateInfo": {
                "ListPrice": 0,
                "OriginalStandAmount": 0,
                "CheapStandAmount": 0,
                "CheapRate": 0,
                "Differential": 0,
                "DifferentialName": "XXXXX",
                "MonthPrice": 0,
                "IsContractActivity": false,
                "IsShow": "true"
              },
              "DiscountFee": "0.0",
              "ModuleAttrs": {
                "moduleAttr": [
                  {
                    "Code": "dds_dbtype",
                    "Name": "MongoDB",
                    "Type": "3",
                    "Value": "MongoDB"
                  }
                ]
              },
              "ModuleCode": "dds_dbtype",
              "ModuleId": 0,
              "ModuleName": "数据库类型",
              "NeedOrderPay": true,
              "PayFee": 0,
              "PricingModule": false,
              "StandPrice": 0,
              "TotalProductFee": 0,
              "ContractActivity": false,
              "StandDiscountPrice": 451,
              "priceUnit": "xxxx",
              "priceType": "monthPrice",
              "UnitPriceUnit4Buy": "CNY/Hour"
            }
          ]
        },
        "ContractActivity": false,
        "OptionalPromotions": {
          "OptionalPromotion": [
            {
              "ActivityCategory": "discount",
              "ActivityExtInfo": {
                "activityId": "1512010241743170"
              },
              "CanPromFee": 4560789,
              "OptionCode": "wanhua_activity",
              "PromotionName": "【xxx月降价项目】MongoDB全规格--xxx",
              "PromotionOptionNo": "1512010241xxxxx",
              "Selected": false,
              "Show": true,
              "TargetArticleItemCodes": {
                "targetArticleItemCode": [
                  "\"\""
                ]
              },
              "PromotionRuleIdList": {
                "promotionRuleId": [
                  "43289909"
                ]
              }
            }
          ]
        },
        "PromDetailList": {
          "PromDetail": [
            {
              "FinalPromFee": 0,
              "ActivityExtInfo": {
                "activityId": "1512010241743170"
              },
              "OptionCode": "youhui_quan",
              "PromType": "discount",
              "PromotionId": 0,
              "PromotionName": "【xxxx-x月降价项目】MongoDB全规格--xxxxx",
              "PromotionCode": "ali-wood",
              "DerivedPromType": "subPrice"
            }
          ]
        },
        "StandDiscountPrice": 8687,
        "StandPrice": 62982,
        "IsContractActivity": false
      }
    ]
  },
  "TraceId": "27227A3D-6B87-56F3-9E03-9E60F001****",
  "OrderParams": "{\\\"autoPay\\\":false}\"",
  "Rules": {
    "Rule": [
      {
        "RuleDescId": 0,
        "Title": "demo",
        "Name": "demoname"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	MissingParameter	Period is mandatory for this action.
400	InvalidParam	Specified parameter Period is not valid.
400	OriginPriceError	Origin price error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.