MongoOperate接口

Certainly, here's the translated version of the information you provided, while keeping the format and not modifying file paths:

API calls require setting the 'whaleal-Token' in the request header. Fill in the parameters to initiate the request, and the returned content will be in JSON format. Special entity classes for return will be provided at the end. Parameters related to time should be passed in timestamp format.

For some API calls, you need to use the following parameters:
- 'eventId': Obtain this from the 'Get Cluster Log Information' API call. It represents the ID of the desired event.

- 'mongoMemberId': Retrieve this from the 'Find MongoDB Cluster Information Data' API call. It can be found within the 'mongoMember' collection in the returned result.

- 'replicateId': Similar to 'clusterId', acquire it from the result of the 'Find MongoDB Cluster Information Data' API call. It is located within the 'replicate' collection.

- 'clusterId': This parameter can be found in the result of the 'Find MongoDB Cluster Information Data' API call.

Please note that the parameter values representing time should be passed as timestamps. A timestamp represents the number of milliseconds since January 1, 1970 (UTC), also known as the Unix epoch.

Next, you will find the translated entity class table at the end.

Default Request Header Format, Special Cases with Special Declarations

The whaleal-Token is obtained from the login API call and should be included in the request header for subsequent API calls.

API call to retrieve whaleal-Token from Login

Deprecated (No Longer in Use)

1 Create MongoDB Standalone

1.1 Request Path

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

1.2 Request Parameters

Example - Create MongoDB Standalone; where MongoMember is as follows:
{
    "hostName": "chen",
    "hostId": "62bbfbe9a46517610435d615",
    "port": "25567",
    "dataDirectory": "/home/chen/data25567",
    "logFile": "/home/chen/log25567.log",
    "version": "mongodb-linux-x86_64-rhel70-4.2.21",
    "deleteDataAndLogAble": "false",
    "authAble": "false",
    "userName": "",
    "password": "",
    "configurationOptions": {
        "storage.wiredTiger.engineConfig.cacheSizeGB": "0.3"
    }
}

1.3 Response

{
    "msg": "In Progress",
    "eventId": "62ce9a7ded494511782ff392",
    "code": 1000,
    "data": {
        "id": null,
        "createTime": 0,
        "updateTime": 0,
        "memberName": "null:27017",
        "hostName": null,
        "hostId": null,
        "port": "27017",
        "version": null,
        "upgradeVersion": null,
        "userName": null,
        "password": null,
        "authDbName": "admin",
        "currentTimeMillis": 1657707133455,
        "dataDirectory": "/var/ops/mongodb1657707133455/data/",
        "logFile": "/var/ops/mongodb1657707133455/log/log.log",
        "confPath": "/var/ops/mongodb1657707133455/mongo.conf",
        "deleteDataAndLogAble": false,
        "authAble": false,
        "runShCmd": null,
        "type": 11,
        "status": "No State",
        "monitorServerStatus": false,
        "monitorTopAndOp": false,
        "collectMongoLog": false,
        "mongoLogFileOffset": 0,
        "operaLogTemp": [],
        "votes": 1,
        "priority": 1.0,
        "delay": 0,
        "buildIndexes": true,
        "procId": "",
        "clusterId": "62ce9a7ded494511782ff393",
        "replId": null,
        "clusterName": null,
        "tags": {},
        "configurationOptions": {},
        "operateVersion": 0
    }
}

2 Convert Single Node to Replica Set

2.1 Request Path

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

2.2 Request Parameters

2.3 Response

3 Create MongoDB Replica Set

3.1 Request Path

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

3.2 Request Parameters

