MongoDBData接口

When making API calls, it is necessary to set the whaleal-Token in the request header and provide the required parameters to initiate the request. The response content will be in JSON format, and special entity classes for the response will be provided in the entity class table at the end. For parameters related to time, use timestamp format.

For some API calls, you need to use nodeId, mongoMemberId, clusterId, and eventId:

• nodeId is the same as mongoMemberId, found in the data collection of the result set returned by the "Retrieve MongoDB Cluster Information Data" API.
• eventId can be found in the "Retrieve Cluster Log Information" API for the desired event.
• clusterId is present in the result set returned by the "Retrieve MongoDB Cluster Information Data" API.

Default Request Header Format, Special Cases Require Special Declaration

The whaleal-Token is returned when calling the login API. It should be placed in the request header when making subsequent API calls. Call the Login API to Obtain whaleal-Token

---

1 Retrieve MongoDB Cluster Information

Deprecated 已弃用

1.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/monitor/project/data//

1.2 Request Parameters

2 Retrieve Top Five Cluster Sizes

2.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/monitor/cluster/size/top/five

2.2 Request Parameters

2.3 Response

{
    "code": 1000,
    "data": [
        {
            "_id": "62d666c50f57845ee4c76090",
            "clusterSize": 0,
            "size": "0.00KB",
            "clusterName": "test_repl"
        },
        {
            "_id": "62d65068561b4a25b8339740",
            "clusterSize": 0,
            "size": "0.00KB",
            "clusterName": "shard"
        }
    ]
}

3 Retrieve Top Five Collection Sizes

3.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/monitor/collection/size/top/five

3.2 Request Parameters

3.3 Response

{
    "code": 1000,
    "data": [
        {
            "_id": "62d67d21239d00094230b08f",
            "clusterId": "62d67d21239d00094230b08f",
            "createTime": 1658394516783,
            "dbTables": {
                "name": "fs.chunks",
                "type": "collection",
                "options": {},
                "info": {
                    "readOnly": false,
                    "uuid": {
                        "type": 4,
                        "data": "8MfjmDBFR5q9BYztGFDJQQ=="
                    }
                },
                "idIndex": {
                    "v": 2,
                    "key": {
                        "_id": 1
                    },
                    "name": "_id_",
                    "ns": "test.testColl"
                },
                "storageSize": 20,
                "size": 0,
                "ns": "test.testColl"
            },
            "fromServerExe": false,
            "updateTime": 0,
            "clusterName": "shard",
            "dbName": "test",
            "collectionName": "testColl",
            "size": "0.00KB"
        }
    ]
}

4 Retrieve Top Five QPS

4.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/monitor/QPS/size/top/five

4.2 Request Parameters

4.3 Response

{
    "code": 1000,
    "data": [
        {
            "_id": {
                "hostId": "62cbbd7607bebb71b8429e5e",
                "port": "47018"
            },
            "host": "server200",
            "port": "47018",
            "QPS": 5520,
            "instance": "server200:47018"
        }
    ]
}

5 Retrieve Top Five Connection Instances

5.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/monitor/connection/instance/top/five

5.2 Request Parameters

5.3 Response

{
    "code": 1000,
    "data": [
        {
            "_id": {
                "hostId": "62cbbd7607bebb71b8429e5e",
                "port": "47018"
            },
            "host": "server200",
            "port": "47018",
            "Conn": 76,
            "instance": "server200:47018"
        }
    ]
}

6 Retrieve Top Five Slow Queries

6.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/monitor/slowest/instance/top/five

6.2 Request Parameters

6.3 Response

{
    "code": 1000,
    "data": [
        {
            "_id": "62d66d3cc5b6206027b993b0",
            "slow count": 8,
            "instance": "server200:47018"
        }
    ]
}

7 Retrieve Node Real-time Monitoring Information

7.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/monitor/data//

7.2 Request Parameters

timeType: REAL_TIME, ONE_DAY, ONE_WEEK
dataType: qps, conn, pageFaults, memory, net, anAssert, cacheFlow, cacheUsage, latency, tickets, targetQ, scanAndOrder, collectionScan, documentOp, lockCondition, databaseLock, collectionLock, transactionCondition, deletedDocument

