UpgradeDBInstance

Last updated: 2019-09-09 15:18:01

PDF

1. API Description

Domain name for API request: mongodb.tencentcloudapi.com.

This API (UpgradeDBInstance) is used to upgrade a monthly subscription MongoDB database instance to expand memory, storage and Oplog capacity.

Default request rate limit: 20/sec.

Note: This API supports Finance regions. Finance and non-Finance regions are isolated from each other. Therefore, if the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region specified in the Region field, for example: mongodb.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value​used for this API: UpgradeDBInstance.
Version Yes String Common parameter. The value used for this API: 2018-04-08
Region Yes String Common parameter. For more information, see the list of regions supported by the product.
InstanceId Yes String Instance ID, such as cmgo-p8vnipr5. It is identical to the instance ID displayed in the database console page.
Memory Yes Integer The memory capacity to which the instance will be upgraded (in GB).
Volume Yes Integer The disk capacity to which the instance will be upgraded (in GB).
OplogSize No Integer The Oplog capacity to which the instance will be upgraded (in GB). It is 10% of the disk capacity by default. The minimum value allowed is 10% of disk capacity, and the maximum is 90% of disk capacity.

3. Output Parameters

Parameter Name Type Description
DealId String Order ID
RequestId String The unique ID of a request, which is required for each troubleshooting case.

4. Example

Example 1 Upgrade a pay-as-you-go database instance

You need to upgrade a monthly subscription database instance using an API.

Input example

https://mongodb.tencentcloudapi.com/?Action=UpgradeDBInstance
&Memory=4
&Volume=250
&InstanceId=cmgo-f555zzzz
&OplogSize=26
&<Common request parameters>

Output example

{
    "Response": {
        "RequestId": "be8f4a30-ea2e-4623-8b6b-0ccce04cd9f7",
        "DealId": "19297475"
    }
}

5. Resources for Developers

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using cloud APIs.

SDK

Cloud API 3.0 comes with the software development kit (SDK) that supports multiple programming languages and makes it easier to call the APIs.

Command line tools

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter Invalid parameter