All Products
Search

This Product

    ApsaraDB for MongoDB:RenewDBInstance

    Document Center

    ApsaraDB for MongoDB:RenewDBInstance

    Last Updated:Jan 17, 2023

    Manually renews a subscription instance.

    Operation Description

    Make sure that you fully understand the billing methods and pricing of ApsaraDB for MongoDB before you call this operation.

    This parameter is only 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:RenewDBInstance WRITE
    • MongoDB
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    ClientToken string No

    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 it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

    		 ETnLKlblzczshOTUbOCzxxxxxxxxxx
    DBInstanceId string Yes

    The ID of the instance.

    		 dds-bpxxxxxxxx
    Period integer Yes

    The period you set for the instance to implement payment renewal. Unit: months. Valid values: 1-9, 12, 24, and 36.

    		 1
    AutoPay boolean No

    Specifies whether to enable automatic payment for the instance. 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: Payment instructions: Log on to the console. In the upper-right corner, click Billing Management and select Billing Management from the drop-down list. The Billing Management page appears. In the left-side navigation pane, click Bills. On the Unpaid tab, click Make a Payment in the Actions column corresponding to the bill you want to pay.

    Default value: true.

    		 true
    BusinessInfo string No

    The business information.

    		 {“ActivityId":"000000000"}
    CouponNo string No

    The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

    		 1111111111111111

    Response parameters

    Parameter Type Description Example
    object
    RequestId string

    The ID of the request.

    		 B118EF45-9633-4EE3-8405-42ED4373721B
    OrderId string

    The ID of the order.

    		 203317xxxxxxxx

    Example

    Normal return example

    JSONFormat

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

    Error codes

    Http code Error code Error message
    400 TokenServiceError Request token is duplicated.

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