7.3 Response

 {
    "code": 1000,
    "data": {
        "delete": [
            0.0,
            0.0,
            0.0
        ],
        "insert": [
            8.0,
            15.0,
            2.0
        ],
        "query": [
            0.0,
            0.0,
            0.0
        ],
        "cmd": [
            6.0,
            5.0,
            3.0
        ],
        "getMore": [
            1.0,
            2.0,
            2.0
        ],
        "update": [
            0.0,
            0.0,
            0.0
        ]
    },
    "createTime": [
        1659511920000,
        1659511980000,
        1659512040000
    ],
    "name": "qps",
    "message": {
        "insert": "The average rate of inserts performed per second over the selected sample period",
        "delete": "The average rate of deletes performed per second over the selected sample period",
        "update": "The average rate of updates performed per second over the selected sample period",
        "query": "The average rate of queries performed per second over the selected sample period",
        "command": "The average rate of commands performed per second over the selected sample period",
        "getMore": "The average rate of getMores performed per second on any cursor over the selected sample period. On a primary, this number can be high even if the query count is low as the secondaries \"getMore\" from the primary often as part of replication."
    },
    "info": {
        "delete": {
            "max": 10,
            "min": 0,
            "avg": "0.35"
        },
        "insert": {
            "max": 32,
            "min": 0,
            "avg": "8.75"
        },
        "query": {
            "max": 0,
            "min": 0,
            "avg": "0.01"
        },
        "cmd": {
            "max": 10,
            "min": 1,
            "avg": "4.42"
        },
        "getMore": {
            "max": 2,
            "min": 0,
            "avg": "0.93"
        },
        "update": {
            "max": 0,
            "min": 0,
            "avg": "0.05"
        }
    }
}

8 Query Cluster Information by ID

8.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoCluster/

8.2 Request Parameters

8.3 Response

{
    "code": 1000,
    "data": {
        "id": "62d67d21239d00094230b08f",
        "createTime": 1658223967052,
        "updateTime": 1658223967052,
        "clusterName": "test",
        "type": 2,
        "mongoMember": null,
        "mongoReplica": {
            "id": "62d67d21239d00094230b08f",
            "createTime": 0,
            "updateTime": 0,
            "replicaName": "test",
            "memberList": [
              // Node information
              ...
            ],
            "type": 1,     //1: Single node, 2: Replica set, 3: Sharded
            "clusterId": "62d67d21239d00094230b08f",
            "deleteDataAndLogAble": false,
            "status": "Running",
            "operaLog": [],
            "replicationSettings": {},
            "replicationOtherSettings": {
                "securityKeyFileValue":
            },
            "authAble": true,
            "userName": "root",
            "password": "123456",
            "authDbName": "admin",
            "protocolVersion": 1,
            "writeConcernMajorityJournalDefault": false
        },
        "mongoShard": null,
        "status": "Normal",
        "fcv": "4.2",
        "tag": "ys",
        "create": true
    }
}

9 Get Cluster Log Information

9.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoClusterLogData///

9.2 Request Parameters

9.3 Response

{
    "code": 1000,
    "data": [
        {
            "id": "62d4f0363e50046ce51d44f3",
            "createTime": 1658122294338,
            "updateTime": 1658122294338,
            "memberName": "cluster",
            "clusterId": "62d4bdfd3e50046ce51d41f6",
            "eventId": null,
            "logInfoList": [
                {
                    "createTime": 1658122294338,
                    "log": "rz Cluster operation [updateMongoMemberInfo] successful"
                }
            ]
        }
    ]
}

10 Get Mongo Cluster Log Count

10.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoClusterLogCount/

10.2 Request Parameters

10.3 Response

11 Query MongoD Log Information

11.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoDLogData///

11.2 Request Parameters

Type: If empty, query all. Possible values: SHARDING, STORAGE, RECOVERY, CONTROL

![

img_5.png](../../../images/whalealPlatformImages/getMongoDLogData.png)

11.3 Response

