Document Database Service

Set the Monitoring Metric Collection Granularity of an Instance

2025-07-24 08:17:00
API Introduction

Call the modifyMonitorInterval API to set the monitoring and collection granularity of MongoDB instance.

API Restrictions

None

URI
POST  /v1/openApi/modifyMonitorInterval

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

7eb8d17d789047d2892d9f1ec89a20ac


granularity

Yes

String

Collection granularity, in seconds, range 1~300

60


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 monitoring collection granularity of MongoDB instance is set successfully


returnObj

Yes

Object

Return object.



Sample Request

Request Header

None

Request Body

{
    "prodInstId":"7eb8d17d789047d2892d9f1ec89a20ac",
    "granularity":"60"
}
Response Example
{
    "statusCode": 800,
    "message": "the monitoring collection granularity of MongoDB instance is set successfully",
    "returnObj": null
}
Status Code

Status Code

Description

800

Indicate that the request succeeded

900

Indicates that the request failed

Error Codes

None


dVIz7LipW_gD