All Products
Search
Document Center

ApsaraDB for MongoDB:DescribePrice

Last Updated:Sep 03, 2024

Queries the fees incurred when you create, upgrade, or renew an ApsaraDB for MongoDB instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dds:DescribePriceget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
OrderTypestringYes

The order type. Valid values:

  • BUY
  • UPGRADE
  • RENEW
BUY
DBInstancesstringYes

A JSON string that contains the details of the instance. For more information about the parameter and sample JSON formats, see DescribePrice .

[ { "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" } ]
CommodityCodestringNo

The code of the instance. Valid values:

  • dds: a replica set instance that uses the pay-as-you-go billing method
  • badds: a replica set instance that uses the subscription billing method
  • dds_sharding: a sharded cluster instance that uses the pay-as-you-go billing method
  • badds_sharding: a sharded cluster instance that uses the subscription billing method
  • badds_sharding_intl: a sharded cluster instance that uses the subscription billing method and is available on the International site (alibabacloud.com)
  • dds_sharding_intl: a sharded cluster instance that uses the pay-as-you-go billing method and is available on the International site (alibabacloud.com)
  • badds_sharding_jp: a sharded cluster instance that uses the subscription billing method and is available on the Japan site (jp.alibabacloud.com)
  • badds_intl: a replica set instance that uses the subscription billing method and is available on the International site (alibabacloud.com)
  • dds_intl: a replica set instance that uses the pay-as-you-go billing method and is available on the International site (alibabacloud.com)
badds
ProductCodestringNo

The code of the service. Default value: dds.

dds
BusinessInfostringNo

The business information. This is an additional parameter.

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

Specifies whether to use coupons. Default value: null. Valid values:

  • default or null: uses coupons.
  • youhuiquan_promotion_option_id_for_blank: does not use coupons.
youhuiquan_promotion_option_id_for_blank
OrderParamOutstringNo

Specifies whether to return the OrderParams parameter. Valid values:

  • false (default)
  • true
true
ResourceGroupIdstringNo

The ID of the resource group. For more information, see View basic information of a resource group.

rg-acfmyiu4ekp****

Response parameters

ParameterTypeDescriptionExample
object

The details of the order.

Orderobject

The order information.

Couponsarray<object>

The information of coupons.

object

The coupon.

Descriptionstring

The description of the coupon.

ceshi
IsSelectedstring

Indicates whether the coupon was selected. Valid values:

  • true
  • false
true
CouponNostring

The coupon ID.

youhuiquan_promotion_option_id_for_blank
Namestring

The coupon name.

youhuiquan111
PromotionRuleIdListarray

The IDs of the rules that correspond to the coupon.

long

The ID of the rule that corresponds to the coupon.

187720410647
PromotionOptionCodestring

The promotional option code.

youhui_quan
OptionCodestring

The code of the coupon.

youhui_quan
ActivityCategorystring

The activity type of the coupon. Valid values:

  • payondemand: subscription
  • payasyougo: pay-as-you-go
payondemand
OriginalAmountstring

The original price of the order.

322.4
DiscountAmountstring

The discount amount of the order.

322.4
RuleIdsarray

The rules of the order.

string

The IDs of promotion rules.

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

The final price of the order.

0
Currencystring

The currency.

USD
ShowDiscountInfoboolean

Indicates whether the discount information is displayed.

true
OptionalPromotionsstring

The promotional activity information.

\[{\”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 replica set - first-time purchase - \* discount for a one-year period - first-time purchase benefits\”,\”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 discount for a one-year period \”,\”promotionOptionNo\”:\”10180400107xxxxx\”,\”promotionRuleIdList\”:\[xxxxx],\”selected\”:false,\”targetArticleItemCodes\”:\[]}]”
PromDetailListstring

The promotional activity that is hit.

\[{\”finalPromFee\”:90xxx,\”optionCode\”:\”wanhua_activity\”,\”promType\”:\”discount\”,\”promotionId\”:2091xxxx,\”promotionName\”:\”\* discount is provided for new users who purchase ApsaraDB for MongoDB replica set instances for one year. A new user can purchase an ApsaraDB for MongoDB replica set instance only by using the discount.\”}]”
DepreciateInfoobject

