Document Database Service

Renew a MongoDB instance

2025-07-25 01:26:48
API Introduction

Call the renewOrderForMongoDB API to renew the MongoDB instance.

API Restrictions

None

URI
POST /v1/extApi/renewOrderForMongoDB

Path Parameter

None

Query Parameter

None

Request Parameters

Request Header Parameter

None

Request Body Parameter

Parameter

Required or Not

Parameter Type

Description

Example

Lower-level Object

cycleCount

Yes

String

Subscription cycle, the value must be greater than zero and the longest subscription duration cannot exceed 384 months.



cycleType

Yes

String

Subscription type, 3 for monthly subscription, 5 for one-year subscription, 6 for two-year subscription, and 7 for three-year subscription. The cycleCnt attribute is 1, and the value of cycleType is 3, which indicates 1 month subscription



accessKey

Yes

String

Resource pool ak



securityKey

Yes

String

Resource pool sk



resourceIds

Yes

String[]

Instance id array



Response Parameter

Parameter

Required or Not

Parameter Type

Description

Example

Lower-level Object

statusCode

Yes

Integer

Response code value range: 800 indicates success, 900 indicates failure

800


message

Yes

String

Response information

The MongoDB instance is renewed successfully


returnObj

Yes

Object

Return object.



Table returnObj

Parameter

Required or Not

Parameter Type

Description

Example

Lower-level Object

newOrderNo

Yes

String

Order Number

true


submitted

Yes

Boolean

Order submission status



totalPrice

Yes

Integer

Total price of the order



newOrderId

Yes

String

Order ID



errorMessage

Yes

String

Error Message



Sample Request

Request Header

None

Request Body

{
    "cycleCount":"1",
    "cycleType":"3",
    "accessKey":"4a4bdc57e06542199b5f98d4cd107be2",
    "securityKey":"5566ddcc9b1646c6b77a0eaeff1c8763",
    "resourceIds":[
        "7fa7256174df4016adee9bfb8dbb5470"
    ]
}
Response Example
{
    "statusCode": 800,
    "message": "the MongoDB instance is renewed successfully",
    "returnObj": {
        "newOrderNo": "20221124113437387905",
        "submitted": true,
        "totalPrice": 477.0,
        "newOrderId": "fec7c260a6b242f5adde45b0a6a25a67",
        "errorMessage": ""
    }
}
Status Code

Status Code

Description

800

Indicate that the request succeeded

900

Indicates that the request failed

Error Codes

None


ciMm4TbFI5GY