Skip to main content

Update the MongoDB instance with Discovery of nodes response​

Select

SaaS
Customer Managed

This operation is used to update the MongoDB Instance properties with the discovery of nodes response

Path Parameters
  • instanceId integer required

    Id of the Oracle instance to be browsed

Request Body required

Request Body

  • instanceProperties object
  • description string
  • isDeleted boolean

    Default value: false

  • applicationSize integer
  • excludeFromSLA boolean

    Default value: false

  • scIdxEnabled integer
  • instance object
  • clientName string required

    MongoDB instance client name

  • instanceName string required

    MongoDB instance name

  • displayName string required

    MongoDB instance display name

  • appName string

    Default value: Big Data Apps

  • securityAssociations object
  • ownerAssociations object
  • tagWithCompany object
  • providerDomainName string
  • distributedClusterInstance object
  • clusterType integer

    Default value: 8

  • opType integer

    Default value: 2

  • instance object
  • instanceName string required

    MongoDB instance name

  • instanceId integer required

    MongoDB instance id

  • clusterConfig object
  • mdbConfig object
  • mdbServerType integer

    Default value: 4

  • adminUser object
  • userName string required

    MongoDB user if authentication is enabled on the MongoDB instance

  • masterNode object
  • hostName string required

    Master node hostname

  • osUser string required

    OS user used for impersonation

  • portNumber integer required

    Port number of the MongoDB process or Mongos process running on the master node

  • binPath string required

    Path where MongoDb binaries are present in the master node

  • client object
  • hostName string required

    Master node hostname

  • clientName string required

    Master node client name

  • sslCMCredInfo object
  • credentialName string
  • mdbServerList object[] required

    MongoDB discovery of nodes response

  • hostName string
  • role integer
  • health integer
  • mdbVersion string
  • portNumber integer
  • dataPath string
  • configFilePath string
  • bindIp string
  • logPath string
  • repsetName string
  • configFileContents string
  • subType integer
  • engineName string
  • isLoggingEnabled boolean
  • memberId integer
  • client object
  • clientId integer
  • clientName string
  • _type_ integer
  • instanceActivityControl object
  • activityControlOptions object[]
  • activityType integer
  • enableAfterADelay boolean
  • enableActivityType boolean
  • security object
  • associatedUserGroups object[]
  • userGroupName string
  • advancedPrivacySettings object
  • isPasskeyFeatureEnabled boolean
  • authType integer
  • isPrivacyFeatureEnabled boolean
  • passkeySettings object
  • enableAuthorizeForRestore boolean
  • expirationTime object
  • ownerCapabilities object
  • cloudDBInstance object
  • overRideAccessNode boolean
  • accessNodes object
  • association object
  • entity object[]
  • instanceName string required

    MongoDB instance name

  • appName string

    Default value: Big Data Apps

  • clientName string required

    MongoDB instance client name

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • clientId integer
  • instanceName string
  • instanceId integer
  • _type_ integer
POST /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
instanceId — path required
Body required
{

  "instanceProperties": {

    "description": "string",

    "isDeleted": false,

    "applicationSize": 0,

    "excludeFromSLA": false,

    "scIdxEnabled": 0,

    "instance": {

      "clientName": "string",

      "instanceName": "string",

      "displayName": "string",

      "appName": "Big Data Apps"

    },

    "securityAssociations": {

      "ownerAssociations": {},

      "tagWithCompany": {

        "providerDomainName": "string"

      }

    },

    "distributedClusterInstance": {

      "clusterType": 8,

      "opType": 2,

      "instance": {

        "instanceName": "string",

        "instanceId": 0

      },

      "clusterConfig": {

        "mdbConfig": {

          "mdbServerType": 4,

          "adminUser": {

            "userName": "string"

          },

          "masterNode": {

            "hostName": "string",

            "osUser": "string",

            "portNumber": 0,

            "binPath": "string",

            "client": {

              "hostName": "string",

              "clientName": "string"

            }

          },

          "sslCMCredInfo": {

            "credentialName": "string"

          },

          "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

              }

            }

          ]

        }

      }

    },

    "instanceActivityControl": {

      "activityControlOptions": [

        {

          "activityType": 0,

          "enableAfterADelay": true,

          "enableActivityType": true

        }

      ]

    },

    "security": {

      "associatedUserGroups": [

        {

          "userGroupName": "string"

        }

      ],

      "advancedPrivacySettings": {

        "isPasskeyFeatureEnabled": true,

        "authType": 0,

        "isPrivacyFeatureEnabled": true,

        "passkeySettings": {

          "enableAuthorizeForRestore": true,

          "expirationTime": {}

        }

      },

      "ownerCapabilities": {}

    },

    "cloudDBInstance": {

      "overRideAccessNode": true,

      "accessNodes": {}

    }

  },

  "association": {

    "entity": [

      {

        "instanceName": "string",

        "appName": "Big Data Apps",

        "clientName": "string"

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "description": "string",
    "isDeleted": false,
    "applicationSize": 0,
    "excludeFromSLA": false,
    "scIdxEnabled": 0,
    "instance": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "appName": "Big Data Apps"
    },
    "securityAssociations": {
      "ownerAssociations": {},
      "tagWithCompany": {
        "providerDomainName": "string"
      }
    },
    "distributedClusterInstance": {
      "clusterType": 8,
      "opType": 2,
      "instance": {
        "instanceName": "string",
        "instanceId": 0
      },
      "clusterConfig": {
        "mdbConfig": {
          "mdbServerType": 4,
          "adminUser": {
            "userName": "string"
          },
          "masterNode": {
            "hostName": "string",
            "osUser": "string",
            "portNumber": 0,
            "binPath": "string",
            "client": {
              "hostName": "string",
              "clientName": "string"
            }
          },
          "sslCMCredInfo": {
            "credentialName": "string"
          },
          "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
              }
            }
          ]
        }
      }
    },
    "instanceActivityControl": {
      "activityControlOptions": [
        {
          "activityType": 0,
          "enableAfterADelay": true,
          "enableActivityType": true
        }
      ]
    },
    "security": {
      "associatedUserGroups": [
        {
          "userGroupName": "string"
        }
      ],
      "advancedPrivacySettings": {
        "isPasskeyFeatureEnabled": true,
        "authType": 0,
        "isPrivacyFeatureEnabled": true,
        "passkeySettings": {
          "enableAuthorizeForRestore": true,
          "expirationTime": {}
        }
      },
      "ownerCapabilities": {}
    },
    "cloudDBInstance": {
      "overRideAccessNode": true,
      "accessNodes": {}
    }
  },
  "association": {
    "entity": [
      {
        "instanceName": "string",
        "appName": "Big Data Apps",
        "clientName": "string"
      }
    ]
  }
}'