Renew Instance (Postpaid Plan)

Last updated: 2020-06-04 18:34:41

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new MongoDB API 3.0 which is standardized and faster.

    1. API Description

    This API (RenewMongoDB) is used to renew a replica set instance (annual or monthly plan). Please make sure your account balance is sufficient.
    Domain for API request: mongodb.api.qcloud.com

    2. Input Parameters

    The following request parameter list only provides API request parameters. Common request parameters are also needed when the API is called.The Action field for this API is RenewMongoDB.

    Parameter Name Required Type Description
    instanceId Yes String ID of instance to work with. This can be obtained from instanceId in the returned values of API DescribeMongoDBInstances.
    period Yes Int Renewed usage period (in month). Value range: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]

    3. Output Parameters

    Parameter Name Type Description
    code Int Common error code; 0: Succeeded; other values: Failed.
    message String Error message description. A null value indicates a success
    codeDesc String Description of error code at business side. For a successful operation, "Success" will be returned. In case of an error, a message describing the reason for the error will be returned.
    data Object Returned order ID

    Parameter data indicates the order ID, and is composed as follows:

    Parameter Name Type Description
    data.dealId String Order ID. You can use API DescribeMongodbDealDetail to query order details

    4. Error Codes

    The following error codes include the business logic error codes for this API.

    Error Code Error Message Error Description
    11050 InvalidParameter Incorrect business parameter
    11056 InstanceNotExists Instance does not exist
    11051 InstanceDeleted The instance has been reclaimed upon expiration
    11067 PeriodNotInRange The requested period is not in the supported range
    100207 OperationConstraints.AccountBalanceNotEnough Insufficient account balance. Please top it up

    5. Example

    Input

    https://mongodb.api.qcloud.com/v2/index.php?Action=RenewMongoDB
    &instanceId=cmgo-6ozqe0uh
    &period=1
    

    Output

    {
        "code":"0",
        "message":"",
        "codeDesc": "Success",
        "data":{
            "dealId":"3374462"
        }
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help