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

Gets the price to renew a specified MongoDB instance for one month.

Operation description

This API is for subscription-based 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.	{“ActivityId":"000000000"}
CouponNo	string	No	Specifies whether to use a coupon. Valid values: default or null (default): An available coupon is automatically used. youhuiquan_promotion_option_id_for_blank: No coupon is used.	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 available 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
ActivityExtInfo	object
OriginalAmount	number	The original order amount.	1144.8
DiscountAmount	number	The discount amount for the order.	1144.8
RuleIds	object	The IDs of rules applied to the order.
RuleId	array	A list of rule IDs.
	string	An applied rule ID.	11111111
TradeAmount	number	The trade amount of the order.	0
Currency	string	The currency for the transaction.	USD
RequestId	string	The request ID.	EFD65226-08CC-4C4D-B6A4-CB3C382F67B0
SubOrders	object	The suborder details.
SubOrder	array<object>	A list of suborders.
	array<object>	Details of a suborder.
OriginalAmount	number	The original suborder amount.	1144.8
DiscountAmount	number	The discount amount of the suborder.	1144.8
RuleIds	object	The IDs of rules applied to the suborder.
RuleId	array	A list of rule IDs.
	string	An applied rule ID.	{"RuleId": [11111111,11111111,11111111]}
TradeAmount	number	The trade amount of the suborder.	0
InstanceId	string	The instance ID.	dds-bp12c5b040dc****
Rules	object	The promotion rule details.
Rule	array<object>	A list of promotion rules.
	object	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": false,
          "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.