API Introduction
Call the modifyMaintainTime API to modify the maintainable time of MongoDB instance.
API Restrictions
None
URI
POST /v1/eventManageOpenApi/modifyMaintainTime
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 |
prodInstId | Yes | String | Instance ID | f3687b55b1ce4cb1b781fb567b12ab0b | |
maintainTime | Yes | String | Maintenance Time | Optional range (00:00-04:00, 04:00-08:00, 08:00-12:00, 12:00-16:00, 16:00-20:00, 20:00-24: 00) |
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 XXX is queried successfully | |
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
ProdInstId | Yes | String | External instance ID of the document database | f3687b55b1ce4cb1b781fb567b12ab0b | |
MaintainTime | Yes | String | The maintainable time of the instance | 08:00-12:00 |
Sample Request
Request Header
None
Request Body
{
"prodInstId":"f3687b55b1ce4cb1b781fb567b12ab0b",
"maintainTime":"12:00-16:00"
}Response Example
{
"statusCode": 800,
"message": "the maintainable time of the MongoDB instance is modified successfully",
"returnObj": null
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None