All Products
Search
Document Center

ApsaraDB for MongoDB:RenewDBInstance

Last Updated:Mar 15, 2024

Manually renews an ApsaraDB for MongoDB subscription instance.

Operation description

Make sure that you fully understand the billing methods and pricing of ApsaraDB for MongoDB before you call this operation. For more information about the pricing of ApsaraDB for MongoDB, visit the pricing tab of the product buy page.

This operation is only applicable to instances that use the subscription billing method.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:RenewDBInstanceWRITE
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceIdstringYes

The instance ID.

dds-bpxxxxxxxx
PeriodintegerYes

The subscription period of the instance. Unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.

1
AutoPaybooleanNo

Specifies whether to enable automatic payment. Valid values:

  • true: enables automatic payment. Make sure that you have sufficient balance within your account.
  • false: disables automatic payment. You must perform the following operations to pay for the instance: Log on to the ApsaraDB for MongoDB console. In the upper-right corner, click Expenses and select User Center from the drop-down list. The User Center page appears. In the left-side navigation pane, choose Order Management > Renew. On the Renewal tab, find the bill that you want to pay and then click Renew in the Actions column.

Default value: true.

true
BusinessInfostringNo

The business information.

{“ActivityId":"000000000"}
CouponNostringNo

Specifies whether to use coupons. Default value: null. Valid values:

  • default or null: uses coupons.
  • youhuiquan_promotion_option_id_for_blank: does not use coupons.
1111111111111111
AutoRenewbooleanNo

Specifies whether to enable auto-renewal. Valid values:

  • true
  • false

Default value: false.

true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

B118EF45-9633-4EE3-8405-42ED4373721B
OrderIdstring

The ID of the order.

203317xxxxxxxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "B118EF45-9633-4EE3-8405-42ED4373721B",
  "OrderId": "203317xxxxxxxx"
}

Error codes

HTTP status codeError codeError message
400TokenServiceErrorRequest token is duplicated.

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

Change history

Change timeSummary of changesOperation
2024-01-31The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AutoRenew
2024-01-12The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400