Document Database Service

Manually Restore an Instance

2025-07-25 03:50:26
API Introduction

Call the restoreInstance API to manually restore the MongoDB instance.

API Restrictions

None

URI
POST /v1/openApi/restoreInstance

Path Parameter

None

Query Parameter

None

Request Parameters

Request Header Parameter

None

Request Body Parameter

Parameter

Required or Not

Parameter Type

Description

Instance

Lower-level Object

srcProdInstId

Yes

String

Backup source instance ID

f3687b55b1ce4cb1b781fb567b12ab0b


dstProdInstId

Yes

String

Backup target instance ID

f3687b55b1ce4cb1b781fb567b12ab0b


backupName

Yes

String

Backup data

test005


Response Parameter

Parameter

Required or Not

Parameter Type

Description

Example

Lower-level Object

statusCode

Yes

String

Return code

Value range: 800 indicates success

800


message

Yes

String

Return to Messages



returnObj

Yes

Object

Return object.



Sample Request

Request Body

{
    "srcProdInstId":"f3687b55b1ce4cb1b781fb567b12ab0b",
    "dstProdInstId":"f3687b55b1ce4cb1b781fb567b12ab0b",
    "backupName":"test005"
}
Response Example
{
    "statusCode": 800,
    "message": "the data of MongoDB instance is restored successfully",
    "returnObj": null
}
Status Code

Status Code

Description

800

Indicate that the request succeeded

900

Request response failed, see message for reason of failure

Error Codes

None


l1QlOwtwzh45