DescribeRenewalPrice - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeRenewalPrice operation to query the renewal fee for an instance.

Operation Description

This operation is supported only for subscription instances.

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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeRenewalPrice	Read	All Resources	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceId	string	Yes	The ID of the instance.	rm-uf6wjk5xxxxxx
RegionId	string	No	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
PayType	string	No	The billing method of the instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription	Postpaid
DBInstanceClass	string	No	The instance type of the instance. For more information, see Primary instance types. By default, the current instance type applies.	mysql.n2.medium.2c
UsedTime	integer	Yes	The subscription duration of the instance. Valid values: If you set the TimeType parameter to Year, the value of the UsedTime parameter is within the range of 1 to 3. If you set the TimeType parameter to Month, the value of the UsedTime parameter is within the range of 1 to 9.	1
TimeType	string	Yes	The renewal cycle of the instance. Valid values: Year Month	Year
Quantity	integer	No	The number of the instances. Default value: 1.	1
OrderType	string	No	The type of the order that you want to place. Set the value to BUY.	BUY
BusinessInfo	string	No	The additional business information about the instance.	121436975448952

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	DC9F4EF6-D038-4405-B497-1F48E722C9F2
PriceInfo	object	An array that consists of price information.
OriginalPrice	float	The original price.	138
DiscountPrice	float	The discount.	27
Currency	string	The currency unit.	CNY
TradePrice	float	The transaction price, which is equal to the original price minus the discount.	111
Coupons	object []	An array that consists of information about the coupon.
IsSelected	string	Indicates whether the coupon is selected.	true
CouponNo	string	The ID of the coupon.	123456
Name	string	The name of the coupon.	test
Description	string	The description of the coupon.	test
RuleIds	array	An array that consists of the ID of the promotion rule.
	string	The ID of the promotion rule.	1001199213
ActivityInfo	object	The information about the promotion.
CheckErrMsg	string	The description of the error.	Error description
ErrorCode	string	The error code that is returned.	123456
Success	string	Indicates whether the request was successful.	Success
Rules	object []	An array that consists of the details of the promotion rule.
Name	string	The name of the promotion rule.	test
Description	string	The description of the promotion rule.	Content
RuleId	long	The ID of the promotion rule.	1001199213

Examples

Sample success responses

JSONformat

{
  "RequestId": "DC9F4EF6-D038-4405-B497-1F48E722C9F2",
  "PriceInfo": {
    "OriginalPrice": 138,
    "DiscountPrice": 27,
    "Currency": "CNY",
    "TradePrice": 111,
    "Coupons": {
      "Coupon": [
        {
          "IsSelected": "true",
          "CouponNo": "123456",
          "Name": "test",
          "Description": "test"
        }
      ]
    },
    "RuleIds": {
      "RuleId": [
        "1001199213"
      ]
    },
    "ActivityInfo": {
      "CheckErrMsg": "Error description\n",
      "ErrorCode": " 123456",
      "Success": "Success"
    }
  },
  "Rules": {
    "Rule": [
      {
        "Name": "test",
        "Description": "Content\n",
        "RuleId": 1001199213
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.