View MongoDB instance properties
Select
SaaS
Customer Managed
This operation is used to get the MongoDB instance properties
Path Parameters
- instanceId string required
MongoDB Instance Id
Responses
- 200
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringinstanceProperties object[]
isDeleted booleanapplicationSize integerexcludeFromSLA booleanscIdxEnabled integerinstance object
clientName stringinstanceName stringdisplayName stringinstanceId integerinstanceGUID stringclientId integerappName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integerdistributedClusterInstance object
clusterType integerinstance object
instanceName stringinstanceId integerclusterConfig object
mdbConfig object
mdbServerType integeradminUser object
userName stringmasterNode object
hostName stringosUser stringportNumber integerbinPath stringclient object
clientId integerclientName stringsslCMCredInfo object
credentialId integercredentialName stringmdbServerList object[]
hostName stringrole integerosUser stringhealth integercmdLineOption stringmdbVersion stringportNumber integerdataPath stringbinPath stringconfigFilePath stringuseAsDataAccessNode booleanrepsetName stringsubType integerengineName stringmemberId integerclient object
clientId integerclientName stringinstanceActivityControl object
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleancloudDBInstance object
overRideAccessNode booleanaccessNodes object
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"instanceProperties": [
{
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"scIdxEnabled": 0,
"instance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"instanceGUID": "string",
"clientId": 0,
"appName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
},
"distributedClusterInstance": {
"clusterType": 0,
"instance": {
"instanceName": "string",
"instanceId": 0
},
"clusterConfig": {
"mdbConfig": {
"mdbServerType": 0,
"adminUser": {
"userName": "string"
},
"masterNode": {
"hostName": "string",
"osUser": "string",
"portNumber": 0,
"binPath": "string",
"client": {
"clientId": 0,
"clientName": "string"
}
},
"sslCMCredInfo": {
"credentialId": 0,
"credentialName": "string"
},
"mdbServerList": [
{
"hostName": "string",
"role": 0,
"osUser": "string",
"health": 0,
"cmdLineOption": "string",
"mdbVersion": "string",
"portNumber": 0,
"dataPath": "string",
"binPath": "string",
"configFilePath": "string",
"useAsDataAccessNode": true,
"repsetName": "string",
"subType": 0,
"engineName": "string",
"memberId": 0,
"client": {
"clientId": 0,
"clientName": "string"
}
}
]
}
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
}
}
]
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "WebServer",
"value": "OBLIVION"
}
]
},
"instanceProperties": [
{
"isDeleted": false,
"applicationSize": 77594624,
"excludeFromSLA": false,
"scIdxEnabled": 1,
"instance": {
"clientName": "MongoDBInstance",
"instanceName": "MongoDBInstance",
"displayName": "MongoDBInstance",
"instanceId": 723,
"instanceGUID": "EC308462-8A5C-4A44-9932-118D508E1E07",
"clientId": 825,
"appName": "Big Data Apps",
"applicationId": 64,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"distributedClusterInstance": {
"clusterType": 8,
"instance": {
"instanceName": "MongoDBInstance",
"instanceId": 723
},
"clusterConfig": {
"mdbConfig": {
"mdbServerType": 4,
"adminUser": {
"userName": "MongoDBUser1"
},
"masterNode": {
"hostName": "xxx.xxx.xxx",
"osUser": "root",
"portNumber": 27777,
"binPath": "/usr/bin",
"client": {
"clientId": 712,
"clientName": "xxx"
}
},
"sslCMCredInfo": {
"credentialId": 0,
"credentialName": ""
},
"mdbServerList": [
{
"hostName": "xxx.xxx.xxx",
"role": 1,
"osUser": "",
"health": 1,
"cmdLineOption": "{ \"config\" : { \"_id\" : \"mongo5\", \"version\" : 4, \"term\" : 3, \"members\" : [ { \"_id\" : 0, \"host\" : \"xxx.xxx.xxx:27777\", \"arbiterOnly\" : false, \"buildIndexes\" : true, \"hidden\" : false, \"priority\" : 1.0, \"tags\" : { }, \"secondaryDelaySecs\" : 0, \"votes\" : 1 } ], \"protocolVersion\" : 1, \"writeConcernMajorityJournalDefault\" : true, \"settings\" : { \"chainingAllowed\" : true, \"heartbeatIntervalMillis\" : 2000, \"heartbeatTimeoutSecs\" : 10, \"electionTimeoutMillis\" : 10000, \"catchUpTimeoutMillis\" : -1, \"catchUpTakeoverDelayMillis\" : 30000, \"getLastErrorModes\" : { }, \"getLastErrorDefaults\" : { \"w\" : 1, \"wtimeout\" : 0 }, \"replicaSetId\" : { \"$oid\" : \"64df1261d7bb6ea00e9001c6\" } } }, \"ok\" : 1.0, \"$clusterTime\" : { \"clusterTime\" : { \"$timestamp\" : { \"t\" : 1692791202, \"i\" : 1 } }, \"signature\" : { \"hash\" : { \"$binary\" : { \"base64\": \"AAAAAAAAAAAAAAAAAAAAAAAAAAA=\", \"subType\" : \"00\" } }, \"keyId\" : 0 } }, \"operationTime\" : { \"$timestamp\" : { \"t\" : 1692791202, \"i\" : 1 } } }",
"mdbVersion": "7.0.0",
"portNumber": 27777,
"dataPath": "/mongo5/data",
"binPath": "",
"configFilePath": "/mongo5/mongod.conf",
"useAsDataAccessNode": false,
"repsetName": "mongo5",
"subType": 2,
"engineName": "wiredTiger",
"memberId": 0,
"client": {
"clientId": 712,
"clientName": "xxx"
}
}
]
}
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "string",
"errorCode": 0
}
Loading...