DescribeRenewalPrice - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the monthly renewal price of an ApsaraDB for MongoDB instance.

Operation description

This operation is applicable to subscription 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	The business information. This is an additional parameter.	{“ActivityId":"000000000"}
CouponNo	string	No	The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.	default
DBInstanceId	string	Yes	The ID of the instance.	dds-bp12c5b040dc****

Response elements

Element	Type	Description	Example
	object
Order	object	The list of orders.
Coupons	object
Coupon	array<object>	Details about the coupons.
	object
Description	string	The description of the coupon.	coupondemo
IsSelected	string	Indicates whether the coupon was selected.	true
CouponNo	string	The coupon number.	youhuiquan_promotion_option_id_for_blank
Name	string	The name of the coupon.	youhuiquan111
OriginalAmount	number	The original price of the order.	1144.8
DiscountAmount	number	The discount amount of the order.	1144.8
RuleIds	object
RuleId	array	The IDs of the matched rules.
	string	The ID of the matched rule.	11111111
TradeAmount	number	The actual price of the order.	0
Currency	string	The type of the currency. Valid values: USD: United States dollar JPY: Japanese Yen	USD
RequestId	string	The ID of the request.	EFD65226-08CC-4C4D-B6A4-CB3C382F67B0
SubOrders	object
SubOrder	array<object>	The rules matching the coupons.
	array<object>
OriginalAmount	number	The original price of the order.	1144.8
DiscountAmount	number	The discount amount of the order.	1144.8
RuleIds	object
RuleId	array	The IDs of the matched rules.
	string	The ID of the matched rule.	{"RuleId": [11111111,11111111,11111111]}
TradeAmount	number	The actual price of the order.	0
InstanceId	string	The ID of the instance.	dds-bp12c5b040dc****
Rules	object
Rule	array<object>	Details about the promotion rules.
	object
RuleDescId	integer	The ID of the rule.	11111111
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": "coupondemo",
          "IsSelected": "true",
          "CouponNo": "youhuiquan_promotion_option_id_for_blank",
          "Name": "youhuiquan111"
        }
      ]
    },
    "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.