The price reduction information.

ListPricedouble

The list price.

1*
OriginalStandAmountdouble

The original total price displayed on the official website.

12*
CheapStandAmountdouble

The new total price displayed on the official website.

9*
CheapRatedouble

The price reduction rate.

30%
Differentialdouble

The price difference displayed in the total order amount.

**
DifferentialNamestring

The name of the price difference.

XXXXX
MonthPricedouble

The monthly price.

**
IsContractActivityboolean

Indicates whether the contract promotion is hit.

false
IsShowstring

Indicates whether the price reduction rate is displayed.

true
ContractActivityobject

The contract promotion.

FinalPromFeedouble

The total discount amount.

3621.6
FinalFeedouble

The price after the promotion.

20522.4
ProdFeedouble

The original price.

24144.0
ActivityIdlong

The activity ID.

41120065996xxxxx
OptionCodestring

The promotion ID.

wanhua_activity
ActivityNamestring

The activity name.

contract promotion_order_xxx discount
OptionIdsarray

The promotion IDs.

long

The promotion ID.

200000614xxxx
StandDiscountPricedouble

The discount.

0
StandPricedouble

The discount.

0
ContractActivityboolean

Indicates whether the contract promotion is hit.

false
Codestring

The order code.

""
Messagestring

The order information.

""
IsContractActivityboolean

Indicates whether the contract promotion is hit.

false
RequestIdstring

The request ID.

27227A3D-6B86-56F3-9E03-9E60F001CE12
SubOrdersarray<object>

The coupon rules.

object

The coupon rule.

OriginalAmountstring

The original price of the order.

322.4
DiscountAmountstring

The discount amount of the order.

322.4
RuleIdsarray

The activity rules.

string

The activity rule IDs

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

The actual price of the order.

0
InstanceIdstring

The instance ID.

dds-bp1b6e54e7cc****
DepreciateInfoobject

The price reduction information.

ListPricedouble

The list price.

1*
OriginalStandAmountdouble

The original total price displayed on the official website.

12*
CheapStandAmountdouble

The new total price displayed on the official website.

9*
CheapRatedouble

The price reduction rate.

30%
Differentialdouble

The price difference displayed in the total order amount.

**
DifferentialNamestring

The name of the price difference.

XXXXX
MonthPricedouble

The monthly price.

**
IsContractActivityboolean

Indicates whether the contract promotion is hit.

false
IsShowstring

Indicates whether the price reduction rate is displayed.

true
ContractActivityobject

The activity information.

FinalPromFeedouble

The total discount amount.

3621.6
FinalFeedouble

The price after the promotion.

20522.4
ProdFeedouble

The original price.

24144.0
ActivityIdlong

The activity ID.

41120065996xxxxx
OptionCodestring

The promotion ID.

wanhua_activity
ActivityNamestring

The activity name.

contract promotion_order_xxx discount
OptionIdsarray

The promotion IDs.

long

The promotion ID.

2388xxxx
StartTimestring

The start time of the activity.

2024-02-29 10:30:00
IsNewOfficialActivitystring

Indicates whether the discount is hit.

true
ModuleInstancearray<object>

The configuration item of the instance in the order.

object
CycleFeestring

The cycle fee of the module.

0.0
PromDetailListarray<object>

The promotion details.

object
FinalPromFeedouble

The discount amount.

0.0
ActivityExtInfoobject

The additional promotion information.

{ "activityId": "1512010241743170" }
OptionCodestring

The code of the commodity to which the coupon can be applied.

wanhua_activity
PromTypestring

The sub-type of the promotion.

discount
PromotionIdlong

The ID of the promotional activity.

8105187xxxx
PromotionNamestring

The promotional activity name.

\[Item with price reduction in x xxxx] ApsaraDB for MongoDB instances of a full range of specifications - xxxxx
PromotionCodestring

The coupon code.

aliwood-xxx
DerivedPromTypestring

The sub-type of the promotion.

subPrice
DepreciateInfoobject

The activity information.

ListPricedouble

The list price.

