Use DescribeRenewalPrice to query the renewal price of an instance - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Get the price to renew a specific MongoDB instance for one month.

Operation description

This operation applies to subscription MongoDB instances.

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:DescribeRenewalPrice

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
BusinessInfo	string	No	Additional business information, provided as a JSON string.	{“ActivityId":"000000000"}
CouponNo	string	No	Specifies whether to use a coupon. Valid values: default or null (default): Use a coupon. youhuiquan_promotion_option_id_for_blank: Do not use a coupon.	default
DBInstanceId	string	Yes	The instance ID.	dds-bp12c5b040dc****

Response elements

Element	Type	Description	Example
	object	The order details.
Order	object	The order details.
Coupons	object	The coupon details.
Coupon	array<object>	A list of coupons.
	array<object>	The details of a coupon.
Description	string	The coupon description.	coupondemo
IsSelected	string	Indicates whether the coupon is selected.	true
CouponNo	string	The coupon code.	youhuiquan_promotion_option_id_for_blank
Name	string	The coupon name.	youhuiquan111
Effective	boolean	Indicates whether the coupon is effective.	true
ActivityExtInfo	object	Additional information about the coupon.
OriginalAmount	number	The original amount for the order.	1144.8
DiscountAmount	number	The total discount amount for the order.	1144.8
RuleIds	object	The matched rule IDs.
RuleId	array	A list of IDs for the matched rules.
	string	The ID of a matched rule.	11111111
TradeAmount	number	The final trade amount for the order.	0
Currency	string	The currency of the transaction.	USD
RequestId	string	The request ID.	EFD65226-08CC-4C4D-B6A4-CB3C382F67B0
SubOrders	object	The sub-order details.
SubOrder	array<object>	A list of sub-orders.
	array<object>	The details of a sub-order.
OriginalAmount	number	The original amount for the sub-order.	1144.8
DiscountAmount	number	The discount amount for the sub-order.	1144.8
RuleIds	object	The matched rule IDs for the sub-order.
RuleId	array	A list of IDs for the matched rules.
	string	The ID of a matched rule.	{"RuleId": [11111111,11111111,11111111]}
TradeAmount	number	The final trade amount for the sub-order.	0
InstanceId	string	The ID of the instance associated with this sub-order.	dds-bp12c5b040dc****
Rules	object	Details of the available promotion rules.
Rule	array<object>	A list of promotion rules.
	object	The details of a promotion rule.
RuleDescId	integer	The rule ID.	11111111
Title	string	The rule title.	demo
Name	string	The rule name.	demoname

Examples

Success response

JSON format

{
  "Order": {
    "Coupons": {
      "Coupon": [
        {
          "Description": "coupondemo",
          "IsSelected": "true",
          "CouponNo": "youhuiquan_promotion_option_id_for_blank",
          "Name": "youhuiquan111",
          "Effective": true,
          "ActivityExtInfo": {
            "test": "test",
            "test2": 1
          }
        }
      ]
    },
    "OriginalAmount": 1144.8,
    "DiscountAmount": 1144.8,
    "RuleIds": {
      "RuleId": [
        "11111111"
      ]
    },
    "TradeAmount": 0,
    "Currency": "USD"
  },
  "RequestId": "EFD65226-08CC-4C4D-B6A4-CB3C382F67B0",
  "SubOrders": {
    "SubOrder": [
      {
        "OriginalAmount": 1144.8,
        "DiscountAmount": 1144.8,
        "RuleIds": {
          "RuleId": [
            "{\"RuleId\": [11111111,11111111,11111111]}"
          ]
        },
        "TradeAmount": 0,
        "InstanceId": "dds-bp12c5b040dc****"
      }
    ]
  },
  "Rules": {
    "Rule": [
      {
        "RuleDescId": 11111111,
        "Title": "demo",
        "Name": "demoname"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	DBInstanceId is mandatory for this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.