Example - Create MongoDB Replica Set; where MongoReplica is as follows:
{
    "userName": "",
    "password": "",
    "type": 1,
    "clusterId": "",
    "replicaName": "qaq",
    "deleteDataAndLogAble": false,
    "status": "",
    "authAble": "false",
    "operaLog": [],
    "memberList": [
        {
            "type": 31,
            "hostName": "chen",
            "hostId": "62bbfbe9a46517610435d615",
            "port": "25025",
            "version": "mongodb-linux-x86_64-rhel70-4.2.21",
            "votes": "1",
            "priority": "1",
            "delay": "",
            "buildIndexes": true,
            "dataDirectory": "/home/chen/data25025",
            "logFile": "/home/chen/log25025.log",
            "configurationOptions": {
                "storage.wiredTiger.engineConfig.cacheSizeGB": "0.3"
            }
        }
    ],
    "replicationSettings": {
        "protocolVersion": null,
        "chainingAllowed": null,
        "writeConcernMajorityJournalDefault": null,
        "heartbeatTimeoutSecs": null,
        "electionTimeoutMillis": null,
        "catchUpTimeoutMillis": null,
        "catchUpTakeoverDelayMillis": null,
        "getLastErrorDefaults": null,
        "forceReconfigure": null
    }
}

3.3 Response

{
    "msg": "In Progress",
    "eventId": "62da7357239d00094230b51a",
    "code": 1000,
    "data": {
        "id": null,
        "createTime": 0,
        "updateTime": 0,
        "replicaName": null,
        "memberList": [],
        "type": 1,
        "clusterId": "62cf7903ed494511782ff4f9",
        "deleteDataAndLogAble": false,
        "status": null,
        "operaLog": [],
        "replicationSettings": {},
        "replicationOtherSettings": {},
        "authAble": false,
        "userName": null,
        "password": null,
        "authDbName": "admin",
        "protocolVersion": 1,
        "writeConcernMajorityJournalDefault": false
    }
}

4 Create MongoDB Sharded Cluster

4.1 Request Path

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

4.2 Request Parameters

Example - Create MongoDB Sharded Cluster; where MongoShard is as follows:

{
    "clusterName": "fenpian",
    "deleteDataAndLogAble": "false",
    "authAble": "false",
    "userName": "",
    "password": "",
    "shardingMap": {
        "shard1": {
            "memberList": [
                {
                    "type": 1,
                    "hostName": "chen",
                    "hostId": "62bbfbe9a46517610435d615",
                    "port": "44567",
                    "version": "mongodb-linux-x86_64-rhel70-4.2.21",
                    "votes": "1",
                    "priority": "1",
                    "delay": "",
                    "buildIndexes": "true",
                    "dataDirectory": "/home/chen/data44567",
                    "logFile": "/home/chen/log44567.log",
                    "configurationOptions": {
                        "storage.wiredTiger.engineConfig.cacheSizeGB": "0.3"
                    }
                }
            ],
            "replicationSettings": {
                "replicaSetId": "shard1",
                "protocolVersion": null,
                "chainingAllowed": null,
                "writeConcernMajorityJournalDefault": null,
                "heartbeatTimeoutSecs": null,
                "electionTimeoutMillis": null,
                "catchUpTimeoutMillis": null,
                "catchUpTakeoverDelayMillis": null,
                "getLastErrorDefaults": null,
                "forceReconfigure": null
            }
        }
    },
    "config

": {
        "memberList": [
            {
                "type": 1,
                "hostName": "server100",
                "hostId": "62b153a344ba1b7771c42df7",
                "port": "44567",
                "version": "mongodb-linux-x86_64-rhel70-4.2.21",
                "votes": "1",
                "priority": "1",
                "delay": "",
                "buildIndexes": "true",
                "dataDirectory": "/home/chen/data44567",
                "logFile": "/home/chen/log44567.log",
                "configurationOptions": {
                    "storage.wiredTiger.engineConfig.cacheSizeGB": "0.3"
                }
            }
        ],
        "replicationSettings": {
            "replicaSetId": "config",
            "protocolVersion": "",
            "chainingAllowed": "",
            "writeConcernMajorityJournalDefault": "",
            "heartbeatTimeoutSecs": "",
            "electionTimeoutMillis": "",
            "catchUpTimeoutMillis": "",
            "catchUpTakeoverDelayMillis": "",
            "getLastErrorDefaults": "",
            "forceReconfigure": ""
        }
    },
    "mongoS": [
        {
            "logFile": "/home/chen/log44567.log",
            "dataDirectory": "/home/chen/data44567",
            "hostName": "server200",
            "version": "mongodb-linux-x86_64-rhel70-4.2.21",
            "port": "44567",
            "configurationOptions": {
                "storage.wiredTiger.engineConfig.cacheSizeGB": "0.3"
            },
            "hostId": "62cbbd7607bebb71b8429e5e"
        }
    ]
}

4.3 Response

{
    "msg": "In Progress",
    "eventId": "62da73c4239d00094230b51c",
    "code": 1000,
    "data": {
        "id": null,
        "createTime": 0,
        "updateTime": 0,
        "clusterName": null,
        "clusterId": "62cf8e51ed494511782ff6c8",
        "config": null,
        "mongoS": [],
        "shardingMap": {},
        "operaLog": [],
        "deleteDataAndLogAble": false,
        "authAble": false,
        "userName": null,
        "password": null,
        "authDbName": "admin",
        "status": null
    }
}

5 Operate on Auth-Enabled Cluster

5.1 Request Path

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

5.2 Request Parameters

Example - Operate on Auth-Enabled Cluster; where map is as follows:
{
    "authAble": "true",    // Set to "false" when other parameters are not needed
    "userName": "123",
    "password": "123"
}

5.3 Response

6 Add Shard

6.1 Request Path

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

6.2 Request Parameters

Example of adding a shard; where MongoReplica is as follows:

{
    "type": 3,
    "clusterId": "",
    "replicaName": "qwe",
    "authAble": "true",
    "userName": "",
    "password": "",
    "deleteDataAndLogAble": false,
    "status": "",
    "operaLog": [],
    "memberList": [
        {
            "type": 51,
            "hostName": "chen",
            "hostId": "62bbfbe9a46517610435d615",
            "port": "44453",
            "version": "mongodb-linux-x86_64-rhel70-4.2.21",
            "votes": "1",
            "priority": "1",
            "delay": "",
            "buildIndexes": true,
            "dataDirectory": "/home/chen/data44453",
            "logFile": "/home/chen/log44453.log",
            "configurationOptions": {
                "storage.wiredTiger.engineConfig.cacheSizeGB": "0.3"
            }
        }
    ]
}

6.3 Response Result

7 Manage Cluster Information

7.1 Request Path

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

7.2 Request Parameters

7.3 Response Result

8 Upgrade/Downgrade

8.1 Request Path

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

8.2 Request Parameters

type: 1 for upgrade, -1 for downgrade

8.3 Response Result

9 Perform Operations on Nodes

9.1 Request Path

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

9.2 Request Parameters

operateType: updateMongoMemberInfo, startUp, shuntDown, restart, delete, canalQPS, openQPS, canalTopAndOP, openTopAndOP, canalCollectMongoLog, openColletMongoLog, becomePrimary, removeMember

9.3 Response Result

10 Perform Operations on Clusters

10.1 Request Path

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

10.2 Request Parameters

operateType: updateMongoMemberInfo, startUp, shuntDown, restart, delete, mdiag

10.3 Response Result

11 Update Cluster Information

11.1 Request Path

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

11.2 Request Parameters

11.3 Response Result

12 Create Single Node

12.1 Request Path

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

12.2 Request Parameters

12.3 Response Result

13 Add Node to Replica Set

13.1 Request Path

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

13.2 Request Parameters

-------- | ------ | | mongoMember | Body | MongoDB Member | Yes | JSON | | clusterId | Path | Cluster ID | Yes | String | | replicateId | Path | Replica ID | Yes | String |

13.3 Response Result

14 Add Mongos

14.1 Request Path

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

14.2 Request Parameters

14.3 Response Result

15 Update Cluster Name

15.1 Request Path

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

15.2 Request Parameters

15.3 Response Result

16 Execute a Plan

16.1 Request Path

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

16.2 Request Parameters

16.3 Response Result

17 Replica Set Initialization

17.1 Request Path

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

17.2 Request Parameters

17.3 Response Result

18 Collect MongoDB Cluster Logs

18.1 Request Path

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

18.2 Request Parameters

18.3 Response Result

19 Remove Node

19.1 Request Path

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

19.2 Request Parameters

19.3 Response Result

19 Create User

19.1 Request Path

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

19.2 Request Parameters

19.3 Response Result