{
    "code": 1000,
    "data": [
        {
            "id": "62d5037fbb551e67507f9a32",
            "createTime": 0,
            "updateTime": 0,
            "log": {
                "t": "2022-07-18T06:53:49.151+00:00",
                "s": "I",
                "c": "NETWORK",
                "id": "[conn3161]",
                "msg": "end connection 192.168.3.80:58778 (5 connections now open)"
            },
            "nodeId": "62d4be9d3e50046ce51d4228",
            "fileOffset": 0
        }
    ]
}

12 Query MongoD Log Count

12.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoDLogCount/

12.2 Request Parameters

Type: If empty, query all. Possible values: STORAGE, RECOVERY, CONTROL

12.3 Response

13 Get Mongo Top and Op

13.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoTopAndOp//

13.2 Request Parameters

Type: 1 for top, 2 for op

13.3 Response

14 Update Cluster Name

14.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/updateClusterName//

14.2 Request Parameters

14.3 Response

15 Get Mongo Statistics

15.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoStatistics

15.2 Request

15.3 Response

16 Query Mongo Event by Event ID

16.1 Request Path

Get: http://{Server-Host}:{Port}/api/server/mongo/findMongoEventLogByEventId/

16.2 Request Parameters

16.3 Response

{
    "code": 1000,
    "data": [
        {
            "createTime": 1658131316409,
            "log": "chen:45463 Operation [openQPS] successful"
        },
        {
            "createTime": 1658131317418,
            "log": "Event group ended"
        }
    ]
}

17 Get Mongo Event Log Data

17.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoEventLogData///

17.2 Request Parameters

Status: 'Initialized', 'Running', 'Paused', 'Ended', 'Exception Ended', 'Aborted'

| Name | Located in | Description |

 Required    |        Schema   |

| -------------------|----------------------|-------------------------------|-----------------|----------- | | clusterId | Path | Cluster ID | Yes |String | pageSize | Path | Page Size | Yes |int | pageIndex | Path | Page Index | Yes |int | status | Params | Status | No |String | eventName | Params | Event Name | No |String | operatorName | Params | Operator | No |String

17.3 Response

{
    "code": 1000,
    "data": [
        {
            "id": "62d5281602d41247cf3741d0",
            "createTime": 1658136598663,
            "updateTime": 1658136704891,
            "clusterId": "62d4bdfd3e50046ce51d41f6",
            "eventName": "Cluster operation: delete",
            "operatorId": "62b2d434e0869c777c439867",
            "operatorName": "lhp1234",
            "status": "Ended",
            "logList": null
        }
    ]
}

18 Get Mongo Event Log Count

18.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoEventLogCount/

18.2 Request Parameters

Status: 'Initialized', 'Running', 'Paused', 'Ended', 'Exception Ended', 'Aborted'

18.3 Response

19 Retrieve MongoDB Cluster Information Data

19.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/findMongoDBClusterInfoData//

19.2 Request Parameters

type: 1 for single node, 2 for replica set, 3 for sharded

19.3 Response

{
    "code": 1000,
    "data": [
        {
            "id": "62fa2017fe07726988b761fa",
            "createTime": 1660559406829,
            ...
            "configurationOptions": {
                ...
                "net_bindIp": "0.0.0.0",
                "net_port": "36398"
            },
            "operateVersion": 3916
        },
        ...
    ]
}

20 Retrieve MongoDB Cluster Information Data Count

20.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/findMongoDBClusterInfoCount

20.2 Request Parameters

type: 1 for single node, 2 for replica set, 3 for sharded

20.3 Response

21 Get MongoDB Collections

21.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoDBCollections//

21.2 Request Parameters

21.3 Response

{
    "code": 1000,
    "data": [
        {
            "name": "coll",
            "type": "collection",
            "options": {},
            ...
            "size": 335,
            "ns": "cc.coll"
        },
        ...
    ]
}

22 Get MongoDB Cluster Users

22.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoDBClusterUser/

22.2 Request Parameters

22.3 Response

