Skip to main content

types

Access​

dataLens : bool​

Allow access for DataLens.

dataTransfer : bool​

Allow access for DataTransfer.

AnytimeMaintenanceWindow​

Backup​

A MongoDB Backup resource. For more information, see the Developer's Guide.

BackupType​

  • BACKUP_TYPE_UNSPECIFIED

  • AUTOMATED

    Backup created by automated daily schedule

  • MANUAL

    Backup created by user request

id : string​

ID of the backup. Required.

folderId : string​

ID of the folder that the backup belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).

sourceClusterId : string​

ID of the MongoDB cluster that the backup was created for.

startedAt : google.protobuf.Timestamp​

Time when the backup operation was started.

sourceShardNames : string​

Shard names used as a source for backup.

size : int64​

Size of backup in bytes

type : BackupType​

How this backup was created (manual/automatic/etc...)

journalSize : int64​

Size of the journal associated with backup, in bytes

Cluster​

A managed MongoDB cluster. For more information, see the documentation.

Environment​

  • ENVIRONMENT_UNSPECIFIED

  • PRODUCTION

    Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.

  • PRESTABLE

    Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.

Health​

  • HEALTH_UNKNOWN

    State of the cluster is unknown ([Host.health][1] for every host in the cluster is UNKNOWN).

  • ALIVE

    Cluster is alive and well ([Host.health][2] for every host in the cluster is ALIVE).

  • DEAD

    Cluster is inoperable ([Host.health][3] for every host in the cluster is DEAD).

  • DEGRADED

    Cluster is working below capacity ([Host.health][4] for at least one host in the cluster is not ALIVE).

Status​

  • STATUS_UNKNOWN

    Cluster state is unknown.

  • CREATING

    Cluster is being created.

  • RUNNING

    Cluster is running normally.

  • ERROR

    Cluster encountered a problem and cannot operate.

  • UPDATING

    Cluster is being updated.

  • STOPPING

    Cluster is stopping.

  • STOPPED

    Cluster stopped.

  • STARTING

    Cluster is starting.

id : string​

ID of the MongoDB cluster. This ID is assigned by MDB at creation time.

folderId : string​

ID of the folder that the MongoDB cluster belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

name : string​

Name of the MongoDB cluster. The name is unique within the folder. 1-63 characters long.

description : string​

Description of the MongoDB cluster. 0-256 characters long.

labels : string​

Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource.

environment : Environment​

Deployment environment of the MongoDB cluster.

monitoring : Monitoring​

Description of monitoring systems relevant to the MongoDB cluster.

config : ClusterConfig​

Configuration of the MongoDB cluster.

networkId : string​

ID of the network that the cluster belongs to.

health : Health​

Aggregated cluster health.

status : Status​

Current state of the cluster.

sharded : bool​

Indicates current sharding status of the cluster.

maintenanceWindow : MaintenanceWindow​

Maintenance window for the cluster.

plannedOperation : MaintenanceOperation​

Planned maintenance operation to be started for the cluster within the nearest maintenance_window.

securityGroupIds : string​

User security groups

deletionProtection : bool​

Deletion Protection inhibits deletion of the cluster

ClusterConfig​

version : string​

Version of MongoDB server software. Possible values: 3.6, 4.0, 4.2, 4.4, 4.4-enterprise, 5.0, 5.0-enterprise, 6.0, 6.0-enterprise, 7.0, 7.0-enterprise.

featureCompatibilityVersion : string​

MongoDB feature compatibility version. See usage details in MongoDB documentation.

Possible values:

  • 3.6 - persist data compatibility for version 3.6. After setting this option the data will not be compatible with 3.4 or lower.
  • 4.0 - persist data compatibility for version 4.0. After setting this option the data will not be compatible with 3.6 or lower.
  • 4.2 - persist data compatibility for version 4.2. After setting this option the data will not be compatible with 4.0 or lower.
  • 4.4 - persist data compatibility for version 4.4. After setting this option the data will not be compatible with 4.2 or lower.
  • 5.0 - persist data compatibility for version 5.0. After setting this option the data will not be compatible with 5.0 or lower.
  • 6.0 - persist data compatibility for version 6.0. After setting this option the data will not be compatible with 6.0 or lower.

One of mongodb​

Configuration for MongoDB servers in the cluster.

  • mongodb_3_6 : Mongodb3_6​

    Configuration and resource allocation for a MongoDB 3.6 cluster.

  • mongodb_4_0 : Mongodb4_0​

    Configuration and resource allocation for a MongoDB 4.0 cluster.

  • mongodb_4_2 : Mongodb4_2​

    Configuration and resource allocation for a MongoDB 4.2 cluster.

  • mongodb_4_4 : Mongodb4_4​

    Configuration and resource allocation for a MongoDB 4.4 cluster.

  • mongodb_5_0 : Mongodb5_0​

    Configuration and resource allocation for a MongoDB 5.0 cluster.

  • mongodb_6_0 : Mongodb6_0​

    Configuration and resource allocation for a MongoDB 6.0 cluster.

  • mongodb_4_4Enterprise : Mongodb4_4_enterprise​

    Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster.

  • mongodb_5_0Enterprise : Mongodb5_0_enterprise​

    Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster.

  • mongodb_6_0Enterprise : Mongodb6_0_enterprise​

    Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster.

