API Introduction
Call the describeMaintainTime API to query the maintainable time of MongoDB instance.
API Restrictions
None
URI
GET /v1/eventManageOpenApi/describeMaintainTime
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example |
prodInstId | Yes | String | External instance ID of the document database | f3687b55b1ce4cb1b781fb567b12ab0b |
Request Parameters
Request Header Parameter
None
Request Body Parameter
None
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 parameter query
/v1/eventManageOpenApi/describeMaintainTime?prodInstId=f3687b55b1ce4cb1b781fb567b12ab0b
Response Example
{
"statusCode": 800,
"message": "the maintainable time of the MongoDB instance is queried successfully",
"returnObj": {
"ProdInstId": "f3687b55b1ce4cb1b781fb567b12ab0b",
"MaintainTime": "08:00-12:00"
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None