1*
OriginalStandAmountdouble

The original total price displayed on the official website.

12*
CheapStandAmountdouble

The new total price displayed on the official website.

9*
CheapRatedouble

The price reduction rate.

30%
Differentialdouble

The price difference displayed in the total order amount.

**
DifferentialNamestring

The name of the price difference.

XXXXX
MonthPricedouble

The monthly price.

**
IsContractActivityboolean

Indicates whether the contract promotion is hit.

false
IsShowstring

Indicates whether the price reduction rate is displayed.

true
DiscountFeestring

The discount.

0.0
ModuleAttrsarray<object>

The module attributes.

object
Codestring

The attribute code.

dds_dbtype
Namestring

The attribute name.

MongoDB
Typestring

The attribute type.

3
Valuestring

The attribute value.

MongoDB
ModuleCodestring

The module code.

dds_dbtype
ModuleIdlong

The module ID

1017110000415xxx
ModuleNamestring

The module name.

database type
NeedOrderPayboolean

Indicates whether the order is paid.

true
PayFeedouble

The actual amount paid.

0.0
PricingModuleboolean

Indicates whether the item is billed.

false
StandPricedouble

The discount.

0
TotalProductFeedouble

The original price of the product.

0.0
ContractActivityboolean

Indicates whether the contract promotion is hit.

false
StandDiscountPricedouble

The discount.

451.00
ContractActivityboolean

Indicates whether the contract promotion is hit.

false
OptionalPromotionsarray<object>

The promotional options that can be configured.

object
ActivityCategorystring

The activity type.

discount
ActivityExtInfoobject

The additional activity information.

{ "activityId": "1512010241743170" }
CanPromFeedouble

The amount that can be deducted by using the coupon.

4560789
OptionCodestring

The promotion type.

wanhua_activity
PromotionNamestring

The promotion name.

\[Item with price reduction in xxx] ApsaraDB for MongoDB instances of a full range of specifications - xxx
PromotionOptionNostring

The promotion ID.

1512010241xxxxx
Selectedboolean

Indicates whether

false
Showboolean

Indicates whether the discount is displayed.

true
TargetArticleItemCodesarray

The specification codes of the product.

string

The specification code of the product.

""
PromotionRuleIdListarray

The IDs of the rules that correspond to the coupon.

string

The ID of the rule that corresponds to the coupon.

43289909
PromDetailListarray<object>

The promotion details.

object
FinalPromFeedouble

The discount amount.

0.0
ActivityExtInfoobject

The additional activity information.

{ "activityId": "1512010241743170" }
OptionCodestring

The code of the coupon.

youhui_quan
PromTypestring

The sub-type of the promotion.

discount
PromotionIdlong

The promotion ID.

233xxxxx
PromotionNamestring

The name of the promotional activity.

\[Item with price reduction in x xxxx] ApsaraDB for MongoDB instances of a full range of specifications - xxxxx
PromotionCodestring

The coupon code.

ali-wood
DerivedPromTypestring

The sub-type of the promotion.

subPrice
StandDiscountPricedouble

The discount.

8687
StandPricedouble

The discount.

62982
IsContractActivityboolean

Indicates whether the contract promotion is hit.

false
TraceIdstring

The ID of the trace.

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

The order parameters.