{
    "code": 1000,
    "data": [
        {
            "_id": "admin.16581342589211",
            "userId": {
                "type": 4,
                "data": "LMMiWU2KT5GVoDCbkt3B4g=="
            },
            ...
            "roles": [
                {
                    "role": "root",
                    "db": "admin"
                }
            ]
        },
        ...
    ]
}

23 Get MongoDB Cluster Roles

23.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoDBClusterRole/

23.2 Request Parameters

23.3 Response

{
    "code": 1000,
    "data": [
        {
            "role": "__queryableBackup",
            "db": "admin",
            ...
            "privileges": [
                {
                    "resource": {
                        "db": "config",
                        "collection": "settings"
                    },
                    "actions": [
                        "find"
                    ]
                }
            ]
        },
        ...
    ]
}

24 Execute an Explain Plan

24.1 Request Path

POST: http://{Server-Host}:{Port}/api/server/mongo/exeExplainPlan//

24.2 Request Parameters

24.3 Response

| Name | Description | Schema

| | ---- | ------------------ | ------ | | code | Status: 1000 | int | | data | Returned data | JSON |

{
    "code": 1000,
    "data": {
        "explain": {
            ...
            "executionStats": {
                ...
                "executionStages": {
                    ...
                    "isEOF": 1
                },
                "allPlansExecution": []
            },
            ...
        },
        ...
    }
}

25 Get All MongoDB Configuration Parameters

25.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoDBProcessArgument

25.2 Request

No specific request details provided.

25.3 Response

{
    "code": 1000,
    "data": [
        {
            "id": "62faf2bcd0810e3aeace6dae",
            "createTime": 0,
            "updateTime": 0,
            "maxVersion": null,
            "minVersion": null,
            "name": "SYSTEM_LOG_VERBOSITY",
            "options": [
                {
                    "label": "1 (v)",
                    "value": "1"
                },
                ...
            ],
            "path": "systemLog.verbosity",
            "processTypes": "ALL",
            "shortName": "verbosity",
            "type": "INTEGER",
            "credential": false
        },
        ...
    ]
}

26 Get MongoDB Collections

26.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMongoDBCollections//

26.2 Request Parameters

26.3 Response

{
    "code": 1000,
    "data": [
        {
            "name": "test",
            "sub": [
                {
                    "name": "a",
                    "type": "collection",
                    ...
                    "ns": "test.a"
                }
            ]
        },
        ...
    ]
}

27 Query Cluster Database Data

27.1 Request Path

POST: http://{Server-Host}:{Port}/api/server/mongo/queryClusterDbData//

27.2 Request Parameters

Example of the query criteria:

{
    "ns": "test.a",
    "query": "{}",
    "pageSize": 10,
    "pageIndex": 1
}

27.3 Response

{
    "code": 1000,
    "data": [
        {
            "_id": {
                "date": 1659684764000,
                "timestamp": 1659684764
            },
            "a": 1.0
        },
        ...
    ]
}

28 Create Index

28.1 Request Path

POST: http://{Server-Host}:{Port}/api/server/mongo/createIndex//

28.2 Request Parameters

Example of index configuration:

{
    "indexName": "chen",
    "ns": "test.coll",
    "index": "{a:1}",
    "buildIndexInTheBackground": false,
    ...
}

28.3 Response

29 Diagnostic Data

29.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/mdiagData///

29.2 Request Parameters

29.3 Response

{
    "code": 1000,
    "data": [
        {
            "_id": "62ecf7a2a3a6e138ea1f00b0",
            "filename": "mdiag_server100_1659696513419.gz",
            ...
            "id": "62ecf7a2a3a6e138ea1f00b0"
        },
        ...
    ]
}

30 Get Diagnostic Count

30.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/mdiagCount/

30.2 Request Parameters

30.3 Response

31 Update Event Status

31.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/updateEventStatus//

**31

.2 Request Parameters**

31.3 Response

32 Get Mdiag Log

32.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getMdiagLog//

32.2 Request Parameters

32.3 Response

33 Get All Cluster IDs and Names

33.1 Request Path

GET: http://{Server-Host}:{Port}/api/server/mongo/getAllClusterIdAndName

33.2 Request Parameters

33.3 Response

---