Managed Service for MongoDB API, gRPC: ClusterService
- Calls ClusterService
- Get
- GetClusterRequest
- Cluster
- Monitoring
- ClusterConfig
- Mongodb3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Resources
- Mongodb4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- PerformanceDiagnosticsConfig
- Access
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- List
- ListClustersRequest
- ListClustersResponse
- Cluster
- Monitoring
- ClusterConfig
- Mongodb3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Resources
- Mongodb4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- PerformanceDiagnosticsConfig
- Access
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- Create
- CreateClusterRequest
- ConfigSpec
- MongodbSpec3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Resources
- MongodbSpec4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- PerformanceDiagnosticsConfig
- Access
- DatabaseSpec
- UserSpec
- Permission
- HostSpec
- Operation
- CreateClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- Mongodb3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- Update
- UpdateClusterRequest
- ConfigSpec
- MongodbSpec3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Resources
- MongodbSpec4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- PerformanceDiagnosticsConfig
- Access
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- Operation
- UpdateClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- Mongodb3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MaintenanceOperation
- Delete
- Start
- StartClusterRequest
- Operation
- StartClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- Mongodb3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Resources
- Mongodb4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- PerformanceDiagnosticsConfig
- Access
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- Stop
- StopClusterRequest
- Operation
- StopClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- Mongodb3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Resources
- Mongodb4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- PerformanceDiagnosticsConfig
- Access
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- Move
- MoveClusterRequest
- Operation
- MoveClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- Mongodb3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Resources
- Mongodb4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- PerformanceDiagnosticsConfig
- Access
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- Backup
- BackupClusterRequest
- Operation
- BackupClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- Mongodb3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Resources
- Mongodb4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- PerformanceDiagnosticsConfig
- Access
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- Restore
- RestoreClusterRequest
- RecoveryTargetSpec
- ConfigSpec
- MongodbSpec3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Resources
- MongodbSpec4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MongodbSpec6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- PerformanceDiagnosticsConfig
- Access
- HostSpec
- Operation
- RestoreClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- Mongodb3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- RescheduleMaintenance
- RescheduleMaintenanceRequest
- Operation
- RescheduleMaintenanceMetadata
- Cluster
- Monitoring
- ClusterConfig
- Mongodb3_6
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Resources
- Mongodb4_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_2
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb4_4_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb5_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- Mongodb6_0_enterprise
- Mongod
- MongoCfg
- Mongos
- MongoInfra
- PerformanceDiagnosticsConfig
- Access
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- ListLogs
- StreamLogs
- ListOperations
- ListBackups
- ListHosts
- AddHosts
- DeleteHosts
- EnableSharding
- GetShard
- ListShards
- AddShard
- DeleteShard
- ResetupHosts
- RestartHosts
- StepdownHosts
A set of methods for managing MongoDB Cluster resources.
Call | Description |
---|---|
Get | Returns the specified MongoDB Cluster resource. |
List | Retrieves the list of MongoDB Cluster resources that belong to the specified folder. |
Create | Creates a MongoDB cluster in the specified folder. |
Update | Updates the specified MongoDB cluster. |
Delete | Deletes the specified MongoDB cluster. |
Start | Start the specified MongoDB cluster. |
Stop | Stop the specified MongoDB cluster. |
Move | Moves the specified MongoDB cluster to the specified folder. |
Backup | Creates a backup for the specified MongoDB cluster. |
Restore | Creates a new MongoDB cluster using the specified backup. |
RescheduleMaintenance | Reschedules planned maintenance operation. |
ListLogs | Retrieves logs for the specified MongoDB cluster. |
StreamLogs | Same as ListLogs but using server-side streaming. |
ListOperations | Retrieves the list of Operation resources for the specified cluster. |
ListBackups | Retrieves the list of available backups for the specified MongoDB cluster. |
ListHosts | Retrieves a list of hosts for the specified cluster. |
AddHosts | Creates new hosts for a cluster. |
DeleteHosts | Deletes the specified hosts for a cluster. |
EnableSharding | Enables sharding for the cluster: creates 3 mongoinfra (or 3 mongocfg and 2 mongos) hosts that would support adding and using shards in the cluster. |
GetShard | Returns the specified shard. |
ListShards | Retrieves a list of shards. |
AddShard | Creates a new shard. |
DeleteShard | Deletes the specified shard. |
ResetupHosts | Resetups hosts. |
RestartHosts | Restarts hosts. |
StepdownHosts | Stepdown hosts. |
Calls ClusterService
Get
Returns the specified MongoDB Cluster resource.
To get the list of available MongoDB Cluster resources, make a List request.
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB Cluster resource to return. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
Cluster
Field | Description |
---|---|
id | string ID of the MongoDB cluster. This ID is assigned by MDB at creation time. |
folder_id | string ID of the folder that the MongoDB cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
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 | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. |
environment | enum 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. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
sharded | bool Indicates current sharding status of the cluster. |
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the MongoDB cluster. |
ClusterConfig
Field | Description |
---|---|
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 . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb | oneof: mongodb_3_6 , mongodb_4_0 , mongodb_4_2 , mongodb_4_4 , mongodb_5_0 , mongodb_6_0 , mongodb_4_4_enterprise , mongodb_5_0_enterprise or mongodb_6_0_enterprise 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_4_enterprise | Mongodb4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_5_0_enterprise | Mongodb5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_6_0_enterprise | Mongodb6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnostic |
access | Access Access policy to DB |
Mongodb3_6
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet3_6 Configuration for a mongod 3.6 hosts. |
resources | Resources Resources allocated to MongoDB hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet3_6 |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet3_6 |
config_mongocfg | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
Mongodb4_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_0 |
config_mongocfg | config.MongoCfgConfigSet4_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_2
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_2 |
config_mongocfg | config.MongoCfgConfigSet4_2 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4 |
config_mongocfg | config.MongoCfgConfigSet4_4 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0 |
config_mongocfg | config.MongoCfgConfigSet5_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0 |
config_mongocfg | config.MongoCfgConfigSet6_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4_enterprise |
config_mongocfg | config.MongoCfgConfigSet4_4_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet5_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet6_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
PerformanceDiagnosticsConfig
Field | Description |
---|---|
profiling_enabled | bool |
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens. |
data_transfer | bool Allow access for DataTransfer. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
List
Retrieves the list of MongoDB Cluster resources that belong to the specified folder.
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list MongoDB clusters in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClustersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
|
ListClustersResponse
Field | Description |
---|---|
clusters[] | Cluster List of MongoDB Cluster resources. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Cluster
Field | Description |
---|---|
id | string ID of the MongoDB cluster. This ID is assigned by MDB at creation time. |
folder_id | string ID of the folder that the MongoDB cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
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 | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. |
environment | enum 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. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
sharded | bool Indicates current sharding status of the cluster. |
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the MongoDB cluster. |
ClusterConfig
Field | Description |
---|---|
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 . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb | oneof: mongodb_3_6 , mongodb_4_0 , mongodb_4_2 , mongodb_4_4 , mongodb_5_0 , mongodb_6_0 , mongodb_4_4_enterprise , mongodb_5_0_enterprise or mongodb_6_0_enterprise 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_4_enterprise | Mongodb4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_5_0_enterprise | Mongodb5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_6_0_enterprise | Mongodb6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnostic |
access | Access Access policy to DB |
Mongodb3_6
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet3_6 Configuration for a mongod 3.6 hosts. |
resources | Resources Resources allocated to MongoDB hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet3_6 |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet3_6 |
config_mongocfg | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
Mongodb4_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_0 |
config_mongocfg | config.MongoCfgConfigSet4_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_2
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_2 |
config_mongocfg | config.MongoCfgConfigSet4_2 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4 |
config_mongocfg | config.MongoCfgConfigSet4_4 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0 |
config_mongocfg | config.MongoCfgConfigSet5_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0 |
config_mongocfg | config.MongoCfgConfigSet6_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4_enterprise |
config_mongocfg | config.MongoCfgConfigSet4_4_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet5_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet6_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
PerformanceDiagnosticsConfig
Field | Description |
---|---|
profiling_enabled | bool |
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens. |
data_transfer | bool Allow access for DataTransfer. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Create
Creates a MongoDB cluster in the specified folder.
rpc Create (CreateClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateClusterMetadata
Operation.response:Cluster
CreateClusterRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create MongoDB cluster in. The maximum string length in characters is 50. |
name | string Required. Name of the MongoDB cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
description | string Description of the MongoDB cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Required. Deployment environment of the MongoDB cluster. |
config_spec | ConfigSpec Required. Configuration and resources for hosts that should be created for the MongoDB cluster. |
database_specs[] | DatabaseSpec Descriptions of databases to be created in the MongoDB cluster. The number of elements must be greater than 0. |
user_specs[] | UserSpec Descriptions of database users to be created in the MongoDB cluster. The number of elements must be greater than 0. |
host_specs[] | HostSpec Individual configurations for hosts that should be created for the MongoDB cluster. The number of elements must be greater than 0. |
network_id | string Required. ID of the network to create the cluster in. The maximum string length in characters is 50. |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
ConfigSpec
Field | Description |
---|---|
version | string Version of MongoDB used in the cluster. Possible values: 3.6 , 4.0 , 4.2 , 4.4 , 4.4-enterprise , 5.0 , 5.0-enterprise , 6.0 , 6.0-enterprise . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb_spec | oneof: mongodb_spec_3_6 , mongodb_spec_4_0 , mongodb_spec_4_2 , mongodb_spec_4_4 , mongodb_spec_5_0 , mongodb_spec_6_0 , mongodb_spec_4_4_enterprise , mongodb_spec_5_0_enterprise or mongodb_spec_6_0_enterprise |
mongodb_spec_3_6 | MongodbSpec3_6 Configuration and resource allocation for a MongoDB 3.6 cluster. |
mongodb_spec_4_0 | MongodbSpec4_0 Configuration and resource allocation for a MongoDB 4.0 cluster. |
mongodb_spec_4_2 | MongodbSpec4_2 Configuration and resource allocation for a MongoDB 4.2 cluster. |
mongodb_spec_4_4 | MongodbSpec4_4 Configuration and resource allocation for a MongoDB 4.4 cluster. |
mongodb_spec_5_0 | MongodbSpec5_0 Configuration and resource allocation for a MongoDB 5.0 cluster. |
mongodb_spec_6_0 | MongodbSpec6_0 Configuration and resource allocation for a MongoDB 6.0 cluster. |
mongodb_spec_4_4_enterprise | MongodbSpec4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_spec_5_0_enterprise | MongodbSpec5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_spec_6_0_enterprise | MongodbSpec6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days Acceptable values are 7 to 35, inclusive. |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnosics configuration |
access | Access Access policy to DB |
MongodbSpec3_6
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 3.6 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 3.6 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 3.6 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 3.6 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig3_6 Configuration for mongod 3.6 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig3_6 Configuration for mongocfg 3.6 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig3_6 Configuration for mongos 3.6 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig3_6 Configuration for mongoinfra 3.6 hosts. |
config_mongocfg | config.MongoCfgConfig3_6 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
MongodbSpec4_0
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_0 Configuration for mongoinfra 4.0 hosts. |
config_mongocfg | config.MongoCfgConfig4_0 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec4_2
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.2 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.2 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.2 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.2 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_2 Configuration for mongoinfra 4.2 hosts. |
config_mongocfg | config.MongoCfgConfig4_2 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec4_4
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.4 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.4 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.4 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.4 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_4 Configuration for mongoinfra 4.4 hosts. |
config_mongocfg | config.MongoCfgConfig4_4 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec5_0
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 5.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 5.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 5.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 5.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig5_0 Configuration for mongoinfra 5.0 hosts. |
config_mongocfg | config.MongoCfgConfig5_0 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec6_0
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 6.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 6.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 6.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 6.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig6_0 Configuration for mongoinfra 6.0 hosts. |
config_mongocfg | config.MongoCfgConfig6_0 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec4_4_enterprise
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.4 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.4 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.4 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.4 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_4_enterprise Configuration for mongoinfra 4.4 hosts. |
config_mongocfg | config.MongoCfgConfig4_4_enterprise |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec5_0_enterprise
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 5.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 5.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 5.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 5.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig5_0_enterprise Configuration for mongoinfra 5.0 hosts. |
config_mongocfg | config.MongoCfgConfig5_0_enterprise |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec6_0_enterprise
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 6.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 6.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 6.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 6.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig6_0_enterprise Configuration for mongoinfra 6.0 hosts. |
config_mongocfg | config.MongoCfgConfig6_0_enterprise |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
PerformanceDiagnosticsConfig
Field | Description |
---|---|
profiling_enabled | bool |
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens. |
data_transfer | bool Allow access for DataTransfer. |
DatabaseSpec
Field | Description |
---|---|
name | string Required. Name of the MongoDB database. 1-63 characters long. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]{1,63} . |
UserSpec
Field | Description |
---|---|
name | string Required. Name of the MongoDB user. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]* . |
password | string Required. Password of the MongoDB user. The string length in characters must be 8-128. |
permissions[] | Permission Set of permissions to grant to the user. |
Permission
Field | Description |
---|---|
database_name | string Name of the database that the permission grants access to. |
roles[] | string MongoDB roles for the database_name database that the permission grants. |
HostSpec
Field | Description |
---|---|
zone_id | string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The network ID is set in the Cluster.network_id field. The maximum string length in characters is 50. |
assign_public_ip | bool Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed. Possible values:
|
type | Host.Type Type of the host to be deployed. |
shard_name | string Name of the shard that the host belongs to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster that is being created. |
Cluster
Field | Description |
---|---|
id | string ID of the MongoDB cluster. This ID is assigned by MDB at creation time. |
folder_id | string ID of the folder that the MongoDB cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
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 | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. |
environment | enum 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. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
sharded | bool Indicates current sharding status of the cluster. |
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the MongoDB cluster. |
ClusterConfig
Field | Description |
---|---|
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 . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb | oneof: mongodb_3_6 , mongodb_4_0 , mongodb_4_2 , mongodb_4_4 , mongodb_5_0 , mongodb_6_0 , mongodb_4_4_enterprise , mongodb_5_0_enterprise or mongodb_6_0_enterprise 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_4_enterprise | Mongodb4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_5_0_enterprise | Mongodb5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_6_0_enterprise | Mongodb6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnostic |
access | Access Access policy to DB |
Mongodb3_6
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet3_6 Configuration for a mongod 3.6 hosts. |
resources | Resources Resources allocated to MongoDB hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet3_6 |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet3_6 |
config_mongocfg | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_0 |
config_mongocfg | config.MongoCfgConfigSet4_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_2
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_2 |
config_mongocfg | config.MongoCfgConfigSet4_2 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4 |
config_mongocfg | config.MongoCfgConfigSet4_4 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0 |
config_mongocfg | config.MongoCfgConfigSet5_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0 |
config_mongocfg | config.MongoCfgConfigSet6_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4_enterprise |
config_mongocfg | config.MongoCfgConfigSet4_4_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet5_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet6_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Update
Updates the specified MongoDB cluster.
rpc Update (UpdateClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateClusterMetadata
Operation.response:Cluster
UpdateClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB Cluster resource to update. To get the MongoDB cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
update_mask | google.protobuf.FieldMask Field mask that specifies which fields of the MongoDB Cluster resource should be updated. |
description | string New description of the MongoDB cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". The new set of labels will completely replace the old ones. To add a label, request the current set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
config_spec | ConfigSpec New configuration and resources for hosts in the cluster. |
name | string New name for the cluster. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
maintenance_window | MaintenanceWindow New maintenance window settings for the cluster. |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
ConfigSpec
Field | Description |
---|---|
version | string Version of MongoDB used in the cluster. Possible values: 3.6 , 4.0 , 4.2 , 4.4 , 4.4-enterprise , 5.0 , 5.0-enterprise , 6.0 , 6.0-enterprise . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb_spec | oneof: mongodb_spec_3_6 , mongodb_spec_4_0 , mongodb_spec_4_2 , mongodb_spec_4_4 , mongodb_spec_5_0 , mongodb_spec_6_0 , mongodb_spec_4_4_enterprise , mongodb_spec_5_0_enterprise or mongodb_spec_6_0_enterprise |
mongodb_spec_3_6 | MongodbSpec3_6 Configuration and resource allocation for a MongoDB 3.6 cluster. |
mongodb_spec_4_0 | MongodbSpec4_0 Configuration and resource allocation for a MongoDB 4.0 cluster. |
mongodb_spec_4_2 | MongodbSpec4_2 Configuration and resource allocation for a MongoDB 4.2 cluster. |
mongodb_spec_4_4 | MongodbSpec4_4 Configuration and resource allocation for a MongoDB 4.4 cluster. |
mongodb_spec_5_0 | MongodbSpec5_0 Configuration and resource allocation for a MongoDB 5.0 cluster. |
mongodb_spec_6_0 | MongodbSpec6_0 Configuration and resource allocation for a MongoDB 6.0 cluster. |
mongodb_spec_4_4_enterprise | MongodbSpec4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_spec_5_0_enterprise | MongodbSpec5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_spec_6_0_enterprise | MongodbSpec6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days Acceptable values are 7 to 35, inclusive. |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnosics configuration |
access | Access Access policy to DB |
MongodbSpec3_6
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 3.6 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 3.6 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 3.6 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 3.6 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig3_6 Configuration for mongod 3.6 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig3_6 Configuration for mongocfg 3.6 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig3_6 Configuration for mongos 3.6 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig3_6 Configuration for mongoinfra 3.6 hosts. |
config_mongocfg | config.MongoCfgConfig3_6 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
MongodbSpec4_0
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_0 Configuration for mongoinfra 4.0 hosts. |
config_mongocfg | config.MongoCfgConfig4_0 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec4_2
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.2 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.2 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.2 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.2 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_2 Configuration for mongoinfra 4.2 hosts. |
config_mongocfg | config.MongoCfgConfig4_2 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec4_4
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.4 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.4 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.4 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.4 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_4 Configuration for mongoinfra 4.4 hosts. |
config_mongocfg | config.MongoCfgConfig4_4 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec5_0
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 5.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 5.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 5.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 5.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig5_0 Configuration for mongoinfra 5.0 hosts. |
config_mongocfg | config.MongoCfgConfig5_0 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec6_0
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 6.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 6.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 6.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 6.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig6_0 Configuration for mongoinfra 6.0 hosts. |
config_mongocfg | config.MongoCfgConfig6_0 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec4_4_enterprise
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.4 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.4 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.4 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.4 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_4_enterprise Configuration for mongoinfra 4.4 hosts. |
config_mongocfg | config.MongoCfgConfig4_4_enterprise |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec5_0_enterprise
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 5.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 5.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 5.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 5.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig5_0_enterprise Configuration for mongoinfra 5.0 hosts. |
config_mongocfg | config.MongoCfgConfig5_0_enterprise |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec6_0_enterprise
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 6.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 6.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 6.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 6.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig6_0_enterprise Configuration for mongoinfra 6.0 hosts. |
config_mongocfg | config.MongoCfgConfig6_0_enterprise |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
PerformanceDiagnosticsConfig
Field | Description |
---|---|
profiling_enabled | bool |
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens. |
data_transfer | bool Allow access for DataTransfer. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB Cluster resource that is being updated. |
Cluster
Field | Description |
---|---|
id | string ID of the MongoDB cluster. This ID is assigned by MDB at creation time. |
folder_id | string ID of the folder that the MongoDB cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
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 | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. |
environment | enum 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. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
sharded | bool Indicates current sharding status of the cluster. |
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the MongoDB cluster. |
ClusterConfig
Field | Description |
---|---|
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 . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb | oneof: mongodb_3_6 , mongodb_4_0 , mongodb_4_2 , mongodb_4_4 , mongodb_5_0 , mongodb_6_0 , mongodb_4_4_enterprise , mongodb_5_0_enterprise or mongodb_6_0_enterprise 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_4_enterprise | Mongodb4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_5_0_enterprise | Mongodb5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_6_0_enterprise | Mongodb6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnostic |
access | Access Access policy to DB |
Mongodb3_6
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet3_6 Configuration for a mongod 3.6 hosts. |
resources | Resources Resources allocated to MongoDB hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet3_6 |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet3_6 |
config_mongocfg | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_0 |
config_mongocfg | config.MongoCfgConfigSet4_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_2
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_2 |
config_mongocfg | config.MongoCfgConfigSet4_2 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4 |
config_mongocfg | config.MongoCfgConfigSet4_4 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0 |
config_mongocfg | config.MongoCfgConfigSet5_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0 |
config_mongocfg | config.MongoCfgConfigSet6_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4_enterprise |
config_mongocfg | config.MongoCfgConfigSet4_4_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet5_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet6_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Delete
Deletes the specified MongoDB cluster.
rpc Delete (DeleteClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteClusterMetadata
Operation.response:google.protobuf.Empty
DeleteClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to delete. To get the MongoDB cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster that is being deleted. |
Start
Start the specified MongoDB cluster.
rpc Start (StartClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StartClusterMetadata
Operation.response:Cluster
StartClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to start. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StartClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster. |
Cluster
Field | Description |
---|---|
id | string ID of the MongoDB cluster. This ID is assigned by MDB at creation time. |
folder_id | string ID of the folder that the MongoDB cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
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 | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. |
environment | enum 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. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
sharded | bool Indicates current sharding status of the cluster. |
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the MongoDB cluster. |
ClusterConfig
Field | Description |
---|---|
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 . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb | oneof: mongodb_3_6 , mongodb_4_0 , mongodb_4_2 , mongodb_4_4 , mongodb_5_0 , mongodb_6_0 , mongodb_4_4_enterprise , mongodb_5_0_enterprise or mongodb_6_0_enterprise 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_4_enterprise | Mongodb4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_5_0_enterprise | Mongodb5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_6_0_enterprise | Mongodb6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnostic |
access | Access Access policy to DB |
Mongodb3_6
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet3_6 Configuration for a mongod 3.6 hosts. |
resources | Resources Resources allocated to MongoDB hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet3_6 |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet3_6 |
config_mongocfg | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
Mongodb4_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_0 |
config_mongocfg | config.MongoCfgConfigSet4_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_2
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_2 |
config_mongocfg | config.MongoCfgConfigSet4_2 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4 |
config_mongocfg | config.MongoCfgConfigSet4_4 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0 |
config_mongocfg | config.MongoCfgConfigSet5_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0 |
config_mongocfg | config.MongoCfgConfigSet6_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4_enterprise |
config_mongocfg | config.MongoCfgConfigSet4_4_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet5_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet6_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
PerformanceDiagnosticsConfig
Field | Description |
---|---|
profiling_enabled | bool |
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens. |
data_transfer | bool Allow access for DataTransfer. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Stop
Stop the specified MongoDB cluster.
rpc Stop (StopClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StopClusterMetadata
Operation.response:Cluster
StopClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to stop. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StopClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster. |
Cluster
Field | Description |
---|---|
id | string ID of the MongoDB cluster. This ID is assigned by MDB at creation time. |
folder_id | string ID of the folder that the MongoDB cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
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 | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. |
environment | enum 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. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
sharded | bool Indicates current sharding status of the cluster. |
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the MongoDB cluster. |
ClusterConfig
Field | Description |
---|---|
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 . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb | oneof: mongodb_3_6 , mongodb_4_0 , mongodb_4_2 , mongodb_4_4 , mongodb_5_0 , mongodb_6_0 , mongodb_4_4_enterprise , mongodb_5_0_enterprise or mongodb_6_0_enterprise 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_4_enterprise | Mongodb4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_5_0_enterprise | Mongodb5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_6_0_enterprise | Mongodb6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnostic |
access | Access Access policy to DB |
Mongodb3_6
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet3_6 Configuration for a mongod 3.6 hosts. |
resources | Resources Resources allocated to MongoDB hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet3_6 |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet3_6 |
config_mongocfg | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
Mongodb4_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_0 |
config_mongocfg | config.MongoCfgConfigSet4_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_2
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_2 |
config_mongocfg | config.MongoCfgConfigSet4_2 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4 |
config_mongocfg | config.MongoCfgConfigSet4_4 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0 |
config_mongocfg | config.MongoCfgConfigSet5_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0 |
config_mongocfg | config.MongoCfgConfigSet6_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4_enterprise |
config_mongocfg | config.MongoCfgConfigSet4_4_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet5_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet6_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
PerformanceDiagnosticsConfig
Field | Description |
---|---|
profiling_enabled | bool |
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens. |
data_transfer | bool Allow access for DataTransfer. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Move
Moves the specified MongoDB cluster to the specified folder.
rpc Move (MoveClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:MoveClusterMetadata
Operation.response:Cluster
MoveClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to move. The maximum string length in characters is 50. |
destination_folder_id | string Required. ID of the destination folder. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
MoveClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster being moved. |
source_folder_id | string ID of the source folder. |
destination_folder_id | string ID of the destnation folder. |
Cluster
Field | Description |
---|---|
id | string ID of the MongoDB cluster. This ID is assigned by MDB at creation time. |
folder_id | string ID of the folder that the MongoDB cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
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 | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. |
environment | enum 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. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
sharded | bool Indicates current sharding status of the cluster. |
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the MongoDB cluster. |
ClusterConfig
Field | Description |
---|---|
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 . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb | oneof: mongodb_3_6 , mongodb_4_0 , mongodb_4_2 , mongodb_4_4 , mongodb_5_0 , mongodb_6_0 , mongodb_4_4_enterprise , mongodb_5_0_enterprise or mongodb_6_0_enterprise 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_4_enterprise | Mongodb4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_5_0_enterprise | Mongodb5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_6_0_enterprise | Mongodb6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnostic |
access | Access Access policy to DB |
Mongodb3_6
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet3_6 Configuration for a mongod 3.6 hosts. |
resources | Resources Resources allocated to MongoDB hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet3_6 |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet3_6 |
config_mongocfg | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
Mongodb4_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_0 |
config_mongocfg | config.MongoCfgConfigSet4_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_2
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_2 |
config_mongocfg | config.MongoCfgConfigSet4_2 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4 |
config_mongocfg | config.MongoCfgConfigSet4_4 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0 |
config_mongocfg | config.MongoCfgConfigSet5_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0 |
config_mongocfg | config.MongoCfgConfigSet6_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4_enterprise |
config_mongocfg | config.MongoCfgConfigSet4_4_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet5_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet6_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
PerformanceDiagnosticsConfig
Field | Description |
---|---|
profiling_enabled | bool |
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens. |
data_transfer | bool Allow access for DataTransfer. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Backup
Creates a backup for the specified MongoDB cluster.
rpc Backup (BackupClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:BackupClusterMetadata
Operation.response:Cluster
BackupClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to back up. To get the MongoDB cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
BackupClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster that is being backed up. |
Cluster
Field | Description |
---|---|
id | string ID of the MongoDB cluster. This ID is assigned by MDB at creation time. |
folder_id | string ID of the folder that the MongoDB cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
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 | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. |
environment | enum 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. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
sharded | bool Indicates current sharding status of the cluster. |
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the MongoDB cluster. |
ClusterConfig
Field | Description |
---|---|
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 . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb | oneof: mongodb_3_6 , mongodb_4_0 , mongodb_4_2 , mongodb_4_4 , mongodb_5_0 , mongodb_6_0 , mongodb_4_4_enterprise , mongodb_5_0_enterprise or mongodb_6_0_enterprise 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_4_enterprise | Mongodb4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_5_0_enterprise | Mongodb5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_6_0_enterprise | Mongodb6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnostic |
access | Access Access policy to DB |
Mongodb3_6
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet3_6 Configuration for a mongod 3.6 hosts. |
resources | Resources Resources allocated to MongoDB hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet3_6 |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet3_6 |
config_mongocfg | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
Mongodb4_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_0 |
config_mongocfg | config.MongoCfgConfigSet4_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_2
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_2 |
config_mongocfg | config.MongoCfgConfigSet4_2 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4 |
config_mongocfg | config.MongoCfgConfigSet4_4 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0 |
config_mongocfg | config.MongoCfgConfigSet5_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0 |
config_mongocfg | config.MongoCfgConfigSet6_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4_enterprise |
config_mongocfg | config.MongoCfgConfigSet4_4_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet5_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet6_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
PerformanceDiagnosticsConfig
Field | Description |
---|---|
profiling_enabled | bool |
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens. |
data_transfer | bool Allow access for DataTransfer. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Restore
Creates a new MongoDB cluster using the specified backup.
rpc Restore (RestoreClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RestoreClusterMetadata
Operation.response:Cluster
RestoreClusterRequest
Field | Description |
---|---|
backup_id | string Required. ID of the backup to create a cluster from. To get the backup ID, use a ClusterService.ListBackups request. |
name | string Required. Name of the new MongoDB cluster. The name must be unique within the folder. The name can't be changed after the MongoDB cluster is created. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
description | string Description of the new MongoDB cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Required. Deployment environment of the new MongoDB cluster. |
config_spec | ConfigSpec Required. Configuration for the MongoDB cluster to be created. |
host_specs[] | HostSpec Configurations for MongoDB hosts that should be created for the cluster that is being created from the backup. The number of elements must be greater than 0. |
network_id | string Required. ID of the network to create the MongoDB cluster in. The maximum string length in characters is 50. |
folder_id | string Required. ID of the folder to create the MongoDB cluster in. The maximum string length in characters is 50. |
recovery_target_spec | RecoveryTargetSpec Specification of the moment to which the MongoDB cluster should be restored. |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
RecoveryTargetSpec
Field | Description |
---|---|
timestamp | int64 Timestamp of the recovery target Value must be greater than 0. |
ConfigSpec
Field | Description |
---|---|
version | string Version of MongoDB used in the cluster. Possible values: 3.6 , 4.0 , 4.2 , 4.4 , 4.4-enterprise , 5.0 , 5.0-enterprise , 6.0 , 6.0-enterprise . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb_spec | oneof: mongodb_spec_3_6 , mongodb_spec_4_0 , mongodb_spec_4_2 , mongodb_spec_4_4 , mongodb_spec_5_0 , mongodb_spec_6_0 , mongodb_spec_4_4_enterprise , mongodb_spec_5_0_enterprise or mongodb_spec_6_0_enterprise |
mongodb_spec_3_6 | MongodbSpec3_6 Configuration and resource allocation for a MongoDB 3.6 cluster. |
mongodb_spec_4_0 | MongodbSpec4_0 Configuration and resource allocation for a MongoDB 4.0 cluster. |
mongodb_spec_4_2 | MongodbSpec4_2 Configuration and resource allocation for a MongoDB 4.2 cluster. |
mongodb_spec_4_4 | MongodbSpec4_4 Configuration and resource allocation for a MongoDB 4.4 cluster. |
mongodb_spec_5_0 | MongodbSpec5_0 Configuration and resource allocation for a MongoDB 5.0 cluster. |
mongodb_spec_6_0 | MongodbSpec6_0 Configuration and resource allocation for a MongoDB 6.0 cluster. |
mongodb_spec_4_4_enterprise | MongodbSpec4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_spec_5_0_enterprise | MongodbSpec5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_spec_6_0_enterprise | MongodbSpec6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days Acceptable values are 7 to 35, inclusive. |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnosics configuration |
access | Access Access policy to DB |
MongodbSpec3_6
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 3.6 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 3.6 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 3.6 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 3.6 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig3_6 Configuration for mongod 3.6 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig3_6 Configuration for mongocfg 3.6 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig3_6 Configuration for mongos 3.6 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig3_6 Configuration for mongoinfra 3.6 hosts. |
config_mongocfg | config.MongoCfgConfig3_6 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
MongodbSpec4_0
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_0 Configuration for mongoinfra 4.0 hosts. |
config_mongocfg | config.MongoCfgConfig4_0 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec4_2
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.2 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.2 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.2 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.2 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_2 Configuration for mongoinfra 4.2 hosts. |
config_mongocfg | config.MongoCfgConfig4_2 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec4_4
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.4 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.4 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.4 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.4 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_4 Configuration for mongoinfra 4.4 hosts. |
config_mongocfg | config.MongoCfgConfig4_4 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec5_0
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 5.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 5.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 5.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 5.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig5_0 Configuration for mongoinfra 5.0 hosts. |
config_mongocfg | config.MongoCfgConfig5_0 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec6_0
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 6.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 6.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 6.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 6.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig6_0 Configuration for mongoinfra 6.0 hosts. |
config_mongocfg | config.MongoCfgConfig6_0 |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec4_4_enterprise
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 4.4 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 4.4 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 4.4 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.4 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig4_4_enterprise Configuration for mongoinfra 4.4 hosts. |
config_mongocfg | config.MongoCfgConfig4_4_enterprise |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec5_0_enterprise
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 5.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 5.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 5.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 5.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig5_0_enterprise Configuration for mongoinfra 5.0 hosts. |
config_mongocfg | config.MongoCfgConfig5_0_enterprise |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
MongodbSpec6_0_enterprise
Field | Description |
---|---|
mongod | Mongod Configuration and resource allocation for mongod 6.0 hosts. |
mongocfg | MongoCfg Configuration and resource allocation for mongocfg 6.0 hosts. |
mongos | Mongos Configuration and resource allocation for mongos 6.0 hosts. |
mongoinfra | MongoInfra Configuration and resource allocation for mongoinfra (mongos+mongocfg) 6.0 hosts. |
Mongod
Field | Description |
---|---|
config | config.MongodConfig6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to each mongod host. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfig6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to each mongocfg host. |
Mongos
Field | Description |
---|---|
config | config.MongosConfig6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to each mongos host. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfig6_0_enterprise Configuration for mongoinfra 6.0 hosts. |
config_mongocfg | config.MongoCfgConfig6_0_enterprise |
resources | Resources Resources allocated to each mongoinfra (mongos+mongocfg) host. |
PerformanceDiagnosticsConfig
Field | Description |
---|---|
profiling_enabled | bool |
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens. |
data_transfer | bool Allow access for DataTransfer. |
HostSpec
Field | Description |
---|---|
zone_id | string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The network ID is set in the Cluster.network_id field. The maximum string length in characters is 50. |
assign_public_ip | bool Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed. Possible values:
|
type | Host.Type Type of the host to be deployed. |
shard_name | string Name of the shard that the host belongs to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RestoreClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the new MongoDB cluster that is being created from a backup. |
backup_id | string ID of the backup that is being used for creating a cluster. |
Cluster
Field | Description |
---|---|
id | string ID of the MongoDB cluster. This ID is assigned by MDB at creation time. |
folder_id | string ID of the folder that the MongoDB cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
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 | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. |
environment | enum 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. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
sharded | bool Indicates current sharding status of the cluster. |
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the MongoDB cluster. |
ClusterConfig
Field | Description |
---|---|
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 . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb | oneof: mongodb_3_6 , mongodb_4_0 , mongodb_4_2 , mongodb_4_4 , mongodb_5_0 , mongodb_6_0 , mongodb_4_4_enterprise , mongodb_5_0_enterprise or mongodb_6_0_enterprise 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_4_enterprise | Mongodb4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_5_0_enterprise | Mongodb5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_6_0_enterprise | Mongodb6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnostic |
access | Access Access policy to DB |
Mongodb3_6
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet3_6 Configuration for a mongod 3.6 hosts. |
resources | Resources Resources allocated to MongoDB hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet3_6 |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet3_6 |
config_mongocfg | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_0 |
config_mongocfg | config.MongoCfgConfigSet4_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_2
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_2 |
config_mongocfg | config.MongoCfgConfigSet4_2 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4 |
config_mongocfg | config.MongoCfgConfigSet4_4 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0 |
config_mongocfg | config.MongoCfgConfigSet5_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0 |
config_mongocfg | config.MongoCfgConfigSet6_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4_enterprise |
config_mongocfg | config.MongoCfgConfigSet4_4_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet5_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet6_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
RescheduleMaintenance
Reschedules planned maintenance operation.
rpc RescheduleMaintenance (RescheduleMaintenanceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RescheduleMaintenanceMetadata
Operation.response:Cluster
RescheduleMaintenanceRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to reschedule the maintenance operation for. The maximum string length in characters is 50. |
reschedule_type | enum RescheduleType Required. The type of reschedule request.
|
delayed_until | google.protobuf.Timestamp The time until which this maintenance operation should be delayed. The value should be ahead of the first time when the maintenance operation has been scheduled for no more than two weeks. The value can also point to the past moment of time if reschedule_type.IMMEDIATE reschedule type is chosen. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RescheduleMaintenanceMetadata
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster. |
delayed_until | google.protobuf.Timestamp Required. The time until which this maintenance operation is to be delayed. |
Cluster
Field | Description |
---|---|
id | string ID of the MongoDB cluster. This ID is assigned by MDB at creation time. |
folder_id | string ID of the folder that the MongoDB cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
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 | map<string,string> Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. |
environment | enum 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. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
sharded | bool Indicates current sharding status of the cluster. |
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the MongoDB cluster. |
ClusterConfig
Field | Description |
---|---|
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 . |
feature_compatibility_version | string MongoDB feature compatibility version. See usage details in MongoDB documentation Possible values:
|
mongodb | oneof: mongodb_3_6 , mongodb_4_0 , mongodb_4_2 , mongodb_4_4 , mongodb_5_0 , mongodb_6_0 , mongodb_4_4_enterprise , mongodb_5_0_enterprise or mongodb_6_0_enterprise 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_4_enterprise | Mongodb4_4_enterprise Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. |
mongodb_5_0_enterprise | Mongodb5_0_enterprise Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. |
mongodb_6_0_enterprise | Mongodb6_0_enterprise Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
backup_retain_period_days | google.protobuf.Int64Value Retain period of automatically created backup in days |
performance_diagnostics | PerformanceDiagnosticsConfig Performance Diagnostic |
access | Access Access policy to DB |
Mongodb3_6
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet3_6 Configuration for a mongod 3.6 hosts. |
resources | Resources Resources allocated to MongoDB hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet3_6 |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet3_6 |
config_mongocfg | config.MongoCfgConfigSet3_6 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
Mongodb4_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_0 Configuration for mongod 4.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_0 Configuration for mongocfg 4.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_0 Configuration for mongos 4.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_0 |
config_mongocfg | config.MongoCfgConfigSet4_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_2
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_2 Configuration for mongod 4.2 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_2 Configuration for mongocfg 4.2 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_2 Configuration for mongos 4.2 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_2 |
config_mongocfg | config.MongoCfgConfigSet4_2 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4 Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4 Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4 Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4 |
config_mongocfg | config.MongoCfgConfigSet4_4 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0 Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0 Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0 Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0 |
config_mongocfg | config.MongoCfgConfigSet5_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0 Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0 Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0 Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0 |
config_mongocfg | config.MongoCfgConfigSet6_0 |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb4_4_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet4_4_enterprise Configuration for mongod 4.4 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet4_4_enterprise Configuration for mongocfg 4.4 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet4_4_enterprise Configuration for mongos 4.4 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet4_4_enterprise |
config_mongocfg | config.MongoCfgConfigSet4_4_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb5_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet5_0_enterprise Configuration for mongod 5.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet5_0_enterprise Configuration for mongocfg 5.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet5_0_enterprise Configuration for mongos 5.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet5_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet5_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
Mongodb6_0_enterprise
Field | Description |
---|---|
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. |
Mongod
Field | Description |
---|---|
config | config.MongodConfigSet6_0_enterprise Configuration for mongod 6.0 hosts. |
resources | Resources Resources allocated to mongod hosts. |
MongoCfg
Field | Description |
---|---|
config | config.MongoCfgConfigSet6_0_enterprise Configuration for mongocfg 6.0 hosts. |
resources | Resources Resources allocated to mongocfg hosts. |
Mongos
Field | Description |
---|---|
config | config.MongosConfigSet6_0_enterprise Configuration for mongos 6.0 hosts. |
resources | Resources Resources allocated to mongos hosts. |
MongoInfra
Field | Description |
---|---|
config_mongos | config.MongosConfigSet6_0_enterprise |
config_mongocfg | config.MongoCfgConfigSet6_0_enterprise |
resources | Resources Resources allocated to mongoinfra (mongos+mongocfg) hosts. |
PerformanceDiagnosticsConfig
Field | Description |
---|---|
profiling_enabled | bool |
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens. |
data_transfer | bool Allow access for DataTransfer. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
ListLogs
Retrieves logs for the specified MongoDB cluster. See the Logs section in the developers guide for detailed logs description.
rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)
ListClusterLogsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to request logs for. To get the MongoDB cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
column_filter[] | string Columns from the logs table to request. If no columns are specified, entire log records are returned. |
service_type | enum ServiceType Type of the service to request logs about.
|
from_time | google.protobuf.Timestamp Start timestamp for the logs request, in RFC3339 |
to_time | google.protobuf.Timestamp End timestamp for the logs request, in RFC3339 |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterLogsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterLogsResponse
Field | Description |
---|---|
logs[] | LogRecord Requested log records. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterLogsRequest.page_size, use the next_page_token as the value for the ListClusterLogsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. This value is interchangeable with next_record_token from StreamLogs method. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Log record timestamp in RFC3339 |
message | map<string,string> Contents of the log record. |
StreamLogs
Same as ListLogs but using server-side streaming. Also allows for 'tail -f' semantics.
rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)
StreamClusterLogsRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the MongoDB cluster. The maximum string length in characters is 50. |
column_filter[] | string Columns from logs table to get in the response. |
service_type | enum ServiceType
|
from_time | google.protobuf.Timestamp Start timestamp for the logs request. |
to_time | google.protobuf.Timestamp End timestamp for the logs request. If this field is not set, all existing logs will be sent and then the new ones as they appear. In essence it has 'tail -f' semantics. |
record_token | string Record token. Set record_token to the next_record_token returned by a previous StreamLogs request to start streaming from next log record. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
message.hostname='node1.db.cloud.yandex.net' , message.severity IN ('E', 'F') The maximum string length in characters is 1000. |
StreamLogRecord
Field | Description |
---|---|
record | LogRecord One of the requested log records. |
next_record_token | string This token allows you to continue streaming logs starting from the exact same record. To continue streaming, specify value of next_record_token as value for record_token parameter in the next StreamLogs request. This value is interchangeable with next_page_token from ListLogs method. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Log record timestamp in RFC3339 |
message | map<string,string> Contents of the log record. |
ListOperations
Retrieves the list of Operation resources for the specified cluster.
rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)
ListClusterOperationsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB Cluster resource to list operations for. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of Operation resources for the specified MongoDB cluster. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty |
ListBackups
Retrieves the list of available backups for the specified MongoDB cluster.
rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)
ListClusterBackupsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster. To get the MongoDB cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterBackupsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterBackupsResponse
Field | Description |
---|---|
backups[] | Backup List of MongoDB Backup resources. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterBackupsRequest.page_size, use the next_page_token as the value for the ListClusterBackupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Backup
Field | Description |
---|---|
id | string ID of the backup. Required. |
folder_id | string ID of the folder that the backup belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 |
source_cluster_id | string ID of the MongoDB cluster that the backup was created for. |
started_at | google.protobuf.Timestamp Time when the backup operation was started. |
source_shard_names[] | string Shard names used as a source for backup. |
size | int64 Size of backup in bytes |
type | enum BackupType How this backup was created (manual/automatic/etc...)
|
ListHosts
Retrieves a list of hosts for the specified cluster.
rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster. To get the MongoDB cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterHostsResponse
Field | Description |
---|---|
hosts[] | Host List of Host resources. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Host
Field | Description |
---|---|
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. |
cluster_id | string ID of the MongoDB host. The ID is assigned by MDB at creation time. |
zone_id | string ID of the availability zone where the MongoDB host resides. |
resources | Resources Resources allocated to the MongoDB host. |
role | enum Role Role of the host in the cluster.
|
health | enum Health Status code of the aggregated health of the host.
|
services[] | Service Services provided by the host. |
subnet_id | string ID of the subnet that the host belongs to. |
assign_public_ip | bool Flag showing public IP assignment status to this host. |
shard_name | string Shard which this host belongs to. |
type | enum Type Host type
|
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
Service
Field | Description |
---|---|
type | enum Type Type of the service provided by the host.
|
health | enum Health Status code of server availability.
|
AddHosts
Creates new hosts for a cluster.
rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddClusterHostsMetadata
Operation.response:google.protobuf.Empty
AddClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to add hosts to. To get the MongoDB cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
host_specs[] | HostSpec Configurations for MongoDB hosts that should be added to the cluster. The number of elements must be greater than 0. |
HostSpec
Field | Description |
---|---|
zone_id | string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The network ID is set in the Cluster.network_id field. The maximum string length in characters is 50. |
assign_public_ip | bool Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed. Possible values:
|
type | Host.Type Type of the host to be deployed. |
shard_name | string Name of the shard that the host belongs to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
AddClusterHostsMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster to which the hosts are being added. |
host_names[] | string Names of hosts that are being added to the cluster. |
DeleteHosts
Deletes the specified hosts for a cluster.
rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteClusterHostsMetadata
Operation.response:google.protobuf.Empty
DeleteClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to remove hosts from. To get the MongoDB cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
host_names[] | string Names of hosts to delete. The number of elements must be greater than 0. The maximum string length in characters for each value is 253. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteClusterHostsMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster to remove hosts from. |
host_names[] | string Names of hosts that are being deleted. |
EnableSharding
Enables sharding for the cluster: creates 3 mongoinfra (or 3 mongocfg and 2 mongos) hosts that would support adding and using shards in the cluster.
rpc EnableSharding (EnableClusterShardingRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:EnableClusterShardingMetadata
Operation.response:google.protobuf.Empty
EnableClusterShardingRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to enable sharding for. The maximum string length in characters is 50. |
mongocfg | MongoCfg mongocfg specification for sharding. |
mongos | Mongos mongos specification for sharding. |
host_specs[] | HostSpec Configurations for mongos and mongocfg hosts. The number of elements must be greater than 0. |
mongoinfra | MongoInfra mongos specification for sharding. |
MongoCfg
Field | Description |
---|---|
resources | Resources Required. Resources for mongocfg hosts. |
Mongos
Field | Description |
---|---|
resources | Resources Required. Resources for mongos hosts. |
MongoInfra
Field | Description |
---|---|
resources | Resources Required. Resources for mongoinfra (mongos+mongocfg) hosts. |
HostSpec
Field | Description |
---|---|
zone_id | string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The network ID is set in the Cluster.network_id field. The maximum string length in characters is 50. |
assign_public_ip | bool Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed. Possible values:
|
type | Host.Type Type of the host to be deployed. |
shard_name | string Name of the shard that the host belongs to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. Possible values:
|
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
EnableClusterShardingMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster that sharding is being enabled for. |
GetShard
Returns the specified shard.
rpc GetShard (GetClusterShardRequest) returns (Shard)
GetClusterShardRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster that the shard belongs to. To get the cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
shard_name | string Required. Name of the MongoDB shard to return. To get the name of the shard use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
Shard
Field | Description |
---|---|
name | string Name of the shard. |
cluster_id | string ID of the cluster that the shard belongs to. |
ListShards
Retrieves a list of shards.
rpc ListShards (ListClusterShardsRequest) returns (ListClusterShardsResponse)
ListClusterShardsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to list databases in. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterShardsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterShardsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterShardsResponse
Field | Description |
---|---|
shards[] | Shard List of MongoDB shards. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterShardsRequest.page_size, use the next_page_token as the value for the ListClusterShardsRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Shard
Field | Description |
---|---|
name | string Name of the shard. |
cluster_id | string ID of the cluster that the shard belongs to. |
AddShard
Creates a new shard.
rpc AddShard (AddClusterShardRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddClusterShardMetadata
Operation.response:Shard
AddClusterShardRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to add a shard to. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
shard_name | string Required. Name of the MongoDB shard to create. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
host_specs[] | HostSpec Configurations for mongod hosts to be created with the shard. The number of elements must be greater than 0. |
HostSpec
Field | Description |
---|---|
zone_id | string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The network ID is set in the Cluster.network_id field. The maximum string length in characters is 50. |
assign_public_ip | bool Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed. Possible values:
|
type | Host.Type Type of the host to be deployed. |
shard_name | string Name of the shard that the host belongs to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
AddClusterShardMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster that a shard is being added to. |
shard_name | string Name of the shard being added. |
Shard
Field | Description |
---|---|
name | string Name of the shard. |
cluster_id | string ID of the cluster that the shard belongs to. |
DeleteShard
Deletes the specified shard.
rpc DeleteShard (DeleteClusterShardRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteClusterShardMetadata
Operation.response:google.protobuf.Empty
DeleteClusterShardRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster to delete a shard in. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
shard_name | string Required. Name of the MongoDB shard to delete. To get the name of the shard use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteClusterShardMetadata
Field | Description |
---|---|
cluster_id | string ID of the MongoDB cluster that a shard is being deleted in. |
shard_name | string Name of the shard being deleted. |
ResetupHosts
Resetups hosts.
rpc ResetupHosts (ResetupHostsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:ResetupHostsMetadata
Operation.response:google.protobuf.Empty
ResetupHostsRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the MongoDB cluster. The maximum string length in characters is 50. |
host_names[] | string Required. Name of the hosts to resetup. The number of elements must be greater than 0. The maximum string length in characters for each value is 253. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
ResetupHostsMetadata
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster. |
host_names[] | string Required. The name of hosts to resetup. |
RestartHosts
Restarts hosts.
rpc RestartHosts (RestartHostsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RestartHostsMetadata
Operation.response:google.protobuf.Empty
RestartHostsRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the MongoDB cluster. The maximum string length in characters is 50. |
host_names[] | string Required. Name of the hosts to restart. The number of elements must be greater than 0. The maximum string length in characters for each value is 253. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RestartHostsMetadata
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster. |
host_names[] | string Required. The name of hosts to restart. |
StepdownHosts
Stepdown hosts.
rpc StepdownHosts (StepdownHostsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StepdownHostsMetadata
Operation.response:google.protobuf.Empty
StepdownHostsRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the MongoDB cluster. The maximum string length in characters is 50. |
host_names[] | string Required. Name of the hosts to resetup. The number of elements must be greater than 0. The maximum string length in characters for each value is 253. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StepdownHostsMetadata
Field | Description |
---|---|
cluster_id | string Required. ID of the MongoDB cluster. |
host_names[] | string Required. The name of hosts to resetup. |