DescribeRenewalPrice - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the renewal fees for a subscription instance.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server
MariaDB

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5xxxxxx
RegionId	string	No	The region ID. 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
ResourceGroupId	string	No	The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.	rg-acfmx****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	DC9F4EF6-D038-4405-B497-1F48E722C9F2
PriceInfo	object	Details 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 coupon ID.	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 returned message.	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 rule.	test
Description	string	The description of the activity.	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

HTTP status code	Error code	Error message
400	SYSTEM.SaleValidateFailed	The request not refer to the correct order period. please check your Period or UsedTime param.
400	OrdQueryAccountError	Error calling account service.
400	Price.WanHuaTong.sys	Inquiry error.
404	canNotFindSubscription	Subscription information not found.

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

Change history

Change time

Summary of changes

Operation

2023-09-08

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Added Error Codes: 400
	Added Error Codes: 404

2023-07-21

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ResourceGroupId