All Products
Search
Document Center

ApsaraDB for MongoDB:DescribePrice

Last Updated:Mar 15, 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:DescribePriceREAD
  • 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 ApsaraDB for MongoDB instance. For more information, see the 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" } ]
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

The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

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 orders.

Orderobject

The order.

Couponsobject []

The information of coupons.

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

Details about the rules that match the coupon.

long

The ID of the rule that matches 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 information of the discount is displayed.

true
RequestIdstring

The request ID.

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

The coupon rules.

OriginalAmountstring

The list price of the order.

322.4
DiscountAmountstring

The discount amount of the order.

322.4
RuleIdsarray

The promotion rules.

string

The promotion rule IDs.

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

The actual price of the order.

0
InstanceIdstring

The instance ID.

dds-bp1b6e54e7cc****
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}"
Rulesobject []

The promotion rules.

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
  },
  "RequestId": "27227A3D-6B86-56F3-9E03-9E60F001CE12",
  "SubOrders": {
    "SubOrder": [
      {
        "OriginalAmount": "322.4",
        "DiscountAmount": "322.4",
        "RuleIds": {
          "RuleId": [
            "{ \"RuleId\": [ 2075**** ] }"
          ]
        },
        "TradeAmount": "0",
        "InstanceId": "dds-bp1b6e54e7cc****"
      }
    ]
  },
  "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-03-05The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2024-02-28The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2024-01-31The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-09-11The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.