backupWindowStart : google.type.TimeOfDay​

Time to start the daily backup, in the UTC timezone.

backupRetainPeriodDays : google.protobuf.Int64Value​

Retain period of automatically created backup in days

performanceDiagnostics : PerformanceDiagnosticsConfig​

Performance Diagnostic

access : Access​

Access policy to DB

mongodbConfig : Mongodb​

Configuration and resource allocation for a MongoDB Enterprise cluster.

Database​

A MongoDB Database resource. For more information, see the Developer's Guide.

name : string​

Name of the database.

clusterId : string​

ID of the MongoDB cluster that the database belongs to.

DatabaseSpec​

name : string​

Name of the MongoDB database. 1-63 characters long.

DiskSizeAutoscaling​

plannedUsageThreshold : google.protobuf.Int64Value​

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergencyUsageThreshold : google.protobuf.Int64Value​

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

diskSizeLimit : google.protobuf.Int64Value​

Limit on how large the storage for database instances can automatically grow, in bytes.

Host​

Type​

  • TYPE_UNSPECIFIED

    Type of the host is unspecified. Default value.

  • MONGOD

    A mongod host.

  • MONGOS

    A mongos host.

  • MONGOCFG

    A mongocfg host.

  • MONGOINFRA

    A mongoinfra (mongos+mongocfg) host.

Role​

  • ROLE_UNKNOWN

    Role of the host in the cluster is unknown. Default value.

  • PRIMARY

    Host is the primary MongoDB server in the cluster.

  • SECONDARY

    Host is a secondary MongoDB server in the cluster.

Health​

  • HEALTH_UNKNOWN

    Health of the host is unknown. Default value.

  • ALIVE

    The host is performing all its functions normally.

  • DEAD

    The host is inoperable, and cannot perform any of its essential functions.

  • DEGRADED

    The host is degraded, and can perform only some of its essential functions.

HostParameters​

hidden : bool​
secondaryDelaySecs : int64​
priority : double​
tags : string​
name : string​

Name of the MongoDB host. The host name is assigned by MDB at creation time, and cannot be changed. 1-63 characters long.

The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host.

clusterId : string​

ID of the MongoDB host. The ID is assigned by MDB at creation time.

zoneId : string​

ID of the availability zone where the MongoDB host resides.

resources : Resources​

Resources allocated to the MongoDB host.

role : Role​

Role of the host in the cluster. If the field has default value, it is not returned in the response.

health : Health​

Aggregated health of the host. If the field has default value, it is not returned in the response.

services : Service​

Services provided by the host.

subnetId : string​

ID of the subnet that the host belongs to.

assignPublicIp : bool​

Flag showing public IP assignment status to this host.

shardName : string​

Shard which this host belongs to.

type : Type​

Host type. If the field has default value, it is not returned in the response.

hostParameters : HostParameters​

Host parameters

MaintenanceOperation​

A planned maintenance operation.

info : string​

Information about this maintenance operation.

delayedUntil : google.protobuf.Timestamp​

Time until which this maintenance operation is delayed.

MaintenanceWindow​

A maintenance window settings.

One of policy​

The maintenance policy in effect.

  • anytime : AnytimeMaintenanceWindow​

    Maintenance operation can be scheduled anytime.

  • weeklyMaintenanceWindow : WeeklyMaintenanceWindow​

    Maintenance operation can be scheduled on a weekly basis.

Mongodb​

Mongod​

config : config.MongodConfigSet​

Configuration for mongod hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet​

Configuration for mongocfg hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet​

Configuration for mongos hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet​
configMongocfg : config.MongoCfgConfigSet​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB cluster.

Mongodb3_6​

Mongod​

config : config.MongodConfigSet3_6​

Configuration for a mongod 3.6 hosts.

resources : Resources​

Resources allocated to MongoDB hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet3_6​
resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet3_6​
resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet3_6​
configMongocfg : config.MongoCfgConfigSet3_6​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 3.6 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 3.6 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 3.6 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 3.6 cluster.

Mongodb4_0​

Mongod​

config : config.MongodConfigSet4_0​

Configuration for mongod 4.0 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet4_0​

Configuration for mongocfg 4.0 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet4_0​

Configuration for mongos 4.0 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet4_0​
configMongocfg : config.MongoCfgConfigSet4_0​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 4.0 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 4.0 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 4.0 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.0 cluster.

Mongodb4_2​

Mongod​

config : config.MongodConfigSet4_2​

Configuration for mongod 4.2 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet4_2​

Configuration for mongocfg 4.2 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet4_2​

