接口功能介绍
调用describeMaintainTime接口查询MongoDB实例的可维护时间。
接口约束
无
URI
GET /v1/eventManageOpenApi/describeMaintainTime
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| prodInstId | 是 | String | 文档数据库对外的实例标识 | f3687b55b1ce4cb1b781fb567b12ab0b |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 查询XXX成功 | |
| returnObj | 是 | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ProdInstId | 是 | String | 文档数据库对外的实例标识 | f3687b55b1ce4cb1b781fb567b12ab0b | |
| MaintainTime | 是 | String | 实例的可维护时间 | 08:00-12:00 |
请求示例
请求头header
无
请求参数query
/v1/eventManageOpenApi/describeMaintainTime?prodInstId=f3687b55b1ce4cb1b781fb567b12ab0b
响应示例
{
"statusCode": 800,
"message": "查询MongoDB实例的可维护时间成功",
"returnObj": {
"ProdInstId": "f3687b55b1ce4cb1b781fb567b12ab0b",
"MaintainTime": "08:00-12:00"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