Note This parameter is returned only when the OrderParamOut parameter is set to true.
{\"autoPay\":false}"
Rulesarray<object>

The promotion rules.

object

The promotion rule.

RuleDescIdlong

The rule ID.

2075****
Titlestring

The rule title.

demo
Namestring

The rule name.

demoname

Examples

Sample success responses

JSONformat

{
  "Order": {
    "Coupons": {
      "Coupon": [
        {
          "Description": "ceshi",
          "IsSelected": "true",
          "CouponNo": "youhuiquan_promotion_option_id_for_blank",
          "Name": "youhuiquan111",
          "PromotionRuleIdList": {
            "PromotionRuleId": [
              187720410647
            ]
          },
          "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 replica set - first-time purchase - \\* discount for a one-year period - first-time purchase benefits\\”,\\”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 discount for a one-year period \\”,\\”promotionOptionNo\\”:\\”10180400107xxxxx\\”,\\”promotionRuleIdList\\”:\\[xxxxx],\\”selected\\”:false,\\”targetArticleItemCodes\\”:\\[]}]”\n",
    "PromDetailList": "\\[{\\”finalPromFee\\”:90xxx,\\”optionCode\\”:\\”wanhua_activity\\”,\\”promType\\”:\\”discount\\”,\\”promotionId\\”:2091xxxx,\\”promotionName\\”:\\”\\* discount is provided for new users who purchase ApsaraDB for MongoDB replica set instances for one year. A new user can purchase an ApsaraDB for MongoDB replica set instance only by using the discount.\\”}]”\n",
    "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": "contract promotion_order_xxx discount\n",
        "OptionIds": {
          "OptionId": [
            0
          ]
        }
      }
    },
    "StandDiscountPrice": 0,
    "StandPrice": 0,
    "ContractActivity": false,
    "Code": "\"\"",
    "Message": "\"\"",
    "IsContractActivity": false
  },
  "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": "contract promotion_order_xxx discount\n",
            "OptionIds": {
              "OptionId": [
                0
              ]
            }
          },
          "StartTime": "2024-02-29 10:30:00"
        },
        "IsNewOfficialActivity": "true\n",
        "ModuleInstance": {
          "ModuleInstance": [
            {
              "CycleFee": "0.0",
              "PromDetailList": {
                "PromDetal": [
                  {
                    "FinalPromFee": 0,
                    "ActivityExtInfo": {
                      "activityId": "1512010241743170"
                    },
                    "OptionCode": "wanhua_activity",
                    "PromType": "discount",
                    "PromotionId": 0,
                    "PromotionName": "\\[Item with price reduction in x xxxx] ApsaraDB for MongoDB instances of a full range of specifications - xxxxx\n",
                    "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": "database type\n",
              "NeedOrderPay": true,
              "PayFee": 0,
              "PricingModule": false,
              "StandPrice": 0,
              "TotalProductFee": 0,
              "ContractActivity": false,
              "StandDiscountPrice": 451
            }
          ]
        },
        "ContractActivity": false,
        "OptionalPromotions": {
          "OptionalPromotion": [
            {
              "ActivityCategory": "discount",
              "ActivityExtInfo": {
                "activityId": "1512010241743170"
              },
              "CanPromFee": 4560789,
              "OptionCode": "wanhua_activity",
              "PromotionName": "\\[Item with price reduction in xxx] ApsaraDB for MongoDB instances of a full range of specifications - xxx\n",
              "PromotionOptionNo": "1512010241xxxxx",
              "Selected": false,
              "Show": true,
              "TargetArticleItemCodes": {
                "targetArticleItemCode": [
                  "\"\""
                ]
              },
              "PromotionRuleIdList": {
                "promotionRuleId": [
                  "43289909"
                ]
              }
            }
          ]
        },
        "PromDetailList": {
          "PromDetal": [
            {
              "FinalPromFee": 0,
              "ActivityExtInfo": {
                "activityId": "1512010241743170"
              },
              "OptionCode": "youhui_quan",
              "PromType": "discount",
              "PromotionId": 0,
              "PromotionName": "\\[Item with price reduction in x xxxx] ApsaraDB for MongoDB instances of a full range of specifications - xxxxx\n",
              "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 codeError codeError message
400MissingParameterPeriod is mandatory for this action.
400MissingParameterDBInstanceId is mandatory for this action.
400InvalidParamSpecified parameter Period is not valid.
400OriginPriceErrorOrigin price error.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-05-10API Description Update. The Error code has changed. The response structure of the API has changedView Change Details
2024-05-09The Error code has changed. The response structure of the API has changedView Change Details
2024-04-07The Error code has changed. The response structure of the API has changedView Change Details
2024-03-05The Error code has changed. The response structure of the API has changedView Change Details
2024-02-28The Error code has changed. The response structure of the API has changedView Change Details
2024-01-31The Error code has changed. The response structure of the API has changedView Change Details
2023-09-11The Error code has changed. The response structure of the API has changedView Change Details