Configuration for mongos 4.2 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet4_2​
configMongocfg : config.MongoCfgConfigSet4_2​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 4.2 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 4.2 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 4.2 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.2 cluster.

Mongodb4_4​

Mongod​

config : config.MongodConfigSet4_4​

Configuration for mongod 4.4 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet4_4​

Configuration for mongocfg 4.4 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet4_4​

Configuration for mongos 4.4 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet4_4​
configMongocfg : config.MongoCfgConfigSet4_4​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 4.4 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 4.4 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 4.4 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.4 cluster.

Mongodb4_4_enterprise​

Mongod​

config : config.MongodConfigSet4_4_enterprise​

Configuration for mongod 4.4 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet4_4_enterprise​

Configuration for mongocfg 4.4 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet4_4_enterprise​

Configuration for mongos 4.4 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet4_4_enterprise​
configMongocfg : config.MongoCfgConfigSet4_4_enterprise​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 4.4 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 4.4 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 4.4 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.4 cluster.

Mongodb5_0​

Mongod​

config : config.MongodConfigSet5_0​

Configuration for mongod 5.0 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet5_0​

Configuration for mongocfg 5.0 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet5_0​

Configuration for mongos 5.0 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet5_0​
configMongocfg : config.MongoCfgConfigSet5_0​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 5.0 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 5.0 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 5.0 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 5.0 cluster.

Mongodb5_0_enterprise​

Mongod​

config : config.MongodConfigSet5_0_enterprise​

Configuration for mongod 5.0 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet5_0_enterprise​

Configuration for mongocfg 5.0 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet5_0_enterprise​

Configuration for mongos 5.0 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet5_0_enterprise​
configMongocfg : config.MongoCfgConfigSet5_0_enterprise​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 5.0 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 5.0 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 5.0 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 5.0 cluster.

Mongodb6_0​

Mongod​

config : config.MongodConfigSet6_0​

Configuration for mongod 6.0 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet6_0​

Configuration for mongocfg 6.0 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet6_0​

Configuration for mongos 6.0 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet6_0​
configMongocfg : config.MongoCfgConfigSet6_0​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 6.0 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 6.0 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 6.0 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 6.0 cluster.

Mongodb6_0_enterprise​

Mongod​

config : config.MongodConfigSet6_0_enterprise​

Configuration for mongod 6.0 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet6_0_enterprise​

Configuration for mongocfg 6.0 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet6_0_enterprise​

Configuration for mongos 6.0 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet6_0_enterprise​
configMongocfg : config.MongoCfgConfigSet6_0_enterprise​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 6.0 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 6.0 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 6.0 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 6.0 cluster.

Monitoring​

Monitoring system.

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the MongoDB cluster.

PerformanceDiagnosticsConfig​

profilingEnabled : bool​

Permission​

databaseName : string​

Name of the database that the permission grants access to.

roles : string​

MongoDB roles for the database_name database that the permission grants.

ResourcePreset​

A ResourcePreset resource for describing hardware configuration presets.

id : string​

ID of the ResourcePreset resource.

zoneIds : string​

IDs of availability zones where the resource preset is available.

cores : int64​

Number of CPU cores for a MongoDB host created with the preset.

memory : int64​

RAM volume for a MongoDB host created with the preset, in bytes.

Resources​

resourcePresetId : string​

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.

diskSize : int64​

Volume of the storage available to a host, in bytes.

diskTypeId : string​

Type of the storage environment for the host. Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.

Service​

Type​

  • TYPE_UNSPECIFIED

    Service type of the host is unspecified. Default value.

  • MONGOD

    The host is running a mongod daemon.

  • MONGOS

    The host is running a mongos daemon.

  • MONGOCFG

    The host is running a MongoDB config server.

Health​

  • HEALTH_UNKNOWN

    Health of the server is unknown.

  • ALIVE

    The server is working normally.

  • DEAD

    The server is dead or unresponsive.

type : Type​

Type of the service provided by the host. If the field has default value, it is not returned in the response.

health : Health​

Aggregated health of the service. If the field has default value, it is not returned in the response.

Shard​

name : string​

Name of the shard.

clusterId : string​

ID of the cluster that the shard belongs to.

User​

A MongoDB User resource. For more information, see the Developer's Guide.

name : string​

Name of the MongoDB user.

clusterId : string​

ID of the MongoDB cluster the user belongs to.

permissions : Permission​

Set of permissions granted to the user.

UserSpec​

name : string​

Name of the MongoDB user.

password : string​

Password of the MongoDB user.

permissions : Permission​

Set of permissions to grant to the user.

WeeklyMaintenanceWindow​

Weelky maintenance window settings.

WeekDay​

  • WEEK_DAY_UNSPECIFIED

  • MON

  • TUE

  • WED

  • THU

  • FRI

  • SAT

  • SUN

day : WeekDay​

Day of the week (in DDD format).

hour : int64​

Hour of the day in UTC (in HH format).