DescribeRenewalPrice - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation Description

This operation is applicable to subscription instances.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

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 keyword: refers to the condition keyword defined by the cloud product itself.
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.

Operate	access level	Resource type	conditional keyword	Association operation
dds:DescribeRenewalPrice	READ	MongoDB acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	without	without

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.	youhuiquan_promotion_option_id_for_blank
DBInstanceId	string	Yes	The ID of the instance.	dds-bp12c5b040dc****

Response parameters

Parameter	Type	Description	Example
	object
Order	object	The list of orders.
Coupons	array	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	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	array	The rules matching the coupons.
	object
OriginalAmount	number	The original price of the order.	1144.8
DiscountAmount	number	The discount amount of the order.	1144.8
RuleIds	array	The IDs of the matched rules.
	string	The ID of the matched rule.	11111111
TradeAmount	number	The actual price of the order.	0
InstanceId	string	The ID of the instance.	dds-bp12c5b040dc****
Rules	array	Details about the promotion rules.
	object
RuleDescId	long	The ID of the rule.	11111111
Title	string	The title of the rule.	demo
Name	string	The name of the rule.	demoname

Example

Normal return example

JSONFormat

{
  "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": [
            "11111111"
          ]
        },
        "TradeAmount": 0,
        "InstanceId": "dds-bp12c5b040dc****"
      }
    ]
  },
  "Rules": {
    "Rule": [
      {
        "RuleDescId": 11111111,
        "Title": "demo",
        "Name": "demoname"
      }
    ]
  }
}

Error codes

Http code	Error code	Error message
400	MissingParameter	DBInstanceId is mandatory for this action.

For a list of error codes, visit the API error center.