API Introduction
Call describeMonitorInterval to query the monitoring and collection granularity of MongoDB instance.
API Restrictions
None
URI
GET /v1/openApi/describeMonitorInterval
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
prodInstId | Yes | String | Instance ID | 0addb92d52a84ffdbaa79fdada8a1833 |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The monitoring collection granularity of MongoDB instance is queried successfully | |
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
ProdInstId | Yes | String | Instance ID | 0addb92d52a84ffdbaa79fdada8a1833 | |
Granularity | Yes | String | Collection granularity, in seconds | 60 |
Sample Request
Request Header
None
Request parameter query
GET /v1/openApi/describeMonitorInterval?prodInstId=0addb92d52a84ffdbaa79fdada8a1833
Response Example
{
"statusCode": 800,
"message": "the monitoring collection granularity of MongoDB instance is queried successfully",
"returnObj": {
"ProdInstId": "0addb92d52a84ffdbaa79fdada8a1833",
"Granularity": "60"
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None