All Products
Search
Document Center

ApsaraDB RDS:DescribeRenewalPrice

Last Updated:Feb 29, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxx
RegionIdstringNo

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
PayTypestringNo

The billing method of the instance. Valid values:

  • Postpaid: pay-as-you-go
  • Prepaid: subscription
Postpaid
DBInstanceClassstringNo

The instance type of the instance. For more information, see Primary instance types. By default, the current instance type applies.

mysql.n2.medium.2c
UsedTimeintegerYes

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
TimeTypestringYes

The renewal cycle of the instance. Valid values:

  • Year
  • Month
Year
QuantityintegerNo

The number of the instances. Default value: 1.

1
OrderTypestringNo

The type of the order that you want to place. Set the value to BUY.

BUY
BusinessInfostringNo

The additional business information about the instance.

121436975448952
ResourceGroupIdstringNo

The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.

rg-acfmx****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

DC9F4EF6-D038-4405-B497-1F48E722C9F2
PriceInfoobject

Details of price information.

OriginalPricefloat

The original price.

138
DiscountPricefloat

The discount.

27
Currencystring

The currency unit.

CNY
TradePricefloat

The transaction price, which is equal to the original price minus the discount.

111
Couponsobject []

An array that consists of information about the coupon.

IsSelectedstring

Indicates whether the coupon is selected.

true
CouponNostring

The coupon ID.

123456
Namestring

The name of the coupon.

test
Descriptionstring

The description of the coupon.

test
RuleIdsarray

An array that consists of the ID of the promotion rule.

string

The ID of the promotion rule.

1001199213
ActivityInfoobject

The information about the promotion.

CheckErrMsgstring

The returned message.

Error description
ErrorCodestring

The error code that is returned.

123456
Successstring

Indicates whether the request was successful.

Success
Rulesobject []

An array that consists of the details of the promotion rule.

Namestring

The name of the rule.

test
Descriptionstring

The description of the activity.

Content
RuleIdlong

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 codeError codeError message
400SYSTEM.SaleValidateFailedThe request not refer to the correct order period. please check your Period or UsedTime param.
400OrdQueryAccountErrorError calling account service.
400Price.WanHuaTong.sysInquiry error.
404canNotFindSubscriptionSubscription information not found.

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

Change history

Change timeSummary of changesOperation
2023-09-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
    Added Error Codes: 404
2023-07-21The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId