Discovery of nodes in MongoDB instance
Perform discovery of nodes in the MongoDB cluster. After discovering the nodes in the cluster, this response should be used to update the instance properties.
Path Parameters
- clientId string required
Client Id of the Master node
- application/json
Request Body
- path string
Default value:
/
clientEntity object
hostName string requiredMaster node hostname
clientId integer requiredMaster node client Id
clientName string requiredMaster node client name
distAppsProperties object
clusterType integerDefault value:
8
subclient object
_type_ integerDefault value:
5
instanceId integer requiredMongoDB I
clusterConfig object
mdbConfig object
mdbServerType integerDefault value:
2
adminUser object
userName string requiredMongoDB username, if authentication is enabled on the MongoDB cluster
masterNode object
hostName string requiredMaster node hostname provided in the instance
osUser string requiredOS user used for impersonation provided
portNumber integer requiredPort number of the MongoDB server/Mongos process running on the master that is provided in the instance
binPath string requiredPath where MongoDB binaries are present on the master node that is provided int he instance
client object
hostName string requiredMaster node host
clientId integer requiredMaster node client id
clientName string requiredMaster node client name
sslCMCredInfo object
Needed only if TLS/SSL authentication is enabled
_type_ integercredentialId integercredentialName string
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue string- path string
browseItems object[]
mdbItem object
mdbConfig object
mdbServerType integermdbServerList object[]
hostName stringrole integerhealth integermdbVersion stringportNumber integerdataPath stringconfigFilePath stringbindIp stringlogPath stringrepsetName stringconfigFileContents stringsubType integerengineName stringisLoggingEnabled booleanmemberId integerclient object
clientId integerclientName string_type_ integer
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"path": "string",
"browseItems": [
{
"mdbItem": {
"mdbConfig": {
"mdbServerType": 0,
"mdbServerList": [
{
"hostName": "string",
"role": 0,
"health": 0,
"mdbVersion": "string",
"portNumber": 0,
"dataPath": "string",
"configFilePath": "string",
"bindIp": "string",
"logPath": "string",
"repsetName": "string",
"configFileContents": "string",
"subType": 0,
"engineName": "string",
"isLoggingEnabled": true,
"memberId": 0,
"client": {
"clientId": 0,
"clientName": "string",
"_type_": 0
}
}
]
}
}
}
]
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "WebServer",
"value": "OBLIVION"
}
]
},
"path": "/",
"browseItems": [
{
"mdbItem": {
"mdbConfig": {
"mdbServerType": 4,
"mdbServerList": [
{
"hostName": "xxx.xxx.xxx",
"role": 1,
"health": 1,
"mdbVersion": "7.0.0",
"portNumber": 27777,
"dataPath": "/mongo5/data",
"configFilePath": "/mongo5/mongod.conf",
"bindIp": "0.0.0.0",
"logPath": "/mongo5/data/mongod.log",
"repsetName": "mongo5",
"configFileContents": "systemLog:\n destination: file\n logAppend: true\n path: /mongo5/data/mongod.log\nstorage:\n dbPath: /mongo5/data\nprocessManagement:\n fork: \"true\"\n pidFilePath: /mongo5/data/mongod.pid\n timeZoneInfo: /usr/share/zoneinfo\nnet:\n port: 27777\n bindIp: 0.0.0.0\nreplication:\n replSetName: mongo5\n",
"subType": 2,
"engineName": "wiredTiger",
"isLoggingEnabled": true,
"memberId": 0,
"client": {
"clientId": 712,
"clientName": "xxx",
"_type_": 3
}
}
]
}
}
}
]
}
Bad Request
- application/json
- application/xml
- Schema
- Example
Schema
- string
Request body is empty or format is invalid
- Schema
- Example (from schema)
Schema
- object
<root/>
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}