Cluster

A set of methods for managing MongoDB Cluster resources.

JSON Representation

 {
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "mongodb_3_6": {
      "mongod": {
        "config": {
          "effectiveConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                },
                "collectionConfig": {
                  "blockCompressor": "string"
                }
              },
              "journal": {
                "enabled": true,
                "commitInterval": "integer"
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "userConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                },
                "collectionConfig": {
                  "blockCompressor": "string"
                }
              },
              "journal": {
                "enabled": true,
                "commitInterval": "integer"
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "defaultConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                },
                "collectionConfig": {
                  "blockCompressor": "string"
                }
              },
              "journal": {
                "enabled": true,
                "commitInterval": "integer"
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      }
    }
  },
  "networkId": "string",
  "health": "string",
  "status": "string"
}

Methods

Method Description
addHosts Creates new hosts for a cluster.
backup Creates a backup for the specified MongoDB cluster.
create Creates a MongoDB cluster in the specified folder.
delete Deletes the specified MongoDB cluster.
deleteHosts Deletes the specified hosts for a cluster.
get Returns the specified MongoDB Cluster resource.
list Retrieves the list of MongoDB Cluster resources that belong to the specified folder.
listBackups Retrieves the list of available backups for the specified MongoDB cluster.
listHosts Retrieves a list of hosts for the specified cluster.
listLogs Retrieves logs for the specified MongoDB cluster. See the Logs section in the developers guide for detailed logs description.
listOperations Retrieves the list of Operation resources for the specified cluster.
restore Creates a new MongoDB cluster using the specified backup.
update Updates the specified MongoDB cluster.