mongodb-mcp-server 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.dockerignore +11 -0
- package/.github/CODEOWNERS +0 -2
- package/.github/ISSUE_TEMPLATE/bug_report.yml +8 -0
- package/.github/workflows/check-pr-title.yml +29 -0
- package/.github/workflows/{lint.yml → check.yml} +22 -1
- package/.github/workflows/code_health.yaml +0 -22
- package/.github/workflows/code_health_fork.yaml +7 -63
- package/.github/workflows/docker.yaml +57 -0
- package/.github/workflows/stale.yml +32 -0
- package/.smithery/Dockerfile +30 -0
- package/.smithery/smithery.yaml +63 -0
- package/.vscode/extensions.json +9 -0
- package/.vscode/settings.json +11 -0
- package/CONTRIBUTING.md +1 -1
- package/Dockerfile +10 -0
- package/README.md +173 -35
- package/dist/common/atlas/apiClient.js +151 -35
- package/dist/common/atlas/apiClient.js.map +1 -1
- package/dist/common/atlas/apiClientError.js +38 -5
- package/dist/common/atlas/apiClientError.js.map +1 -1
- package/dist/common/atlas/cluster.js +66 -0
- package/dist/common/atlas/cluster.js.map +1 -0
- package/dist/common/atlas/generatePassword.js +9 -0
- package/dist/common/atlas/generatePassword.js.map +1 -0
- package/dist/helpers/EJsonTransport.js +38 -0
- package/dist/helpers/EJsonTransport.js.map +1 -0
- package/dist/helpers/connectionOptions.js +10 -0
- package/dist/helpers/connectionOptions.js.map +1 -0
- package/dist/{packageInfo.js → helpers/packageInfo.js} +1 -1
- package/dist/helpers/packageInfo.js.map +1 -0
- package/dist/index.js +23 -3
- package/dist/index.js.map +1 -1
- package/dist/logger.js +7 -0
- package/dist/logger.js.map +1 -1
- package/dist/server.js +16 -12
- package/dist/server.js.map +1 -1
- package/dist/session.js +8 -3
- package/dist/session.js.map +1 -1
- package/dist/telemetry/constants.js +1 -3
- package/dist/telemetry/constants.js.map +1 -1
- package/dist/telemetry/eventCache.js.map +1 -1
- package/dist/telemetry/telemetry.js +126 -47
- package/dist/telemetry/telemetry.js.map +1 -1
- package/dist/tools/atlas/atlasTool.js +38 -0
- package/dist/tools/atlas/atlasTool.js.map +1 -1
- package/dist/tools/atlas/create/createDBUser.js +19 -2
- package/dist/tools/atlas/create/createDBUser.js.map +1 -1
- package/dist/tools/atlas/create/createProject.js +5 -1
- package/dist/tools/atlas/create/createProject.js.map +1 -1
- package/dist/tools/atlas/metadata/connectCluster.js +5 -22
- package/dist/tools/atlas/metadata/connectCluster.js.map +1 -1
- package/dist/tools/atlas/read/inspectCluster.js +4 -24
- package/dist/tools/atlas/read/inspectCluster.js.map +1 -1
- package/dist/tools/atlas/read/listAlerts.js +41 -0
- package/dist/tools/atlas/read/listAlerts.js.map +1 -0
- package/dist/tools/atlas/read/listClusters.js +9 -18
- package/dist/tools/atlas/read/listClusters.js.map +1 -1
- package/dist/tools/atlas/read/listProjects.js +3 -1
- package/dist/tools/atlas/read/listProjects.js.map +1 -1
- package/dist/tools/atlas/tools.js +2 -0
- package/dist/tools/atlas/tools.js.map +1 -1
- package/dist/tools/mongodb/metadata/listDatabases.js.map +1 -1
- package/dist/tools/mongodb/read/count.js +2 -2
- package/dist/tools/mongodb/read/count.js.map +1 -1
- package/dist/tools/mongodb/tools.js +2 -4
- package/dist/tools/mongodb/tools.js.map +1 -1
- package/dist/tools/tool.js +38 -6
- package/dist/tools/tool.js.map +1 -1
- package/eslint.config.js +2 -1
- package/{jest.config.ts → jest.config.cjs} +1 -1
- package/package.json +11 -9
- package/scripts/apply.ts +8 -5
- package/scripts/filter.ts +5 -0
- package/src/common/atlas/apiClient.ts +190 -38
- package/src/common/atlas/apiClientError.ts +58 -7
- package/src/common/atlas/cluster.ts +94 -0
- package/src/common/atlas/generatePassword.ts +10 -0
- package/src/common/atlas/openapi.d.ts +1876 -239
- package/src/helpers/EJsonTransport.ts +47 -0
- package/src/helpers/connectionOptions.ts +20 -0
- package/src/{packageInfo.ts → helpers/packageInfo.ts} +1 -1
- package/src/index.ts +27 -3
- package/src/logger.ts +8 -0
- package/src/server.ts +23 -15
- package/src/session.ts +8 -4
- package/src/telemetry/constants.ts +2 -3
- package/src/telemetry/eventCache.ts +1 -1
- package/src/telemetry/telemetry.ts +182 -64
- package/src/telemetry/types.ts +1 -1
- package/src/tools/atlas/atlasTool.ts +47 -1
- package/src/tools/atlas/create/createDBUser.ts +22 -2
- package/src/tools/atlas/create/createProject.ts +7 -1
- package/src/tools/atlas/metadata/connectCluster.ts +5 -27
- package/src/tools/atlas/read/inspectCluster.ts +4 -40
- package/src/tools/atlas/read/listAlerts.ts +45 -0
- package/src/tools/atlas/read/listClusters.ts +19 -36
- package/src/tools/atlas/read/listProjects.ts +4 -2
- package/src/tools/atlas/tools.ts +2 -0
- package/src/tools/mongodb/metadata/listDatabases.ts +0 -1
- package/src/tools/mongodb/read/count.ts +3 -2
- package/src/tools/mongodb/tools.ts +2 -4
- package/src/tools/tool.ts +45 -8
- package/src/types/mongodb-connection-string-url.d.ts +69 -0
- package/tests/integration/helpers.ts +41 -2
- package/tests/integration/tools/atlas/accessLists.test.ts +2 -2
- package/tests/integration/tools/atlas/alerts.test.ts +42 -0
- package/tests/integration/tools/atlas/atlasHelpers.ts +5 -3
- package/tests/integration/tools/atlas/clusters.test.ts +4 -4
- package/tests/integration/tools/atlas/dbUsers.test.ts +58 -33
- package/tests/integration/tools/atlas/orgs.test.ts +2 -2
- package/tests/integration/tools/atlas/projects.test.ts +3 -3
- package/tests/integration/tools/mongodb/create/createCollection.test.ts +2 -2
- package/tests/integration/tools/mongodb/create/createIndex.test.ts +2 -2
- package/tests/integration/tools/mongodb/create/insertMany.test.ts +1 -1
- package/tests/integration/tools/mongodb/delete/dropCollection.test.ts +1 -1
- package/tests/integration/tools/mongodb/metadata/collectionSchema.test.ts +2 -2
- package/tests/integration/tools/mongodb/metadata/connect.test.ts +2 -6
- package/tests/integration/tools/mongodb/metadata/dbStats.test.ts +4 -4
- package/tests/integration/tools/mongodb/metadata/explain.test.ts +10 -10
- package/tests/integration/tools/mongodb/metadata/listCollections.test.ts +1 -1
- package/tests/integration/tools/mongodb/metadata/listDatabases.test.ts +9 -5
- package/tests/integration/tools/mongodb/metadata/logs.test.ts +4 -4
- package/tests/integration/tools/mongodb/mongodbHelpers.ts +15 -24
- package/tests/integration/tools/mongodb/read/aggregate.test.ts +22 -7
- package/tests/integration/tools/mongodb/read/collectionIndexes.test.ts +5 -5
- package/tests/integration/tools/mongodb/read/count.test.ts +15 -10
- package/tests/integration/tools/mongodb/read/find.test.ts +32 -4
- package/tests/integration/tools/mongodb/update/renameCollection.test.ts +4 -4
- package/tests/unit/EJsonTransport.test.ts +71 -0
- package/tests/unit/apiClient.test.ts +193 -0
- package/tests/unit/session.test.ts +65 -0
- package/tests/unit/telemetry.test.ts +222 -80
- package/tsconfig.build.json +2 -1
- package/dist/packageInfo.js.map +0 -1
- package/dist/telemetry/device-id.js +0 -20
- package/dist/telemetry/device-id.js.map +0 -1
- package/src/telemetry/device-id.ts +0 -21
|
@@ -116,6 +116,28 @@ export interface paths {
|
|
|
116
116
|
patch?: never;
|
|
117
117
|
trace?: never;
|
|
118
118
|
};
|
|
119
|
+
"/api/atlas/v2/groups/{groupId}/alerts": {
|
|
120
|
+
parameters: {
|
|
121
|
+
query?: never;
|
|
122
|
+
header?: never;
|
|
123
|
+
path?: never;
|
|
124
|
+
cookie?: never;
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* Return All Alerts from One Project
|
|
128
|
+
* @description Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.
|
|
129
|
+
*
|
|
130
|
+
* This resource remains under revision and may change.
|
|
131
|
+
*/
|
|
132
|
+
get: operations["listAlerts"];
|
|
133
|
+
put?: never;
|
|
134
|
+
post?: never;
|
|
135
|
+
delete?: never;
|
|
136
|
+
options?: never;
|
|
137
|
+
head?: never;
|
|
138
|
+
patch?: never;
|
|
139
|
+
trace?: never;
|
|
140
|
+
};
|
|
119
141
|
"/api/atlas/v2/groups/{groupId}/clusters": {
|
|
120
142
|
parameters: {
|
|
121
143
|
query?: never;
|
|
@@ -216,6 +238,54 @@ export interface paths {
|
|
|
216
238
|
patch?: never;
|
|
217
239
|
trace?: never;
|
|
218
240
|
};
|
|
241
|
+
"/api/atlas/v2/groups/{groupId}/flexClusters": {
|
|
242
|
+
parameters: {
|
|
243
|
+
query?: never;
|
|
244
|
+
header?: never;
|
|
245
|
+
path?: never;
|
|
246
|
+
cookie?: never;
|
|
247
|
+
};
|
|
248
|
+
/**
|
|
249
|
+
* Return All Flex Clusters from One Project
|
|
250
|
+
* @description Returns details for all flex clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.
|
|
251
|
+
*/
|
|
252
|
+
get: operations["listFlexClusters"];
|
|
253
|
+
put?: never;
|
|
254
|
+
/**
|
|
255
|
+
* Create One Flex Cluster in One Project
|
|
256
|
+
* @description Creates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.
|
|
257
|
+
*/
|
|
258
|
+
post: operations["createFlexCluster"];
|
|
259
|
+
delete?: never;
|
|
260
|
+
options?: never;
|
|
261
|
+
head?: never;
|
|
262
|
+
patch?: never;
|
|
263
|
+
trace?: never;
|
|
264
|
+
};
|
|
265
|
+
"/api/atlas/v2/groups/{groupId}/flexClusters/{name}": {
|
|
266
|
+
parameters: {
|
|
267
|
+
query?: never;
|
|
268
|
+
header?: never;
|
|
269
|
+
path?: never;
|
|
270
|
+
cookie?: never;
|
|
271
|
+
};
|
|
272
|
+
/**
|
|
273
|
+
* Return One Flex Cluster from One Project
|
|
274
|
+
* @description Returns details for one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.
|
|
275
|
+
*/
|
|
276
|
+
get: operations["getFlexCluster"];
|
|
277
|
+
put?: never;
|
|
278
|
+
post?: never;
|
|
279
|
+
/**
|
|
280
|
+
* Remove One Flex Cluster from One Project
|
|
281
|
+
* @description Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role.
|
|
282
|
+
*/
|
|
283
|
+
delete: operations["deleteFlexCluster"];
|
|
284
|
+
options?: never;
|
|
285
|
+
head?: never;
|
|
286
|
+
patch?: never;
|
|
287
|
+
trace?: never;
|
|
288
|
+
};
|
|
219
289
|
"/api/atlas/v2/orgs": {
|
|
220
290
|
parameters: {
|
|
221
291
|
query?: never;
|
|
@@ -580,6 +650,7 @@ export interface components {
|
|
|
580
650
|
/** @description Flag that indicates whether the instance size may scale down via reactive auto-scaling. MongoDB Cloud requires this parameter if **replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**. */
|
|
581
651
|
scaleDownEnabled?: boolean;
|
|
582
652
|
};
|
|
653
|
+
AlertViewForNdsGroup: components["schemas"]["AppServiceAlertView"] | components["schemas"]["ClusterAlertView"] | components["schemas"]["HostAlertViewForNdsGroup"] | components["schemas"]["HostMetricAlert"] | components["schemas"]["ReplicaSetAlertViewForNdsGroup"] | components["schemas"]["StreamProcessorAlertViewForNdsGroup"] | components["schemas"]["DefaultAlertViewForNdsGroup"];
|
|
583
654
|
/** @description Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value. */
|
|
584
655
|
ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView: Record<string, never> | null;
|
|
585
656
|
/** @description Group of settings that configures a subset of the advanced configuration details. */
|
|
@@ -649,6 +720,87 @@ export interface components {
|
|
|
649
720
|
/** @description Application error message returned with this error. */
|
|
650
721
|
readonly reason?: string;
|
|
651
722
|
};
|
|
723
|
+
/**
|
|
724
|
+
* App Services Alerts
|
|
725
|
+
* @description App Services alert notifies different activities about a BAAS application.
|
|
726
|
+
*/
|
|
727
|
+
AppServiceAlertView: {
|
|
728
|
+
/**
|
|
729
|
+
* Format: date-time
|
|
730
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
731
|
+
*
|
|
732
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
733
|
+
*
|
|
734
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
735
|
+
*/
|
|
736
|
+
acknowledgedUntil?: string;
|
|
737
|
+
/**
|
|
738
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
739
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
740
|
+
*/
|
|
741
|
+
acknowledgementComment?: string;
|
|
742
|
+
/**
|
|
743
|
+
* Format: email
|
|
744
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
745
|
+
*/
|
|
746
|
+
readonly acknowledgingUsername?: string;
|
|
747
|
+
/**
|
|
748
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
749
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
750
|
+
*/
|
|
751
|
+
readonly alertConfigId: string;
|
|
752
|
+
/**
|
|
753
|
+
* Format: date-time
|
|
754
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
755
|
+
*/
|
|
756
|
+
readonly created: string;
|
|
757
|
+
eventTypeName: components["schemas"]["AppServiceEventTypeViewAlertable"];
|
|
758
|
+
/**
|
|
759
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
760
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
761
|
+
*/
|
|
762
|
+
readonly groupId?: string;
|
|
763
|
+
/**
|
|
764
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
765
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
766
|
+
*/
|
|
767
|
+
readonly id: string;
|
|
768
|
+
/**
|
|
769
|
+
* Format: date-time
|
|
770
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
771
|
+
*/
|
|
772
|
+
readonly lastNotified?: string;
|
|
773
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
774
|
+
readonly links?: components["schemas"]["Link"][];
|
|
775
|
+
/**
|
|
776
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
777
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
778
|
+
*/
|
|
779
|
+
readonly orgId?: string;
|
|
780
|
+
/**
|
|
781
|
+
* Format: date-time
|
|
782
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
783
|
+
*/
|
|
784
|
+
readonly resolved?: string;
|
|
785
|
+
/**
|
|
786
|
+
* @description State of this alert at the time you requested its details.
|
|
787
|
+
* @example OPEN
|
|
788
|
+
* @enum {string}
|
|
789
|
+
*/
|
|
790
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
791
|
+
/**
|
|
792
|
+
* Format: date-time
|
|
793
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
794
|
+
*/
|
|
795
|
+
readonly updated: string;
|
|
796
|
+
};
|
|
797
|
+
/**
|
|
798
|
+
* App Services Event Types
|
|
799
|
+
* @description Incident that triggered this alert.
|
|
800
|
+
* @example DEPLOYMENT_FAILURE
|
|
801
|
+
* @enum {string}
|
|
802
|
+
*/
|
|
803
|
+
AppServiceEventTypeViewAlertable: "URL_CONFIRMATION" | "SUCCESSFUL_DEPLOY" | "DEPLOYMENT_FAILURE" | "DEPLOYMENT_MODEL_CHANGE_SUCCESS" | "DEPLOYMENT_MODEL_CHANGE_FAILURE" | "REQUEST_RATE_LIMIT" | "LOG_FORWARDER_FAILURE" | "OUTSIDE_REALM_METRIC_THRESHOLD" | "SYNC_FAILURE" | "TRIGGER_FAILURE" | "TRIGGER_AUTO_RESUMED";
|
|
652
804
|
/** @description Details that describe the organization. */
|
|
653
805
|
AtlasOrganization: {
|
|
654
806
|
/**
|
|
@@ -715,7 +867,7 @@ export interface components {
|
|
|
715
867
|
* @description Azure region to which MongoDB Cloud deployed this network peering container.
|
|
716
868
|
* @enum {string}
|
|
717
869
|
*/
|
|
718
|
-
region: "US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_EAST_2_EUAP" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "UAE_NORTH" | "
|
|
870
|
+
region: "US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_EAST_2_EUAP" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "UAE_NORTH" | "GERMANY_WEST_CENTRAL" | "GERMANY_NORTH" | "SWITZERLAND_NORTH" | "SWITZERLAND_WEST" | "SWEDEN_CENTRAL" | "SWEDEN_SOUTH" | "UK_SOUTH" | "UK_WEST" | "INDIA_CENTRAL" | "INDIA_WEST" | "INDIA_SOUTH" | "CHINA_EAST" | "CHINA_NORTH" | "ASIA_EAST" | "JAPAN_EAST" | "JAPAN_WEST" | "ASIA_SOUTH_EAST" | "KOREA_CENTRAL" | "KOREA_SOUTH" | "FRANCE_CENTRAL" | "FRANCE_SOUTH" | "SOUTH_AFRICA_NORTH" | "SOUTH_AFRICA_WEST" | "NORWAY_EAST" | "NORWAY_WEST" | "UAE_CENTRAL" | "QATAR_CENTRAL" | "POLAND_CENTRAL" | "ISRAEL_CENTRAL" | "ITALY_NORTH" | "SPAIN_CENTRAL" | "MEXICO_CENTRAL" | "NEW_ZEALAND_NORTH";
|
|
719
871
|
/** @description Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container. */
|
|
720
872
|
readonly vnetName?: string;
|
|
721
873
|
} & {
|
|
@@ -749,7 +901,7 @@ export interface components {
|
|
|
749
901
|
* @description Microsoft Azure Regions.
|
|
750
902
|
* @enum {string}
|
|
751
903
|
*/
|
|
752
|
-
regionName?: "US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "
|
|
904
|
+
regionName?: "US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "GERMANY_WEST_CENTRAL" | "GERMANY_NORTH" | "SWEDEN_CENTRAL" | "SWEDEN_SOUTH" | "SWITZERLAND_NORTH" | "SWITZERLAND_WEST" | "UK_SOUTH" | "UK_WEST" | "NORWAY_EAST" | "NORWAY_WEST" | "INDIA_CENTRAL" | "INDIA_SOUTH" | "INDIA_WEST" | "CHINA_EAST" | "CHINA_NORTH" | "ASIA_EAST" | "JAPAN_EAST" | "JAPAN_WEST" | "ASIA_SOUTH_EAST" | "KOREA_CENTRAL" | "KOREA_SOUTH" | "FRANCE_CENTRAL" | "FRANCE_SOUTH" | "SOUTH_AFRICA_NORTH" | "SOUTH_AFRICA_WEST" | "UAE_CENTRAL" | "UAE_NORTH" | "QATAR_CENTRAL";
|
|
753
905
|
} & {
|
|
754
906
|
/**
|
|
755
907
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -1666,7 +1818,7 @@ export interface components {
|
|
|
1666
1818
|
*/
|
|
1667
1819
|
providerName?: "AWS" | "AZURE" | "GCP" | "TENANT";
|
|
1668
1820
|
/** @description Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC. */
|
|
1669
|
-
regionName?: ("US_GOV_WEST_1" | "US_GOV_EAST_1" | "US_EAST_1" | "US_EAST_2" | "US_WEST_1" | "US_WEST_2" | "CA_CENTRAL_1" | "EU_NORTH_1" | "EU_WEST_1" | "EU_WEST_2" | "EU_WEST_3" | "EU_CENTRAL_1" | "EU_CENTRAL_2" | "AP_EAST_1" | "AP_NORTHEAST_1" | "AP_NORTHEAST_2" | "AP_NORTHEAST_3" | "AP_SOUTHEAST_1" | "AP_SOUTHEAST_2" | "AP_SOUTHEAST_3" | "AP_SOUTHEAST_4" | "AP_SOUTH_1" | "AP_SOUTH_2" | "SA_EAST_1" | "CN_NORTH_1" | "CN_NORTHWEST_1" | "ME_SOUTH_1" | "ME_CENTRAL_1" | "AF_SOUTH_1" | "EU_SOUTH_1" | "EU_SOUTH_2" | "IL_CENTRAL_1" | "CA_WEST_1" | "AP_SOUTHEAST_5" | "AP_SOUTHEAST_7" | "MX_CENTRAL_1" | "GLOBAL") | ("US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "
|
|
1821
|
+
regionName?: ("US_GOV_WEST_1" | "US_GOV_EAST_1" | "US_EAST_1" | "US_EAST_2" | "US_WEST_1" | "US_WEST_2" | "CA_CENTRAL_1" | "EU_NORTH_1" | "EU_WEST_1" | "EU_WEST_2" | "EU_WEST_3" | "EU_CENTRAL_1" | "EU_CENTRAL_2" | "AP_EAST_1" | "AP_NORTHEAST_1" | "AP_NORTHEAST_2" | "AP_NORTHEAST_3" | "AP_SOUTHEAST_1" | "AP_SOUTHEAST_2" | "AP_SOUTHEAST_3" | "AP_SOUTHEAST_4" | "AP_SOUTH_1" | "AP_SOUTH_2" | "SA_EAST_1" | "CN_NORTH_1" | "CN_NORTHWEST_1" | "ME_SOUTH_1" | "ME_CENTRAL_1" | "AF_SOUTH_1" | "EU_SOUTH_1" | "EU_SOUTH_2" | "IL_CENTRAL_1" | "CA_WEST_1" | "AP_SOUTHEAST_5" | "AP_SOUTHEAST_7" | "MX_CENTRAL_1" | "GLOBAL") | ("US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "GERMANY_WEST_CENTRAL" | "GERMANY_NORTH" | "SWEDEN_CENTRAL" | "SWEDEN_SOUTH" | "SWITZERLAND_NORTH" | "SWITZERLAND_WEST" | "UK_SOUTH" | "UK_WEST" | "NORWAY_EAST" | "NORWAY_WEST" | "INDIA_CENTRAL" | "INDIA_SOUTH" | "INDIA_WEST" | "CHINA_EAST" | "CHINA_NORTH" | "ASIA_EAST" | "JAPAN_EAST" | "JAPAN_WEST" | "ASIA_SOUTH_EAST" | "KOREA_CENTRAL" | "KOREA_SOUTH" | "FRANCE_CENTRAL" | "FRANCE_SOUTH" | "SOUTH_AFRICA_NORTH" | "SOUTH_AFRICA_WEST" | "UAE_CENTRAL" | "UAE_NORTH" | "QATAR_CENTRAL") | ("EASTERN_US" | "EASTERN_US_AW" | "US_EAST_4" | "US_EAST_4_AW" | "US_EAST_5" | "US_EAST_5_AW" | "US_WEST_2" | "US_WEST_2_AW" | "US_WEST_3" | "US_WEST_3_AW" | "US_WEST_4" | "US_WEST_4_AW" | "US_SOUTH_1" | "US_SOUTH_1_AW" | "CENTRAL_US" | "CENTRAL_US_AW" | "WESTERN_US" | "WESTERN_US_AW" | "NORTH_AMERICA_NORTHEAST_1" | "NORTH_AMERICA_NORTHEAST_2" | "NORTH_AMERICA_SOUTH_1" | "SOUTH_AMERICA_EAST_1" | "SOUTH_AMERICA_WEST_1" | "WESTERN_EUROPE" | "EUROPE_NORTH_1" | "EUROPE_WEST_2" | "EUROPE_WEST_3" | "EUROPE_WEST_4" | "EUROPE_WEST_6" | "EUROPE_WEST_8" | "EUROPE_WEST_9" | "EUROPE_WEST_10" | "EUROPE_WEST_12" | "EUROPE_SOUTHWEST_1" | "EUROPE_CENTRAL_2" | "MIDDLE_EAST_CENTRAL_1" | "MIDDLE_EAST_CENTRAL_2" | "MIDDLE_EAST_WEST_1" | "AUSTRALIA_SOUTHEAST_1" | "AUSTRALIA_SOUTHEAST_2" | "AFRICA_SOUTH_1" | "EASTERN_ASIA_PACIFIC" | "NORTHEASTERN_ASIA_PACIFIC" | "SOUTHEASTERN_ASIA_PACIFIC" | "ASIA_EAST_2" | "ASIA_NORTHEAST_2" | "ASIA_NORTHEAST_3" | "ASIA_SOUTH_1" | "ASIA_SOUTH_2" | "ASIA_SOUTHEAST_2");
|
|
1670
1822
|
} & (components["schemas"]["AWSRegionConfig"] | components["schemas"]["AzureRegionConfig"] | components["schemas"]["GCPRegionConfig"] | components["schemas"]["TenantRegionConfig"]);
|
|
1671
1823
|
/**
|
|
1672
1824
|
* Cloud Service Provider Settings
|
|
@@ -1687,8 +1839,87 @@ export interface components {
|
|
|
1687
1839
|
*/
|
|
1688
1840
|
providerName?: "AWS" | "AZURE" | "GCP" | "TENANT";
|
|
1689
1841
|
/** @description Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC. */
|
|
1690
|
-
regionName?: ("US_GOV_WEST_1" | "US_GOV_EAST_1" | "US_EAST_1" | "US_EAST_2" | "US_WEST_1" | "US_WEST_2" | "CA_CENTRAL_1" | "EU_NORTH_1" | "EU_WEST_1" | "EU_WEST_2" | "EU_WEST_3" | "EU_CENTRAL_1" | "EU_CENTRAL_2" | "AP_EAST_1" | "AP_NORTHEAST_1" | "AP_NORTHEAST_2" | "AP_NORTHEAST_3" | "AP_SOUTHEAST_1" | "AP_SOUTHEAST_2" | "AP_SOUTHEAST_3" | "AP_SOUTHEAST_4" | "AP_SOUTH_1" | "AP_SOUTH_2" | "SA_EAST_1" | "CN_NORTH_1" | "CN_NORTHWEST_1" | "ME_SOUTH_1" | "ME_CENTRAL_1" | "AF_SOUTH_1" | "EU_SOUTH_1" | "EU_SOUTH_2" | "IL_CENTRAL_1" | "CA_WEST_1" | "AP_SOUTHEAST_5" | "AP_SOUTHEAST_7" | "MX_CENTRAL_1" | "GLOBAL") | ("US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "
|
|
1842
|
+
regionName?: ("US_GOV_WEST_1" | "US_GOV_EAST_1" | "US_EAST_1" | "US_EAST_2" | "US_WEST_1" | "US_WEST_2" | "CA_CENTRAL_1" | "EU_NORTH_1" | "EU_WEST_1" | "EU_WEST_2" | "EU_WEST_3" | "EU_CENTRAL_1" | "EU_CENTRAL_2" | "AP_EAST_1" | "AP_NORTHEAST_1" | "AP_NORTHEAST_2" | "AP_NORTHEAST_3" | "AP_SOUTHEAST_1" | "AP_SOUTHEAST_2" | "AP_SOUTHEAST_3" | "AP_SOUTHEAST_4" | "AP_SOUTH_1" | "AP_SOUTH_2" | "SA_EAST_1" | "CN_NORTH_1" | "CN_NORTHWEST_1" | "ME_SOUTH_1" | "ME_CENTRAL_1" | "AF_SOUTH_1" | "EU_SOUTH_1" | "EU_SOUTH_2" | "IL_CENTRAL_1" | "CA_WEST_1" | "AP_SOUTHEAST_5" | "AP_SOUTHEAST_7" | "MX_CENTRAL_1" | "GLOBAL") | ("US_CENTRAL" | "US_EAST" | "US_EAST_2" | "US_NORTH_CENTRAL" | "US_WEST" | "US_SOUTH_CENTRAL" | "EUROPE_NORTH" | "EUROPE_WEST" | "US_WEST_CENTRAL" | "US_WEST_2" | "US_WEST_3" | "CANADA_EAST" | "CANADA_CENTRAL" | "BRAZIL_SOUTH" | "BRAZIL_SOUTHEAST" | "AUSTRALIA_CENTRAL" | "AUSTRALIA_CENTRAL_2" | "AUSTRALIA_EAST" | "AUSTRALIA_SOUTH_EAST" | "GERMANY_WEST_CENTRAL" | "GERMANY_NORTH" | "SWEDEN_CENTRAL" | "SWEDEN_SOUTH" | "SWITZERLAND_NORTH" | "SWITZERLAND_WEST" | "UK_SOUTH" | "UK_WEST" | "NORWAY_EAST" | "NORWAY_WEST" | "INDIA_CENTRAL" | "INDIA_SOUTH" | "INDIA_WEST" | "CHINA_EAST" | "CHINA_NORTH" | "ASIA_EAST" | "JAPAN_EAST" | "JAPAN_WEST" | "ASIA_SOUTH_EAST" | "KOREA_CENTRAL" | "KOREA_SOUTH" | "FRANCE_CENTRAL" | "FRANCE_SOUTH" | "SOUTH_AFRICA_NORTH" | "SOUTH_AFRICA_WEST" | "UAE_CENTRAL" | "UAE_NORTH" | "QATAR_CENTRAL") | ("EASTERN_US" | "EASTERN_US_AW" | "US_EAST_4" | "US_EAST_4_AW" | "US_EAST_5" | "US_EAST_5_AW" | "US_WEST_2" | "US_WEST_2_AW" | "US_WEST_3" | "US_WEST_3_AW" | "US_WEST_4" | "US_WEST_4_AW" | "US_SOUTH_1" | "US_SOUTH_1_AW" | "CENTRAL_US" | "CENTRAL_US_AW" | "WESTERN_US" | "WESTERN_US_AW" | "NORTH_AMERICA_NORTHEAST_1" | "NORTH_AMERICA_NORTHEAST_2" | "NORTH_AMERICA_SOUTH_1" | "SOUTH_AMERICA_EAST_1" | "SOUTH_AMERICA_WEST_1" | "WESTERN_EUROPE" | "EUROPE_NORTH_1" | "EUROPE_WEST_2" | "EUROPE_WEST_3" | "EUROPE_WEST_4" | "EUROPE_WEST_6" | "EUROPE_WEST_8" | "EUROPE_WEST_9" | "EUROPE_WEST_10" | "EUROPE_WEST_12" | "EUROPE_SOUTHWEST_1" | "EUROPE_CENTRAL_2" | "MIDDLE_EAST_CENTRAL_1" | "MIDDLE_EAST_CENTRAL_2" | "MIDDLE_EAST_WEST_1" | "AUSTRALIA_SOUTHEAST_1" | "AUSTRALIA_SOUTHEAST_2" | "AFRICA_SOUTH_1" | "EASTERN_ASIA_PACIFIC" | "NORTHEASTERN_ASIA_PACIFIC" | "SOUTHEASTERN_ASIA_PACIFIC" | "ASIA_EAST_2" | "ASIA_NORTHEAST_2" | "ASIA_NORTHEAST_3" | "ASIA_SOUTH_1" | "ASIA_SOUTH_2" | "ASIA_SOUTHEAST_2");
|
|
1691
1843
|
} & (components["schemas"]["AWSRegionConfig20240805"] | components["schemas"]["AzureRegionConfig20240805"] | components["schemas"]["GCPRegionConfig20240805"] | components["schemas"]["TenantRegionConfig20240805"]);
|
|
1844
|
+
/**
|
|
1845
|
+
* Cluster Alerts
|
|
1846
|
+
* @description Cluster alert notifies different activities and conditions about cluster of mongod hosts.
|
|
1847
|
+
*/
|
|
1848
|
+
ClusterAlertView: {
|
|
1849
|
+
/**
|
|
1850
|
+
* Format: date-time
|
|
1851
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
1852
|
+
*
|
|
1853
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
1854
|
+
*
|
|
1855
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
1856
|
+
*/
|
|
1857
|
+
acknowledgedUntil?: string;
|
|
1858
|
+
/**
|
|
1859
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
1860
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
1861
|
+
*/
|
|
1862
|
+
acknowledgementComment?: string;
|
|
1863
|
+
/**
|
|
1864
|
+
* Format: email
|
|
1865
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
1866
|
+
*/
|
|
1867
|
+
readonly acknowledgingUsername?: string;
|
|
1868
|
+
/**
|
|
1869
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
1870
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
1871
|
+
*/
|
|
1872
|
+
readonly alertConfigId: string;
|
|
1873
|
+
/**
|
|
1874
|
+
* @description Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
|
|
1875
|
+
* @example cluster1
|
|
1876
|
+
*/
|
|
1877
|
+
readonly clusterName?: string;
|
|
1878
|
+
/**
|
|
1879
|
+
* Format: date-time
|
|
1880
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
1881
|
+
*/
|
|
1882
|
+
readonly created: string;
|
|
1883
|
+
eventTypeName: components["schemas"]["ClusterEventTypeViewAlertable"];
|
|
1884
|
+
/**
|
|
1885
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
1886
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
1887
|
+
*/
|
|
1888
|
+
readonly groupId?: string;
|
|
1889
|
+
/**
|
|
1890
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
1891
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
1892
|
+
*/
|
|
1893
|
+
readonly id: string;
|
|
1894
|
+
/**
|
|
1895
|
+
* Format: date-time
|
|
1896
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
1897
|
+
*/
|
|
1898
|
+
readonly lastNotified?: string;
|
|
1899
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
1900
|
+
readonly links?: components["schemas"]["Link"][];
|
|
1901
|
+
/**
|
|
1902
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
1903
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
1904
|
+
*/
|
|
1905
|
+
readonly orgId?: string;
|
|
1906
|
+
/**
|
|
1907
|
+
* Format: date-time
|
|
1908
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
1909
|
+
*/
|
|
1910
|
+
readonly resolved?: string;
|
|
1911
|
+
/**
|
|
1912
|
+
* @description State of this alert at the time you requested its details.
|
|
1913
|
+
* @example OPEN
|
|
1914
|
+
* @enum {string}
|
|
1915
|
+
*/
|
|
1916
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
1917
|
+
/**
|
|
1918
|
+
* Format: date-time
|
|
1919
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
1920
|
+
*/
|
|
1921
|
+
readonly updated: string;
|
|
1922
|
+
};
|
|
1692
1923
|
/**
|
|
1693
1924
|
* Cluster Connection Strings
|
|
1694
1925
|
* @description Collection of Uniform Resource Locators that point to the MongoDB database.
|
|
@@ -1716,7 +1947,7 @@ export interface components {
|
|
|
1716
1947
|
ClusterDescription20240805: {
|
|
1717
1948
|
/**
|
|
1718
1949
|
* Format: date-time
|
|
1719
|
-
* @description If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.
|
|
1950
|
+
* @description If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
1720
1951
|
*/
|
|
1721
1952
|
acceptDataRisksAndForceReplicaSetReconfig?: string;
|
|
1722
1953
|
advancedConfiguration?: components["schemas"]["ApiAtlasClusterAdvancedConfigurationView"];
|
|
@@ -1767,7 +1998,7 @@ export interface components {
|
|
|
1767
1998
|
readonly featureCompatibilityVersion?: string;
|
|
1768
1999
|
/**
|
|
1769
2000
|
* Format: date-time
|
|
1770
|
-
* @description Feature compatibility version expiration date. Will only appear if FCV is pinned.
|
|
2001
|
+
* @description Feature compatibility version expiration date. Will only appear if FCV is pinned. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
1771
2002
|
*/
|
|
1772
2003
|
readonly featureCompatibilityVersionExpirationDate?: string;
|
|
1773
2004
|
/** @description Set this field to configure the Sharding Management Mode when creating a new Global Cluster.
|
|
@@ -1893,6 +2124,13 @@ export interface components {
|
|
|
1893
2124
|
/** @description Region where the private endpoint is deployed. */
|
|
1894
2125
|
readonly region?: string;
|
|
1895
2126
|
};
|
|
2127
|
+
/**
|
|
2128
|
+
* Cluster Event Types
|
|
2129
|
+
* @description Event type that triggers an alert.
|
|
2130
|
+
* @example CLUSTER_MONGOS_IS_MISSING
|
|
2131
|
+
* @enum {string}
|
|
2132
|
+
*/
|
|
2133
|
+
ClusterEventTypeViewAlertable: "CLUSTER_MONGOS_IS_MISSING" | "CLUSTER_AGENT_IN_CRASH_LOOP";
|
|
1896
2134
|
ClusterFlexProviderSettings: Omit<components["schemas"]["ClusterProviderSettings"], "providerName"> & {
|
|
1897
2135
|
/**
|
|
1898
2136
|
* @description Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `FLEX` and **providerSetting.instanceSizeName** is `FLEX`.
|
|
@@ -2420,6 +2658,120 @@ export interface components {
|
|
|
2420
2658
|
name?: string;
|
|
2421
2659
|
provider: string;
|
|
2422
2660
|
} & (components["schemas"]["DataLakeS3StoreSettings"] | components["schemas"]["DataLakeDLSAWSStore"] | components["schemas"]["DataLakeDLSAzureStore"] | components["schemas"]["DataLakeDLSGCPStore"] | components["schemas"]["DataLakeAtlasStoreInstance"] | components["schemas"]["DataLakeHTTPStore"] | components["schemas"]["DataLakeAzureBlobStore"] | components["schemas"]["DataLakeGoogleCloudStorageStore"]);
|
|
2661
|
+
DataMetricAlertView: {
|
|
2662
|
+
/**
|
|
2663
|
+
* Format: date-time
|
|
2664
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
2665
|
+
*
|
|
2666
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
2667
|
+
*
|
|
2668
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
2669
|
+
*/
|
|
2670
|
+
acknowledgedUntil?: string;
|
|
2671
|
+
/**
|
|
2672
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
2673
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
2674
|
+
*/
|
|
2675
|
+
acknowledgementComment?: string;
|
|
2676
|
+
/**
|
|
2677
|
+
* Format: email
|
|
2678
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
2679
|
+
*/
|
|
2680
|
+
readonly acknowledgingUsername?: string;
|
|
2681
|
+
/**
|
|
2682
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
2683
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2684
|
+
*/
|
|
2685
|
+
readonly alertConfigId: string;
|
|
2686
|
+
/**
|
|
2687
|
+
* @description Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
|
|
2688
|
+
* @example cluster1
|
|
2689
|
+
*/
|
|
2690
|
+
readonly clusterName?: string;
|
|
2691
|
+
/**
|
|
2692
|
+
* Format: date-time
|
|
2693
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
2694
|
+
*/
|
|
2695
|
+
readonly created: string;
|
|
2696
|
+
currentValue?: components["schemas"]["DataMetricValueView"];
|
|
2697
|
+
eventTypeName: components["schemas"]["HostMetricEventTypeViewAlertable"];
|
|
2698
|
+
/**
|
|
2699
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
2700
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2701
|
+
*/
|
|
2702
|
+
readonly groupId?: string;
|
|
2703
|
+
/**
|
|
2704
|
+
* @description Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
|
|
2705
|
+
* @example cloud-test.mongodb.com:27017
|
|
2706
|
+
*/
|
|
2707
|
+
readonly hostnameAndPort?: string;
|
|
2708
|
+
/**
|
|
2709
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
2710
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2711
|
+
*/
|
|
2712
|
+
readonly id: string;
|
|
2713
|
+
/**
|
|
2714
|
+
* Format: date-time
|
|
2715
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
2716
|
+
*/
|
|
2717
|
+
readonly lastNotified?: string;
|
|
2718
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
2719
|
+
readonly links?: components["schemas"]["Link"][];
|
|
2720
|
+
/**
|
|
2721
|
+
* @description Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.
|
|
2722
|
+
*
|
|
2723
|
+
* To learn more about the available metrics, see <a href="https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types" target="_blank">Host Metrics</a>.
|
|
2724
|
+
*
|
|
2725
|
+
* **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href="https://dochub.mongodb.org/core/alert-config-serverless-measurements" target="_blank">Serverless Measurements</a>.
|
|
2726
|
+
* @example ASSERT_USER
|
|
2727
|
+
*/
|
|
2728
|
+
readonly metricName?: string;
|
|
2729
|
+
/**
|
|
2730
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
2731
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2732
|
+
*/
|
|
2733
|
+
readonly orgId?: string;
|
|
2734
|
+
/**
|
|
2735
|
+
* @description Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
|
|
2736
|
+
* @example event-replica-set
|
|
2737
|
+
*/
|
|
2738
|
+
readonly replicaSetName?: string;
|
|
2739
|
+
/**
|
|
2740
|
+
* Format: date-time
|
|
2741
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
2742
|
+
*/
|
|
2743
|
+
readonly resolved?: string;
|
|
2744
|
+
/**
|
|
2745
|
+
* @description State of this alert at the time you requested its details.
|
|
2746
|
+
* @example OPEN
|
|
2747
|
+
* @enum {string}
|
|
2748
|
+
*/
|
|
2749
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
2750
|
+
/**
|
|
2751
|
+
* Format: date-time
|
|
2752
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
2753
|
+
*/
|
|
2754
|
+
readonly updated: string;
|
|
2755
|
+
};
|
|
2756
|
+
/**
|
|
2757
|
+
* Data Metric Units
|
|
2758
|
+
* @description Element used to express the quantity. This can be an element of time, storage capacity, and the like.
|
|
2759
|
+
* @example BYTES
|
|
2760
|
+
* @enum {string}
|
|
2761
|
+
*/
|
|
2762
|
+
DataMetricUnits: "BITS" | "KILOBITS" | "MEGABITS" | "GIGABITS" | "BYTES" | "KILOBYTES" | "MEGABYTES" | "GIGABYTES" | "TERABYTES" | "PETABYTES";
|
|
2763
|
+
/**
|
|
2764
|
+
* Data Metric Value
|
|
2765
|
+
* @description Measurement of the **metricName** recorded at the time of the event.
|
|
2766
|
+
*/
|
|
2767
|
+
DataMetricValueView: {
|
|
2768
|
+
/**
|
|
2769
|
+
* Format: double
|
|
2770
|
+
* @description Amount of the **metricName** recorded at the time of the event. This value triggered the alert.
|
|
2771
|
+
*/
|
|
2772
|
+
readonly number?: number;
|
|
2773
|
+
units?: components["schemas"]["DataMetricUnits"];
|
|
2774
|
+
};
|
|
2423
2775
|
/** @description Settings to configure the region where you wish to store your archived data. */
|
|
2424
2776
|
DataProcessRegionView: {
|
|
2425
2777
|
/**
|
|
@@ -2502,58 +2854,133 @@ export interface components {
|
|
|
2502
2854
|
*/
|
|
2503
2855
|
nodeCount?: number;
|
|
2504
2856
|
} & (components["schemas"]["AWSHardwareSpec20240805"] | components["schemas"]["AzureHardwareSpec20240805"] | components["schemas"]["GCPHardwareSpec20240805"]);
|
|
2505
|
-
|
|
2857
|
+
/**
|
|
2858
|
+
* Any Other Alerts
|
|
2859
|
+
* @description Other alerts which don't have extra details beside of basic one.
|
|
2860
|
+
*/
|
|
2861
|
+
DefaultAlertViewForNdsGroup: {
|
|
2506
2862
|
/**
|
|
2507
|
-
*
|
|
2508
|
-
* @
|
|
2863
|
+
* Format: date-time
|
|
2864
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
2865
|
+
*
|
|
2866
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
2867
|
+
*
|
|
2868
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
2509
2869
|
*/
|
|
2510
|
-
|
|
2511
|
-
} & {
|
|
2870
|
+
acknowledgedUntil?: string;
|
|
2512
2871
|
/**
|
|
2513
|
-
* @description
|
|
2514
|
-
* @
|
|
2872
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
2873
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
2515
2874
|
*/
|
|
2516
|
-
|
|
2517
|
-
};
|
|
2518
|
-
DiskBackupSnapshotAWSExportBucketRequest: Omit<WithRequired<components["schemas"]["DiskBackupSnapshotExportBucketRequest"], "cloudProvider">, "cloudProvider"> & {
|
|
2875
|
+
acknowledgementComment?: string;
|
|
2519
2876
|
/**
|
|
2520
|
-
*
|
|
2521
|
-
* @
|
|
2877
|
+
* Format: email
|
|
2878
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
2522
2879
|
*/
|
|
2523
|
-
|
|
2880
|
+
readonly acknowledgingUsername?: string;
|
|
2524
2881
|
/**
|
|
2525
|
-
* @description Unique 24-hexadecimal
|
|
2882
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
2526
2883
|
* @example 32b6e34b3d91647abb20e7b8
|
|
2527
2884
|
*/
|
|
2528
|
-
|
|
2529
|
-
} & {
|
|
2885
|
+
readonly alertConfigId: string;
|
|
2530
2886
|
/**
|
|
2531
|
-
*
|
|
2532
|
-
* @
|
|
2887
|
+
* Format: date-time
|
|
2888
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
2533
2889
|
*/
|
|
2534
|
-
|
|
2535
|
-
|
|
2536
|
-
|
|
2890
|
+
readonly created: string;
|
|
2891
|
+
/** @description Incident that triggered this alert. */
|
|
2892
|
+
readonly eventTypeName: ("CREDIT_CARD_ABOUT_TO_EXPIRE" | "PENDING_INVOICE_OVER_THRESHOLD" | "DAILY_BILL_OVER_THRESHOLD") | ("CPS_SNAPSHOT_STARTED" | "CPS_SNAPSHOT_SUCCESSFUL" | "CPS_SNAPSHOT_FAILED" | "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY" | "CPS_SNAPSHOT_BEHIND" | "CPS_COPY_SNAPSHOT_STARTED" | "CPS_COPY_SNAPSHOT_FAILED" | "CPS_COPY_SNAPSHOT_FAILED_WILL_RETRY" | "CPS_COPY_SNAPSHOT_SUCCESSFUL" | "CPS_PREV_SNAPSHOT_OLD" | "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL" | "CPS_SNAPSHOT_FALLBACK_FAILED" | "CPS_RESTORE_SUCCESSFUL" | "CPS_EXPORT_SUCCESSFUL" | "CPS_RESTORE_FAILED" | "CPS_EXPORT_FAILED" | "CPS_AUTO_EXPORT_FAILED" | "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED" | "CPS_OPLOG_BEHIND" | "CPS_OPLOG_CAUGHT_UP") | ("AWS_ENCRYPTION_KEY_NEEDS_ROTATION" | "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION" | "GCP_ENCRYPTION_KEY_NEEDS_ROTATION" | "AWS_ENCRYPTION_KEY_INVALID" | "AZURE_ENCRYPTION_KEY_INVALID" | "GCP_ENCRYPTION_KEY_INVALID") | ("FTS_INDEX_DELETION_FAILED" | "FTS_INDEX_BUILD_COMPLETE" | "FTS_INDEX_BUILD_FAILED" | "FTS_INDEXES_RESTORE_FAILED" | "FTS_INDEXES_SYNONYM_MAPPING_INVALID") | ("USERS_WITHOUT_MULTI_FACTOR_AUTH" | "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" | "ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID") | ("CLUSTER_INSTANCE_STOP_START" | "CLUSTER_INSTANCE_RESYNC_REQUESTED" | "CLUSTER_INSTANCE_UPDATE_REQUESTED" | "SAMPLE_DATASET_LOAD_REQUESTED" | "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL" | "TENANT_UPGRADE_TO_SERVERLESS_FAILED" | "NETWORK_PERMISSION_ENTRY_ADDED" | "NETWORK_PERMISSION_ENTRY_REMOVED" | "NETWORK_PERMISSION_ENTRY_UPDATED") | ("MAINTENANCE_IN_ADVANCED" | "MAINTENANCE_AUTO_DEFERRED" | "MAINTENANCE_STARTED" | "MAINTENANCE_NO_LONGER_NEEDED") | ("NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK" | "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK" | "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK") | ("ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK" | "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK") | "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" | "OUTSIDE_FLEX_METRIC_THRESHOLD" | ("JOINED_GROUP" | "REMOVED_FROM_GROUP" | "USER_ROLES_CHANGED_AUDIT") | ("TAGS_MODIFIED" | "CLUSTER_TAGS_MODIFIED" | "GROUP_TAGS_MODIFIED") | ("STREAM_PROCESSOR_STATE_IS_FAILED" | "OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD") | ("COMPUTE_AUTO_SCALE_INITIATED_BASE" | "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS" | "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE" | "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS" | "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE" | "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS" | "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE" | "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS" | "DISK_AUTO_SCALE_INITIATED" | "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL" | "DISK_AUTO_SCALE_OPLOG_FAIL" | "PREDICTIVE_COMPUTE_AUTO_SCALE_INITIATED_BASE" | "PREDICTIVE_COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE" | "PREDICTIVE_COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE") | ("CPS_DATA_PROTECTION_ENABLE_REQUESTED" | "CPS_DATA_PROTECTION_ENABLED" | "CPS_DATA_PROTECTION_UPDATE_REQUESTED" | "CPS_DATA_PROTECTION_UPDATED" | "CPS_DATA_PROTECTION_DISABLE_REQUESTED" | "CPS_DATA_PROTECTION_DISABLED" | "CPS_DATA_PROTECTION_APPROVED_FOR_DISABLEMENT") | "RESOURCE_POLICY_VIOLATED";
|
|
2537
2893
|
/**
|
|
2538
|
-
* @description Unique 24-hexadecimal
|
|
2894
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
2539
2895
|
* @example 32b6e34b3d91647abb20e7b8
|
|
2540
2896
|
*/
|
|
2541
|
-
|
|
2897
|
+
readonly groupId?: string;
|
|
2542
2898
|
/**
|
|
2543
|
-
* @description
|
|
2544
|
-
* @example
|
|
2899
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
2900
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2545
2901
|
*/
|
|
2546
|
-
|
|
2902
|
+
readonly id: string;
|
|
2547
2903
|
/**
|
|
2548
|
-
*
|
|
2549
|
-
* @
|
|
2904
|
+
* Format: date-time
|
|
2905
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
2550
2906
|
*/
|
|
2551
|
-
|
|
2907
|
+
readonly lastNotified?: string;
|
|
2908
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
2909
|
+
readonly links?: components["schemas"]["Link"][];
|
|
2552
2910
|
/**
|
|
2553
|
-
* @description Unique 24-hexadecimal character string that identifies the
|
|
2911
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
2554
2912
|
* @example 32b6e34b3d91647abb20e7b8
|
|
2555
2913
|
*/
|
|
2556
|
-
|
|
2914
|
+
readonly orgId?: string;
|
|
2915
|
+
/**
|
|
2916
|
+
* Format: date-time
|
|
2917
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
2918
|
+
*/
|
|
2919
|
+
readonly resolved?: string;
|
|
2920
|
+
/**
|
|
2921
|
+
* @description State of this alert at the time you requested its details.
|
|
2922
|
+
* @example OPEN
|
|
2923
|
+
* @enum {string}
|
|
2924
|
+
*/
|
|
2925
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
2926
|
+
/**
|
|
2927
|
+
* Format: date-time
|
|
2928
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
2929
|
+
*/
|
|
2930
|
+
readonly updated: string;
|
|
2931
|
+
};
|
|
2932
|
+
DefaultScheduleView: Omit<WithRequired<components["schemas"]["OnlineArchiveSchedule"], "type">, "type"> & {
|
|
2933
|
+
/**
|
|
2934
|
+
* @description discriminator enum property added by openapi-typescript
|
|
2935
|
+
* @enum {string}
|
|
2936
|
+
*/
|
|
2937
|
+
type: "DEFAULT";
|
|
2938
|
+
} & {
|
|
2939
|
+
/**
|
|
2940
|
+
* @description discriminator enum property added by openapi-typescript
|
|
2941
|
+
* @enum {string}
|
|
2942
|
+
*/
|
|
2943
|
+
type: "DEFAULT";
|
|
2944
|
+
};
|
|
2945
|
+
DiskBackupSnapshotAWSExportBucketRequest: Omit<WithRequired<components["schemas"]["DiskBackupSnapshotExportBucketRequest"], "cloudProvider">, "cloudProvider"> & {
|
|
2946
|
+
/**
|
|
2947
|
+
* @description Human-readable label that identifies the AWS S3 Bucket that the role is authorized to export to.
|
|
2948
|
+
* @example export-bucket
|
|
2949
|
+
*/
|
|
2950
|
+
bucketName: string;
|
|
2951
|
+
/**
|
|
2952
|
+
* @description Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.
|
|
2953
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2954
|
+
*/
|
|
2955
|
+
iamRoleId: string;
|
|
2956
|
+
} & {
|
|
2957
|
+
/**
|
|
2958
|
+
* @description discriminator enum property added by openapi-typescript
|
|
2959
|
+
* @enum {string}
|
|
2960
|
+
*/
|
|
2961
|
+
cloudProvider: "AWS";
|
|
2962
|
+
};
|
|
2963
|
+
DiskBackupSnapshotAWSExportBucketResponse: {
|
|
2964
|
+
/**
|
|
2965
|
+
* @description Unique 24-hexadecimal character string that identifies the Export Bucket.
|
|
2966
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2967
|
+
*/
|
|
2968
|
+
_id: string;
|
|
2969
|
+
/**
|
|
2970
|
+
* @description The name of the AWS S3 Bucket, Azure Storage Container, or Google Cloud Storage Bucket that Snapshots are exported to.
|
|
2971
|
+
* @example export-bucket
|
|
2972
|
+
*/
|
|
2973
|
+
bucketName: string;
|
|
2974
|
+
/**
|
|
2975
|
+
* @description Human-readable label that identifies the cloud provider that Snapshots will be exported to.
|
|
2976
|
+
* @enum {string}
|
|
2977
|
+
*/
|
|
2978
|
+
cloudProvider: "AWS" | "AZURE" | "GCP";
|
|
2979
|
+
/**
|
|
2980
|
+
* @description Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.
|
|
2981
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
2982
|
+
*/
|
|
2983
|
+
iamRoleId: string;
|
|
2557
2984
|
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
2558
2985
|
readonly links?: components["schemas"]["Link"][];
|
|
2559
2986
|
};
|
|
@@ -2615,7 +3042,7 @@ export interface components {
|
|
|
2615
3042
|
* @description Human-readable label that identifies the cloud provider that Snapshots are exported to.
|
|
2616
3043
|
* @enum {string}
|
|
2617
3044
|
*/
|
|
2618
|
-
cloudProvider: "AWS" | "AZURE";
|
|
3045
|
+
cloudProvider: "AWS" | "AZURE" | "GCP";
|
|
2619
3046
|
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
2620
3047
|
readonly links?: components["schemas"]["Link"][];
|
|
2621
3048
|
};
|
|
@@ -2627,7 +3054,7 @@ export interface components {
|
|
|
2627
3054
|
*/
|
|
2628
3055
|
_id: string;
|
|
2629
3056
|
/**
|
|
2630
|
-
* @description The name of the AWS S3 Bucket
|
|
3057
|
+
* @description The name of the AWS S3 Bucket, Azure Storage Container, or Google Cloud Storage Bucket that Snapshots are exported to.
|
|
2631
3058
|
* @example export-bucket
|
|
2632
3059
|
*/
|
|
2633
3060
|
bucketName: string;
|
|
@@ -2635,10 +3062,41 @@ export interface components {
|
|
|
2635
3062
|
* @description Human-readable label that identifies the cloud provider that Snapshots will be exported to.
|
|
2636
3063
|
* @enum {string}
|
|
2637
3064
|
*/
|
|
2638
|
-
cloudProvider: "AWS" | "AZURE";
|
|
3065
|
+
cloudProvider: "AWS" | "AZURE" | "GCP";
|
|
2639
3066
|
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
2640
3067
|
readonly links?: components["schemas"]["Link"][];
|
|
2641
3068
|
};
|
|
3069
|
+
DiskBackupSnapshotGCPExportBucketRequest: Omit<WithRequired<components["schemas"]["DiskBackupSnapshotExportBucketRequest"], "cloudProvider">, "cloudProvider"> & {
|
|
3070
|
+
/**
|
|
3071
|
+
* @description Human-readable label that identifies the Google Cloud Storage Bucket that the role is authorized to export to.
|
|
3072
|
+
* @example export-bucket
|
|
3073
|
+
*/
|
|
3074
|
+
bucketName: string;
|
|
3075
|
+
/**
|
|
3076
|
+
* @description Unique 24-hexadecimal digit string that identifies the GCP Cloud Provider Access Role that MongoDB Cloud uses to access the Google Cloud Storage Bucket.
|
|
3077
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3078
|
+
*/
|
|
3079
|
+
roleId: string;
|
|
3080
|
+
} & {
|
|
3081
|
+
/**
|
|
3082
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3083
|
+
* @enum {string}
|
|
3084
|
+
*/
|
|
3085
|
+
cloudProvider: "GCP";
|
|
3086
|
+
};
|
|
3087
|
+
DiskBackupSnapshotGCPExportBucketResponse: Omit<WithRequired<components["schemas"]["DiskBackupSnapshotExportBucketResponse"], "_id" | "bucketName" | "cloudProvider">, "cloudProvider"> & {
|
|
3088
|
+
/**
|
|
3089
|
+
* @description Unique 24-hexadecimal digit string that identifies the GCP Cloud Provider Access Role that MongoDB Cloud uses to access the Google Cloud Storage Bucket.
|
|
3090
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3091
|
+
*/
|
|
3092
|
+
roleId: string;
|
|
3093
|
+
} & {
|
|
3094
|
+
/**
|
|
3095
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3096
|
+
* @enum {string}
|
|
3097
|
+
*/
|
|
3098
|
+
cloudProvider: "GCP";
|
|
3099
|
+
};
|
|
2642
3100
|
/** @description Setting that enables disk auto-scaling. */
|
|
2643
3101
|
DiskGBAutoScaling: {
|
|
2644
3102
|
/** @description Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling. */
|
|
@@ -2648,7 +3106,7 @@ export interface components {
|
|
|
2648
3106
|
EmployeeAccessGrantView: {
|
|
2649
3107
|
/**
|
|
2650
3108
|
* Format: date-time
|
|
2651
|
-
* @description Expiration date for the employee access grant.
|
|
3109
|
+
* @description Expiration date for the employee access grant. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
2652
3110
|
*/
|
|
2653
3111
|
expirationTime: string;
|
|
2654
3112
|
/**
|
|
@@ -2666,6 +3124,147 @@ export interface components {
|
|
|
2666
3124
|
field: string;
|
|
2667
3125
|
};
|
|
2668
3126
|
Fields: Record<string, never>;
|
|
3127
|
+
/**
|
|
3128
|
+
* Flex Backup Configuration
|
|
3129
|
+
* @description Flex backup configuration.
|
|
3130
|
+
*/
|
|
3131
|
+
FlexBackupSettings20241113: {
|
|
3132
|
+
/**
|
|
3133
|
+
* @description Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups.
|
|
3134
|
+
* @default true
|
|
3135
|
+
*/
|
|
3136
|
+
readonly enabled: boolean;
|
|
3137
|
+
};
|
|
3138
|
+
/**
|
|
3139
|
+
* Flex Cluster Description
|
|
3140
|
+
* @description Group of settings that configure a MongoDB Flex cluster.
|
|
3141
|
+
*/
|
|
3142
|
+
FlexClusterDescription20241113: {
|
|
3143
|
+
backupSettings?: components["schemas"]["FlexBackupSettings20241113"];
|
|
3144
|
+
/**
|
|
3145
|
+
* @description Flex cluster topology.
|
|
3146
|
+
* @default REPLICASET
|
|
3147
|
+
* @enum {string}
|
|
3148
|
+
*/
|
|
3149
|
+
readonly clusterType: "REPLICASET";
|
|
3150
|
+
connectionStrings?: components["schemas"]["FlexConnectionStrings20241113"];
|
|
3151
|
+
/**
|
|
3152
|
+
* Format: date-time
|
|
3153
|
+
* @description Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.
|
|
3154
|
+
*/
|
|
3155
|
+
readonly createDate?: string;
|
|
3156
|
+
/**
|
|
3157
|
+
* @description Unique 24-hexadecimal character string that identifies the project.
|
|
3158
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3159
|
+
*/
|
|
3160
|
+
readonly groupId?: string;
|
|
3161
|
+
/**
|
|
3162
|
+
* @description Unique 24-hexadecimal digit string that identifies the instance.
|
|
3163
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3164
|
+
*/
|
|
3165
|
+
readonly id?: string;
|
|
3166
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3167
|
+
readonly links?: components["schemas"]["Link"][];
|
|
3168
|
+
/** @description Version of MongoDB that the instance runs. */
|
|
3169
|
+
readonly mongoDBVersion?: string;
|
|
3170
|
+
/** @description Human-readable label that identifies the instance. */
|
|
3171
|
+
readonly name?: string;
|
|
3172
|
+
providerSettings: components["schemas"]["FlexProviderSettings20241113"];
|
|
3173
|
+
/**
|
|
3174
|
+
* @description Human-readable label that indicates the current operating condition of this instance.
|
|
3175
|
+
* @enum {string}
|
|
3176
|
+
*/
|
|
3177
|
+
readonly stateName?: "IDLE" | "CREATING" | "UPDATING" | "DELETING" | "REPAIRING";
|
|
3178
|
+
/** @description List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance. */
|
|
3179
|
+
tags?: components["schemas"]["ResourceTag"][];
|
|
3180
|
+
/**
|
|
3181
|
+
* @description Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster.
|
|
3182
|
+
* @default false
|
|
3183
|
+
*/
|
|
3184
|
+
terminationProtectionEnabled: boolean;
|
|
3185
|
+
/**
|
|
3186
|
+
* @description Method by which the cluster maintains the MongoDB versions.
|
|
3187
|
+
* @default LTS
|
|
3188
|
+
* @enum {string}
|
|
3189
|
+
*/
|
|
3190
|
+
readonly versionReleaseSystem: "LTS";
|
|
3191
|
+
};
|
|
3192
|
+
/**
|
|
3193
|
+
* Flex Cluster Description Create
|
|
3194
|
+
* @description Settings that you can specify when you create a flex cluster.
|
|
3195
|
+
*/
|
|
3196
|
+
FlexClusterDescriptionCreate20241113: {
|
|
3197
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3198
|
+
readonly links?: components["schemas"]["Link"][];
|
|
3199
|
+
/** @description Human-readable label that identifies the instance. */
|
|
3200
|
+
name: string;
|
|
3201
|
+
providerSettings: components["schemas"]["FlexProviderSettingsCreate20241113"];
|
|
3202
|
+
/** @description List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance. */
|
|
3203
|
+
tags?: components["schemas"]["ResourceTag"][];
|
|
3204
|
+
/**
|
|
3205
|
+
* @description Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster.
|
|
3206
|
+
* @default false
|
|
3207
|
+
*/
|
|
3208
|
+
terminationProtectionEnabled: boolean;
|
|
3209
|
+
};
|
|
3210
|
+
/**
|
|
3211
|
+
* Flex Cluster Connection Strings
|
|
3212
|
+
* @description Collection of Uniform Resource Locators that point to the MongoDB database.
|
|
3213
|
+
*/
|
|
3214
|
+
FlexConnectionStrings20241113: {
|
|
3215
|
+
/** @description Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol. */
|
|
3216
|
+
readonly standard?: string;
|
|
3217
|
+
/** @description Public connection string that you can use to connect to this flex cluster. This connection string uses the `mongodb+srv://` protocol. */
|
|
3218
|
+
readonly standardSrv?: string;
|
|
3219
|
+
};
|
|
3220
|
+
/**
|
|
3221
|
+
* Cloud Service Provider Settings for a Flex Cluster
|
|
3222
|
+
* @description Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
|
|
3223
|
+
*/
|
|
3224
|
+
FlexProviderSettings20241113: {
|
|
3225
|
+
/**
|
|
3226
|
+
* @description Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
|
|
3227
|
+
* @enum {string}
|
|
3228
|
+
*/
|
|
3229
|
+
readonly backingProviderName?: "AWS" | "AZURE" | "GCP";
|
|
3230
|
+
/**
|
|
3231
|
+
* Format: double
|
|
3232
|
+
* @description Storage capacity available to the flex cluster expressed in gigabytes.
|
|
3233
|
+
*/
|
|
3234
|
+
readonly diskSizeGB?: number;
|
|
3235
|
+
/**
|
|
3236
|
+
* @description Human-readable label that identifies the provider type.
|
|
3237
|
+
* @default FLEX
|
|
3238
|
+
* @enum {string}
|
|
3239
|
+
*/
|
|
3240
|
+
readonly providerName: "FLEX";
|
|
3241
|
+
/** @description Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). */
|
|
3242
|
+
readonly regionName?: string;
|
|
3243
|
+
};
|
|
3244
|
+
/**
|
|
3245
|
+
* Cloud Service Provider Settings for a Flex Cluster
|
|
3246
|
+
* @description Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
|
|
3247
|
+
*/
|
|
3248
|
+
FlexProviderSettingsCreate20241113: {
|
|
3249
|
+
/**
|
|
3250
|
+
* @description Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
|
|
3251
|
+
* @enum {string}
|
|
3252
|
+
*/
|
|
3253
|
+
backingProviderName: "AWS" | "AZURE" | "GCP";
|
|
3254
|
+
/**
|
|
3255
|
+
* Format: double
|
|
3256
|
+
* @description Storage capacity available to the flex cluster expressed in gigabytes.
|
|
3257
|
+
*/
|
|
3258
|
+
readonly diskSizeGB?: number;
|
|
3259
|
+
/**
|
|
3260
|
+
* @description Human-readable label that identifies the provider type.
|
|
3261
|
+
* @default FLEX
|
|
3262
|
+
* @enum {string}
|
|
3263
|
+
*/
|
|
3264
|
+
readonly providerName: "FLEX";
|
|
3265
|
+
/** @description Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). */
|
|
3266
|
+
regionName: string;
|
|
3267
|
+
};
|
|
2669
3268
|
/**
|
|
2670
3269
|
* Tenant
|
|
2671
3270
|
* @description Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.
|
|
@@ -3020,103 +3619,318 @@ export interface components {
|
|
|
3020
3619
|
diskSizeGB?: number;
|
|
3021
3620
|
} & (components["schemas"]["AWSHardwareSpec20240805"] | components["schemas"]["AzureHardwareSpec20240805"] | components["schemas"]["GCPHardwareSpec20240805"] | components["schemas"]["TenantHardwareSpec20240805"]);
|
|
3022
3621
|
/**
|
|
3023
|
-
*
|
|
3024
|
-
* @description
|
|
3622
|
+
* Host Alerts
|
|
3623
|
+
* @description Host alert notifies about activities on mongod host.
|
|
3025
3624
|
*/
|
|
3026
|
-
|
|
3625
|
+
HostAlertViewForNdsGroup: {
|
|
3027
3626
|
/**
|
|
3028
|
-
*
|
|
3029
|
-
* @
|
|
3627
|
+
* Format: date-time
|
|
3628
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
3629
|
+
*
|
|
3630
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
3631
|
+
*
|
|
3632
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
3030
3633
|
*/
|
|
3031
|
-
|
|
3032
|
-
};
|
|
3033
|
-
/**
|
|
3034
|
-
* Ingestion Source
|
|
3035
|
-
* @description Ingestion Source of a Data Lake Pipeline.
|
|
3036
|
-
*/
|
|
3037
|
-
IngestionSource: {
|
|
3634
|
+
acknowledgedUntil?: string;
|
|
3038
3635
|
/**
|
|
3039
|
-
* @description
|
|
3040
|
-
* @
|
|
3636
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
3637
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
3041
3638
|
*/
|
|
3042
|
-
|
|
3043
|
-
};
|
|
3044
|
-
/**
|
|
3045
|
-
* Line Item
|
|
3046
|
-
* @description One service included in this invoice.
|
|
3047
|
-
*/
|
|
3048
|
-
InvoiceLineItem: {
|
|
3049
|
-
/** @description Human-readable label that identifies the cluster that incurred the charge. */
|
|
3050
|
-
readonly clusterName?: string;
|
|
3639
|
+
acknowledgementComment?: string;
|
|
3051
3640
|
/**
|
|
3052
|
-
* Format:
|
|
3053
|
-
* @description
|
|
3641
|
+
* Format: email
|
|
3642
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
3054
3643
|
*/
|
|
3055
|
-
readonly
|
|
3644
|
+
readonly acknowledgingUsername?: string;
|
|
3056
3645
|
/**
|
|
3057
|
-
*
|
|
3058
|
-
* @
|
|
3646
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
3647
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3059
3648
|
*/
|
|
3060
|
-
readonly
|
|
3649
|
+
readonly alertConfigId: string;
|
|
3650
|
+
/**
|
|
3651
|
+
* @description Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
|
|
3652
|
+
* @example cluster1
|
|
3653
|
+
*/
|
|
3654
|
+
readonly clusterName?: string;
|
|
3061
3655
|
/**
|
|
3062
3656
|
* Format: date-time
|
|
3063
|
-
* @description Date and time when
|
|
3657
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
3064
3658
|
*/
|
|
3065
|
-
readonly
|
|
3659
|
+
readonly created: string;
|
|
3660
|
+
eventTypeName: components["schemas"]["HostEventTypeViewForNdsGroupAlertable"];
|
|
3066
3661
|
/**
|
|
3067
|
-
* @description Unique 24-hexadecimal digit string that identifies the project
|
|
3662
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
3068
3663
|
* @example 32b6e34b3d91647abb20e7b8
|
|
3069
3664
|
*/
|
|
3070
3665
|
readonly groupId?: string;
|
|
3071
|
-
/** @description Human-readable label that identifies the project. */
|
|
3072
|
-
groupName?: string;
|
|
3073
|
-
/** @description Comment that applies to this line item. */
|
|
3074
|
-
readonly note?: string;
|
|
3075
3666
|
/**
|
|
3076
|
-
*
|
|
3077
|
-
* @
|
|
3667
|
+
* @description Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
|
|
3668
|
+
* @example cloud-test.mongodb.com:27017
|
|
3078
3669
|
*/
|
|
3079
|
-
readonly
|
|
3670
|
+
readonly hostnameAndPort?: string;
|
|
3080
3671
|
/**
|
|
3081
|
-
*
|
|
3082
|
-
* @
|
|
3672
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
3673
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3083
3674
|
*/
|
|
3084
|
-
readonly
|
|
3675
|
+
readonly id: string;
|
|
3085
3676
|
/**
|
|
3086
|
-
*
|
|
3087
|
-
* @
|
|
3677
|
+
* Format: date-time
|
|
3678
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
3088
3679
|
*/
|
|
3089
|
-
readonly sku?: "CLASSIC_BACKUP_OPLOG" | "CLASSIC_BACKUP_STORAGE" | "CLASSIC_BACKUP_SNAPSHOT_CREATE" | "CLASSIC_BACKUP_DAILY_MINIMUM" | "CLASSIC_BACKUP_FREE_TIER" | "CLASSIC_COUPON" | "BACKUP_STORAGE_FREE_TIER" | "BACKUP_STORAGE" | "FLEX_CONSULTING" | "CLOUD_MANAGER_CLASSIC" | "CLOUD_MANAGER_BASIC_FREE_TIER" | "CLOUD_MANAGER_BASIC" | "CLOUD_MANAGER_PREMIUM" | "CLOUD_MANAGER_FREE_TIER" | "CLOUD_MANAGER_STANDARD_FREE_TIER" | "CLOUD_MANAGER_STANDARD_ANNUAL" | "CLOUD_MANAGER_STANDARD" | "CLOUD_MANAGER_FREE_TRIAL" | "ATLAS_INSTANCE_M0" | "ATLAS_INSTANCE_M2" | "ATLAS_INSTANCE_M5" | "ATLAS_AWS_INSTANCE_M10" | "ATLAS_AWS_INSTANCE_M20" | "ATLAS_AWS_INSTANCE_M30" | "ATLAS_AWS_INSTANCE_M40" | "ATLAS_AWS_INSTANCE_M50" | "ATLAS_AWS_INSTANCE_M60" | "ATLAS_AWS_INSTANCE_M80" | "ATLAS_AWS_INSTANCE_M100" | "ATLAS_AWS_INSTANCE_M140" | "ATLAS_AWS_INSTANCE_M200" | "ATLAS_AWS_INSTANCE_M300" | "ATLAS_AWS_INSTANCE_M40_LOW_CPU" | "ATLAS_AWS_INSTANCE_M50_LOW_CPU" | "ATLAS_AWS_INSTANCE_M60_LOW_CPU" | "ATLAS_AWS_INSTANCE_M80_LOW_CPU" | "ATLAS_AWS_INSTANCE_M200_LOW_CPU" | "ATLAS_AWS_INSTANCE_M300_LOW_CPU" | "ATLAS_AWS_INSTANCE_M400_LOW_CPU" | "ATLAS_AWS_INSTANCE_M700_LOW_CPU" | "ATLAS_AWS_INSTANCE_M40_NVME" | "ATLAS_AWS_INSTANCE_M50_NVME" | "ATLAS_AWS_INSTANCE_M60_NVME" | "ATLAS_AWS_INSTANCE_M80_NVME" | "ATLAS_AWS_INSTANCE_M200_NVME" | "ATLAS_AWS_INSTANCE_M400_NVME" | "ATLAS_AWS_INSTANCE_M10_PAUSED" | "ATLAS_AWS_INSTANCE_M20_PAUSED" | "ATLAS_AWS_INSTANCE_M30_PAUSED" | "ATLAS_AWS_INSTANCE_M40_PAUSED" | "ATLAS_AWS_INSTANCE_M50_PAUSED" | "ATLAS_AWS_INSTANCE_M60_PAUSED" | "ATLAS_AWS_INSTANCE_M80_PAUSED" | "ATLAS_AWS_INSTANCE_M100_PAUSED" | "ATLAS_AWS_INSTANCE_M140_PAUSED" | "ATLAS_AWS_INSTANCE_M200_PAUSED" | "ATLAS_AWS_INSTANCE_M300_PAUSED" | "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED" | "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S40_STORAGE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S50_STORAGE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S60_STORAGE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S80_STORAGE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S90_STORAGE_NVME" | "ATLAS_AWS_STORAGE_PROVISIONED" | "ATLAS_AWS_STORAGE_STANDARD" | "ATLAS_AWS_STORAGE_STANDARD_GP3" | "ATLAS_AWS_STORAGE_IOPS" | "ATLAS_AWS_DATA_TRANSFER_SAME_REGION" | "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION" | "ATLAS_AWS_DATA_TRANSFER_INTERNET" | "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE" | "ATLAS_AWS_BACKUP_DOWNLOAD_VM" | "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE" | "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS" | "ATLAS_AWS_PRIVATE_ENDPOINT" | "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS" | "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD" | "ATLAS_GCP_INSTANCE_M10" | "ATLAS_GCP_INSTANCE_M20" | "ATLAS_GCP_INSTANCE_M30" | "ATLAS_GCP_INSTANCE_M40" | "ATLAS_GCP_INSTANCE_M50" | "ATLAS_GCP_INSTANCE_M60" | "ATLAS_GCP_INSTANCE_M80" | "ATLAS_GCP_INSTANCE_M140" | "ATLAS_GCP_INSTANCE_M200" | "ATLAS_GCP_INSTANCE_M250" | "ATLAS_GCP_INSTANCE_M300" | "ATLAS_GCP_INSTANCE_M400" | "ATLAS_GCP_INSTANCE_M40_LOW_CPU" | "ATLAS_GCP_INSTANCE_M50_LOW_CPU" | "ATLAS_GCP_INSTANCE_M60_LOW_CPU" | "ATLAS_GCP_INSTANCE_M80_LOW_CPU" | "ATLAS_GCP_INSTANCE_M200_LOW_CPU" | "ATLAS_GCP_INSTANCE_M300_LOW_CPU" | "ATLAS_GCP_INSTANCE_M400_LOW_CPU" | "ATLAS_GCP_INSTANCE_M600_LOW_CPU" | "ATLAS_GCP_INSTANCE_M10_PAUSED" | "ATLAS_GCP_INSTANCE_M20_PAUSED" | "ATLAS_GCP_INSTANCE_M30_PAUSED" | "ATLAS_GCP_INSTANCE_M40_PAUSED" | "ATLAS_GCP_INSTANCE_M50_PAUSED" | "ATLAS_GCP_INSTANCE_M60_PAUSED" | "ATLAS_GCP_INSTANCE_M80_PAUSED" | "ATLAS_GCP_INSTANCE_M140_PAUSED" | "ATLAS_GCP_INSTANCE_M200_PAUSED" | "ATLAS_GCP_INSTANCE_M250_PAUSED" | "ATLAS_GCP_INSTANCE_M300_PAUSED" | "ATLAS_GCP_INSTANCE_M400_PAUSED" | "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED" | "ATLAS_GCP_DATA_TRANSFER_INTERNET" | "ATLAS_GCP_STORAGE_SSD" | "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT" | "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE" | "ATLAS_GCP_DATA_TRANSFER_INTER_REGION" | "ATLAS_GCP_DATA_TRANSFER_GOOGLE" | "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE" | "ATLAS_GCP_BACKUP_DOWNLOAD_VM" | "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE" | "ATLAS_GCP_PRIVATE_ENDPOINT" | "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS" | "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER" | "ATLAS_AZURE_INSTANCE_M10" | "ATLAS_AZURE_INSTANCE_M20" | "ATLAS_AZURE_INSTANCE_M30" | "ATLAS_AZURE_INSTANCE_M40" | "ATLAS_AZURE_INSTANCE_M50" | "ATLAS_AZURE_INSTANCE_M60" | "ATLAS_AZURE_INSTANCE_M80" | "ATLAS_AZURE_INSTANCE_M90" | "ATLAS_AZURE_INSTANCE_M200" | "ATLAS_AZURE_INSTANCE_R40" | "ATLAS_AZURE_INSTANCE_R50" | "ATLAS_AZURE_INSTANCE_R60" | "ATLAS_AZURE_INSTANCE_R80" | "ATLAS_AZURE_INSTANCE_R200" | "ATLAS_AZURE_INSTANCE_R300" | "ATLAS_AZURE_INSTANCE_R400" | "ATLAS_AZURE_INSTANCE_M60_NVME" | "ATLAS_AZURE_INSTANCE_M80_NVME" | "ATLAS_AZURE_INSTANCE_M200_NVME" | "ATLAS_AZURE_INSTANCE_M300_NVME" | "ATLAS_AZURE_INSTANCE_M400_NVME" | "ATLAS_AZURE_INSTANCE_M600_NVME" | "ATLAS_AZURE_INSTANCE_M10_PAUSED" | "ATLAS_AZURE_INSTANCE_M20_PAUSED" | "ATLAS_AZURE_INSTANCE_M30_PAUSED" | "ATLAS_AZURE_INSTANCE_M40_PAUSED" | "ATLAS_AZURE_INSTANCE_M50_PAUSED" | "ATLAS_AZURE_INSTANCE_M60_PAUSED" | "ATLAS_AZURE_INSTANCE_M80_PAUSED" | "ATLAS_AZURE_INSTANCE_M90_PAUSED" | "ATLAS_AZURE_INSTANCE_M200_PAUSED" | "ATLAS_AZURE_INSTANCE_R40_PAUSED" | "ATLAS_AZURE_INSTANCE_R50_PAUSED" | "ATLAS_AZURE_INSTANCE_R60_PAUSED" | "ATLAS_AZURE_INSTANCE_R80_PAUSED" | "ATLAS_AZURE_INSTANCE_R200_PAUSED" | "ATLAS_AZURE_INSTANCE_R300_PAUSED" | "ATLAS_AZURE_INSTANCE_R400_PAUSED" | "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD" | "ATLAS_AZURE_STORAGE_P2" | "ATLAS_AZURE_STORAGE_P3" | "ATLAS_AZURE_STORAGE_P4" | "ATLAS_AZURE_STORAGE_P6" | "ATLAS_AZURE_STORAGE_P10" | "ATLAS_AZURE_STORAGE_P15" | "ATLAS_AZURE_STORAGE_P20" | "ATLAS_AZURE_STORAGE_P30" | "ATLAS_AZURE_STORAGE_P40" | "ATLAS_AZURE_STORAGE_P50" | "ATLAS_AZURE_DATA_TRANSFER" | "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN" | "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT" | "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN" | "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT" | "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN" | "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT" | "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT" | "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT" | "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50" | "ATLAS_AZURE_STANDARD_STORAGE" | "ATLAS_AZURE_EXTENDED_STANDARD_IOPS" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS" | "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE" | "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS" | "ATLAS_BI_CONNECTOR" | "ATLAS_ADVANCED_SECURITY" | "ATLAS_ENTERPRISE_AUDITING" | "ATLAS_FREE_SUPPORT" | "ATLAS_SUPPORT" | "ATLAS_NDS_BACKFILL_SUPPORT" | "STITCH_DATA_DOWNLOADED_FREE_TIER" | "STITCH_DATA_DOWNLOADED" | "STITCH_COMPUTE_FREE_TIER" | "STITCH_COMPUTE" | "CREDIT" | "MINIMUM_CHARGE" | "CHARTS_DATA_DOWNLOADED_FREE_TIER" | "CHARTS_DATA_DOWNLOADED" | "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION" | "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION" | "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET" | "ATLAS_DATA_LAKE_AWS_DATA_SCANNED" | "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION" | "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS" | "ATLAS_NDS_AWS_DATA_LAKE_STORAGE" | "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION" | "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT" | "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT" | "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET" | "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION" | "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION" | "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET" | "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED" | "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS" | "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE" | "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED" | "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS" | "ATLAS_NDS_GCP_DATA_LAKE_STORAGE" | "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS" | "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE" | "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS" | "ATLAS_NDS_AZURE_OBJECT_STORAGE" | "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE" | "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS" | "ATLAS_NDS_GCP_OBJECT_STORAGE" | "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE" | "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE" | "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER" | "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE" | "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER" | "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE" | "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER" | "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE" | "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS" | "ATLAS_NDS_AZURE_CMK_PRIVATE_NETWORKING" | "ATLAS_NDS_AWS_CMK_PRIVATE_NETWORKING" | "ATLAS_NDS_AWS_OBJECT_STORAGE" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS" | "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM" | "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40" | "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50" | "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60" | "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE" | "ATLAS_NDS_AWS_SERVERLESS_RPU" | "ATLAS_NDS_AWS_SERVERLESS_WPU" | "ATLAS_NDS_AWS_SERVERLESS_STORAGE" | "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP" | "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM" | "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW" | "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER" | "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL" | "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION" | "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET" | "ATLAS_NDS_GCP_SERVERLESS_RPU" | "ATLAS_NDS_GCP_SERVERLESS_WPU" | "ATLAS_NDS_GCP_SERVERLESS_STORAGE" | "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP" | "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM" | "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW" | "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER" | "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL" | "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION" | "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET" | "ATLAS_NDS_AZURE_SERVERLESS_RPU" | "ATLAS_NDS_AZURE_SERVERLESS_WPU" | "ATLAS_NDS_AZURE_SERVERLESS_STORAGE" | "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP" | "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM" | "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW" | "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER" | "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL" | "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION" | "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET" | "REALM_APP_REQUESTS_FREE_TIER" | "REALM_APP_REQUESTS" | "REALM_APP_COMPUTE_FREE_TIER" | "REALM_APP_COMPUTE" | "REALM_APP_SYNC_FREE_TIER" | "REALM_APP_SYNC" | "REALM_APP_DATA_TRANSFER_FREE_TIER" | "REALM_APP_DATA_TRANSFER" | "GCP_SNAPSHOT_COPY_DISK" | "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10" | "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30" | "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50" | "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10" | "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30" | "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50" | "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER" | "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER" | "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" | "ATLAS_AZURE_STREAM_PROCESSING_PRIVATELINK" | "ATLAS_AWS_STREAM_PROCESSING_PRIVATELINK" | "ATLAS_FLEX_AWS_100_USAGE_HOURS" | "ATLAS_FLEX_AWS_200_USAGE_HOURS" | "ATLAS_FLEX_AWS_300_USAGE_HOURS" | "ATLAS_FLEX_AWS_400_USAGE_HOURS" | "ATLAS_FLEX_AWS_500_USAGE_HOURS" | "ATLAS_FLEX_AZURE_100_USAGE_HOURS" | "ATLAS_FLEX_AZURE_200_USAGE_HOURS" | "ATLAS_FLEX_AZURE_300_USAGE_HOURS" | "ATLAS_FLEX_AZURE_400_USAGE_HOURS" | "ATLAS_FLEX_AZURE_500_USAGE_HOURS" | "ATLAS_FLEX_GCP_100_USAGE_HOURS" | "ATLAS_FLEX_GCP_200_USAGE_HOURS" | "ATLAS_FLEX_GCP_300_USAGE_HOURS" | "ATLAS_FLEX_GCP_400_USAGE_HOURS" | "ATLAS_FLEX_GCP_500_USAGE_HOURS";
|
|
3680
|
+
readonly lastNotified?: string;
|
|
3681
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3682
|
+
readonly links?: components["schemas"]["Link"][];
|
|
3090
3683
|
/**
|
|
3091
|
-
*
|
|
3092
|
-
* @
|
|
3684
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
3685
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3093
3686
|
*/
|
|
3094
|
-
readonly
|
|
3095
|
-
/** @description Human-readable label that identifies the Atlas App Services application associated with this line item. */
|
|
3096
|
-
readonly stitchAppName?: string;
|
|
3097
|
-
/** @description A map of key-value pairs corresponding to the tags associated with the line item resource. */
|
|
3098
|
-
readonly tags?: {
|
|
3099
|
-
[key: string]: string[];
|
|
3100
|
-
};
|
|
3687
|
+
readonly orgId?: string;
|
|
3101
3688
|
/**
|
|
3102
|
-
*
|
|
3103
|
-
* @
|
|
3104
|
-
*
|
|
3105
|
-
* **NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.
|
|
3689
|
+
* @description Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
|
|
3690
|
+
* @example event-replica-set
|
|
3106
3691
|
*/
|
|
3107
|
-
readonly
|
|
3692
|
+
readonly replicaSetName?: string;
|
|
3108
3693
|
/**
|
|
3109
|
-
* Format:
|
|
3110
|
-
* @description
|
|
3111
|
-
*
|
|
3112
|
-
* **NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.
|
|
3694
|
+
* Format: date-time
|
|
3695
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
3113
3696
|
*/
|
|
3114
|
-
readonly
|
|
3697
|
+
readonly resolved?: string;
|
|
3115
3698
|
/**
|
|
3116
|
-
*
|
|
3117
|
-
* @
|
|
3699
|
+
* @description State of this alert at the time you requested its details.
|
|
3700
|
+
* @example OPEN
|
|
3701
|
+
* @enum {string}
|
|
3118
3702
|
*/
|
|
3119
|
-
readonly
|
|
3703
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
3704
|
+
/**
|
|
3705
|
+
* Format: date-time
|
|
3706
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
3707
|
+
*/
|
|
3708
|
+
readonly updated: string;
|
|
3709
|
+
};
|
|
3710
|
+
/**
|
|
3711
|
+
* Host Event Types
|
|
3712
|
+
* @description Event type that triggers an alert.
|
|
3713
|
+
* @example HOST_DOWN
|
|
3714
|
+
* @enum {string}
|
|
3715
|
+
*/
|
|
3716
|
+
HostEventTypeViewForNdsGroupAlertable: "HOST_DOWN" | "HOST_HAS_INDEX_SUGGESTIONS" | "HOST_MONGOT_CRASHING_OOM" | "HOST_MONGOT_STOP_REPLICATION" | "HOST_NOT_ENOUGH_DISK_SPACE" | "SSH_KEY_NDS_HOST_ACCESS_REQUESTED" | "SSH_KEY_NDS_HOST_ACCESS_REFRESHED" | "PUSH_BASED_LOG_EXPORT_STOPPED" | "PUSH_BASED_LOG_EXPORT_DROPPED_LOG" | "HOST_VERSION_BEHIND" | "VERSION_BEHIND" | "HOST_EXPOSED" | "HOST_SSL_CERTIFICATE_STALE" | "HOST_SECURITY_CHECKUP_NOT_MET";
|
|
3717
|
+
/**
|
|
3718
|
+
* Host Metric Alerts
|
|
3719
|
+
* @description Host Metric Alert notifies about changes of measurements or metrics for mongod host.
|
|
3720
|
+
*/
|
|
3721
|
+
HostMetricAlert: {
|
|
3722
|
+
/**
|
|
3723
|
+
* Format: date-time
|
|
3724
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
3725
|
+
*
|
|
3726
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
3727
|
+
*
|
|
3728
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
3729
|
+
*/
|
|
3730
|
+
acknowledgedUntil?: string;
|
|
3731
|
+
/**
|
|
3732
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
3733
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
3734
|
+
*/
|
|
3735
|
+
acknowledgementComment?: string;
|
|
3736
|
+
/**
|
|
3737
|
+
* Format: email
|
|
3738
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
3739
|
+
*/
|
|
3740
|
+
readonly acknowledgingUsername?: string;
|
|
3741
|
+
/**
|
|
3742
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
3743
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3744
|
+
*/
|
|
3745
|
+
readonly alertConfigId: string;
|
|
3746
|
+
/**
|
|
3747
|
+
* @description Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
|
|
3748
|
+
* @example cluster1
|
|
3749
|
+
*/
|
|
3750
|
+
readonly clusterName?: string;
|
|
3751
|
+
/**
|
|
3752
|
+
* Format: date-time
|
|
3753
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
3754
|
+
*/
|
|
3755
|
+
readonly created: string;
|
|
3756
|
+
currentValue?: components["schemas"]["HostMetricValue"];
|
|
3757
|
+
eventTypeName: components["schemas"]["HostMetricEventTypeViewAlertable"];
|
|
3758
|
+
/**
|
|
3759
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
3760
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3761
|
+
*/
|
|
3762
|
+
readonly groupId?: string;
|
|
3763
|
+
/**
|
|
3764
|
+
* @description Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
|
|
3765
|
+
* @example cloud-test.mongodb.com:27017
|
|
3766
|
+
*/
|
|
3767
|
+
readonly hostnameAndPort?: string;
|
|
3768
|
+
/**
|
|
3769
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
3770
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3771
|
+
*/
|
|
3772
|
+
readonly id: string;
|
|
3773
|
+
/**
|
|
3774
|
+
* Format: date-time
|
|
3775
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
3776
|
+
*/
|
|
3777
|
+
readonly lastNotified?: string;
|
|
3778
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3779
|
+
readonly links?: components["schemas"]["Link"][];
|
|
3780
|
+
/**
|
|
3781
|
+
* @description Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.
|
|
3782
|
+
*
|
|
3783
|
+
* To learn more about the available metrics, see <a href="https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types" target="_blank">Host Metrics</a>.
|
|
3784
|
+
*
|
|
3785
|
+
* **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href="https://dochub.mongodb.org/core/alert-config-serverless-measurements" target="_blank">Serverless Measurements</a>.
|
|
3786
|
+
* @example ASSERT_USER
|
|
3787
|
+
*/
|
|
3788
|
+
readonly metricName?: string;
|
|
3789
|
+
/**
|
|
3790
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
3791
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3792
|
+
*/
|
|
3793
|
+
readonly orgId?: string;
|
|
3794
|
+
/**
|
|
3795
|
+
* @description Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
|
|
3796
|
+
* @example event-replica-set
|
|
3797
|
+
*/
|
|
3798
|
+
readonly replicaSetName?: string;
|
|
3799
|
+
/**
|
|
3800
|
+
* Format: date-time
|
|
3801
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
3802
|
+
*/
|
|
3803
|
+
readonly resolved?: string;
|
|
3804
|
+
/**
|
|
3805
|
+
* @description State of this alert at the time you requested its details.
|
|
3806
|
+
* @example OPEN
|
|
3807
|
+
* @enum {string}
|
|
3808
|
+
*/
|
|
3809
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
3810
|
+
/**
|
|
3811
|
+
* Format: date-time
|
|
3812
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
3813
|
+
*/
|
|
3814
|
+
readonly updated: string;
|
|
3815
|
+
};
|
|
3816
|
+
/**
|
|
3817
|
+
* Host Metric Event Types
|
|
3818
|
+
* @description Event type that triggers an alert.
|
|
3819
|
+
* @example OUTSIDE_METRIC_THRESHOLD
|
|
3820
|
+
* @enum {string}
|
|
3821
|
+
*/
|
|
3822
|
+
HostMetricEventTypeViewAlertable: "OUTSIDE_METRIC_THRESHOLD";
|
|
3823
|
+
/** @description Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts. */
|
|
3824
|
+
HostMetricValue: {
|
|
3825
|
+
/**
|
|
3826
|
+
* Format: double
|
|
3827
|
+
* @description Amount of the **metricName** recorded at the time of the event. This value triggered the alert.
|
|
3828
|
+
*/
|
|
3829
|
+
readonly number?: number;
|
|
3830
|
+
/**
|
|
3831
|
+
* @description Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.
|
|
3832
|
+
* @enum {string}
|
|
3833
|
+
*/
|
|
3834
|
+
readonly units?: "bits" | "Kbits" | "Mbits" | "Gbits" | "bytes" | "KB" | "MB" | "GB" | "TB" | "PB" | "nsec" | "msec" | "sec" | "min" | "hours" | "million minutes" | "days" | "requests" | "1000 requests" | "GB seconds" | "GB hours" | "GB days" | "RPU" | "thousand RPU" | "million RPU" | "WPU" | "thousand WPU" | "million WPU" | "count" | "thousand" | "million" | "billion";
|
|
3835
|
+
};
|
|
3836
|
+
/**
|
|
3837
|
+
* Ingestion Destination
|
|
3838
|
+
* @description Ingestion destination of a Data Lake Pipeline.
|
|
3839
|
+
*/
|
|
3840
|
+
IngestionSink: {
|
|
3841
|
+
/**
|
|
3842
|
+
* @description Type of ingestion destination of this Data Lake Pipeline.
|
|
3843
|
+
* @enum {string}
|
|
3844
|
+
*/
|
|
3845
|
+
readonly type?: "DLS";
|
|
3846
|
+
};
|
|
3847
|
+
/**
|
|
3848
|
+
* Ingestion Source
|
|
3849
|
+
* @description Ingestion Source of a Data Lake Pipeline.
|
|
3850
|
+
*/
|
|
3851
|
+
IngestionSource: {
|
|
3852
|
+
/**
|
|
3853
|
+
* @description Type of ingestion source of this Data Lake Pipeline.
|
|
3854
|
+
* @enum {string}
|
|
3855
|
+
*/
|
|
3856
|
+
type?: "PERIODIC_CPS" | "ON_DEMAND_CPS";
|
|
3857
|
+
};
|
|
3858
|
+
/**
|
|
3859
|
+
* Line Item
|
|
3860
|
+
* @description One service included in this invoice.
|
|
3861
|
+
*/
|
|
3862
|
+
InvoiceLineItem: {
|
|
3863
|
+
/** @description Human-readable label that identifies the cluster that incurred the charge. */
|
|
3864
|
+
readonly clusterName?: string;
|
|
3865
|
+
/**
|
|
3866
|
+
* Format: date-time
|
|
3867
|
+
* @description Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
3868
|
+
*/
|
|
3869
|
+
readonly created?: string;
|
|
3870
|
+
/**
|
|
3871
|
+
* Format: int64
|
|
3872
|
+
* @description Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.
|
|
3873
|
+
*/
|
|
3874
|
+
readonly discountCents?: number;
|
|
3875
|
+
/**
|
|
3876
|
+
* Format: date-time
|
|
3877
|
+
* @description Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
3878
|
+
*/
|
|
3879
|
+
readonly endDate?: string;
|
|
3880
|
+
/**
|
|
3881
|
+
* @description Unique 24-hexadecimal digit string that identifies the project associated to this line item.
|
|
3882
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3883
|
+
*/
|
|
3884
|
+
readonly groupId?: string;
|
|
3885
|
+
/** @description Human-readable label that identifies the project. */
|
|
3886
|
+
groupName?: string;
|
|
3887
|
+
/** @description Comment that applies to this line item. */
|
|
3888
|
+
readonly note?: string;
|
|
3889
|
+
/**
|
|
3890
|
+
* Format: float
|
|
3891
|
+
* @description Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.
|
|
3892
|
+
*/
|
|
3893
|
+
readonly percentDiscount?: number;
|
|
3894
|
+
/**
|
|
3895
|
+
* Format: double
|
|
3896
|
+
* @description Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.
|
|
3897
|
+
*/
|
|
3898
|
+
readonly quantity?: number;
|
|
3899
|
+
/**
|
|
3900
|
+
* @description Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.
|
|
3901
|
+
* @enum {string}
|
|
3902
|
+
*/
|
|
3903
|
+
readonly sku?: "CLASSIC_BACKUP_OPLOG" | "CLASSIC_BACKUP_STORAGE" | "CLASSIC_BACKUP_SNAPSHOT_CREATE" | "CLASSIC_BACKUP_DAILY_MINIMUM" | "CLASSIC_BACKUP_FREE_TIER" | "CLASSIC_COUPON" | "BACKUP_STORAGE_FREE_TIER" | "BACKUP_STORAGE" | "FLEX_CONSULTING" | "CLOUD_MANAGER_CLASSIC" | "CLOUD_MANAGER_BASIC_FREE_TIER" | "CLOUD_MANAGER_BASIC" | "CLOUD_MANAGER_PREMIUM" | "CLOUD_MANAGER_FREE_TIER" | "CLOUD_MANAGER_STANDARD_FREE_TIER" | "CLOUD_MANAGER_STANDARD_ANNUAL" | "CLOUD_MANAGER_STANDARD" | "CLOUD_MANAGER_FREE_TRIAL" | "ATLAS_INSTANCE_M0" | "ATLAS_INSTANCE_M2" | "ATLAS_INSTANCE_M5" | "ATLAS_AWS_INSTANCE_M10" | "ATLAS_AWS_INSTANCE_M20" | "ATLAS_AWS_INSTANCE_M30" | "ATLAS_AWS_INSTANCE_M40" | "ATLAS_AWS_INSTANCE_M50" | "ATLAS_AWS_INSTANCE_M60" | "ATLAS_AWS_INSTANCE_M80" | "ATLAS_AWS_INSTANCE_M100" | "ATLAS_AWS_INSTANCE_M140" | "ATLAS_AWS_INSTANCE_M200" | "ATLAS_AWS_INSTANCE_M300" | "ATLAS_AWS_INSTANCE_M40_LOW_CPU" | "ATLAS_AWS_INSTANCE_M50_LOW_CPU" | "ATLAS_AWS_INSTANCE_M60_LOW_CPU" | "ATLAS_AWS_INSTANCE_M80_LOW_CPU" | "ATLAS_AWS_INSTANCE_M200_LOW_CPU" | "ATLAS_AWS_INSTANCE_M300_LOW_CPU" | "ATLAS_AWS_INSTANCE_M400_LOW_CPU" | "ATLAS_AWS_INSTANCE_M700_LOW_CPU" | "ATLAS_AWS_INSTANCE_M40_NVME" | "ATLAS_AWS_INSTANCE_M50_NVME" | "ATLAS_AWS_INSTANCE_M60_NVME" | "ATLAS_AWS_INSTANCE_M80_NVME" | "ATLAS_AWS_INSTANCE_M200_NVME" | "ATLAS_AWS_INSTANCE_M400_NVME" | "ATLAS_AWS_INSTANCE_M10_PAUSED" | "ATLAS_AWS_INSTANCE_M20_PAUSED" | "ATLAS_AWS_INSTANCE_M30_PAUSED" | "ATLAS_AWS_INSTANCE_M40_PAUSED" | "ATLAS_AWS_INSTANCE_M50_PAUSED" | "ATLAS_AWS_INSTANCE_M60_PAUSED" | "ATLAS_AWS_INSTANCE_M80_PAUSED" | "ATLAS_AWS_INSTANCE_M100_PAUSED" | "ATLAS_AWS_INSTANCE_M140_PAUSED" | "ATLAS_AWS_INSTANCE_M200_PAUSED" | "ATLAS_AWS_INSTANCE_M300_PAUSED" | "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED" | "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED" | "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S40_STORAGE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S50_STORAGE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S60_STORAGE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S80_STORAGE_NVME" | "ATLAS_AWS_SEARCH_INSTANCE_S90_STORAGE_NVME" | "ATLAS_AWS_STORAGE_PROVISIONED" | "ATLAS_AWS_STORAGE_STANDARD" | "ATLAS_AWS_STORAGE_STANDARD_GP3" | "ATLAS_AWS_STORAGE_IOPS" | "ATLAS_AWS_DATA_TRANSFER_SAME_REGION" | "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION" | "ATLAS_AWS_DATA_TRANSFER_INTERNET" | "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE" | "ATLAS_AWS_BACKUP_DOWNLOAD_VM" | "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE" | "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS" | "ATLAS_AWS_PRIVATE_ENDPOINT" | "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS" | "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD" | "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD" | "ATLAS_GCP_INSTANCE_M10" | "ATLAS_GCP_INSTANCE_M20" | "ATLAS_GCP_INSTANCE_M30" | "ATLAS_GCP_INSTANCE_M40" | "ATLAS_GCP_INSTANCE_M50" | "ATLAS_GCP_INSTANCE_M60" | "ATLAS_GCP_INSTANCE_M80" | "ATLAS_GCP_INSTANCE_M140" | "ATLAS_GCP_INSTANCE_M200" | "ATLAS_GCP_INSTANCE_M250" | "ATLAS_GCP_INSTANCE_M300" | "ATLAS_GCP_INSTANCE_M400" | "ATLAS_GCP_INSTANCE_M40_LOW_CPU" | "ATLAS_GCP_INSTANCE_M50_LOW_CPU" | "ATLAS_GCP_INSTANCE_M60_LOW_CPU" | "ATLAS_GCP_INSTANCE_M80_LOW_CPU" | "ATLAS_GCP_INSTANCE_M200_LOW_CPU" | "ATLAS_GCP_INSTANCE_M300_LOW_CPU" | "ATLAS_GCP_INSTANCE_M400_LOW_CPU" | "ATLAS_GCP_INSTANCE_M600_LOW_CPU" | "ATLAS_GCP_INSTANCE_M10_PAUSED" | "ATLAS_GCP_INSTANCE_M20_PAUSED" | "ATLAS_GCP_INSTANCE_M30_PAUSED" | "ATLAS_GCP_INSTANCE_M40_PAUSED" | "ATLAS_GCP_INSTANCE_M50_PAUSED" | "ATLAS_GCP_INSTANCE_M60_PAUSED" | "ATLAS_GCP_INSTANCE_M80_PAUSED" | "ATLAS_GCP_INSTANCE_M140_PAUSED" | "ATLAS_GCP_INSTANCE_M200_PAUSED" | "ATLAS_GCP_INSTANCE_M250_PAUSED" | "ATLAS_GCP_INSTANCE_M300_PAUSED" | "ATLAS_GCP_INSTANCE_M400_PAUSED" | "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED" | "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED" | "ATLAS_GCP_DATA_TRANSFER_INTERNET" | "ATLAS_GCP_STORAGE_SSD" | "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT" | "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE" | "ATLAS_GCP_DATA_TRANSFER_INTER_REGION" | "ATLAS_GCP_DATA_TRANSFER_GOOGLE" | "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE" | "ATLAS_GCP_BACKUP_DOWNLOAD_VM" | "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE" | "ATLAS_GCP_PRIVATE_ENDPOINT" | "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS" | "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER" | "ATLAS_AZURE_INSTANCE_M10" | "ATLAS_AZURE_INSTANCE_M20" | "ATLAS_AZURE_INSTANCE_M30" | "ATLAS_AZURE_INSTANCE_M40" | "ATLAS_AZURE_INSTANCE_M50" | "ATLAS_AZURE_INSTANCE_M60" | "ATLAS_AZURE_INSTANCE_M80" | "ATLAS_AZURE_INSTANCE_M90" | "ATLAS_AZURE_INSTANCE_M200" | "ATLAS_AZURE_INSTANCE_R40" | "ATLAS_AZURE_INSTANCE_R50" | "ATLAS_AZURE_INSTANCE_R60" | "ATLAS_AZURE_INSTANCE_R80" | "ATLAS_AZURE_INSTANCE_R200" | "ATLAS_AZURE_INSTANCE_R300" | "ATLAS_AZURE_INSTANCE_R400" | "ATLAS_AZURE_INSTANCE_M60_NVME" | "ATLAS_AZURE_INSTANCE_M80_NVME" | "ATLAS_AZURE_INSTANCE_M200_NVME" | "ATLAS_AZURE_INSTANCE_M300_NVME" | "ATLAS_AZURE_INSTANCE_M400_NVME" | "ATLAS_AZURE_INSTANCE_M600_NVME" | "ATLAS_AZURE_INSTANCE_M10_PAUSED" | "ATLAS_AZURE_INSTANCE_M20_PAUSED" | "ATLAS_AZURE_INSTANCE_M30_PAUSED" | "ATLAS_AZURE_INSTANCE_M40_PAUSED" | "ATLAS_AZURE_INSTANCE_M50_PAUSED" | "ATLAS_AZURE_INSTANCE_M60_PAUSED" | "ATLAS_AZURE_INSTANCE_M80_PAUSED" | "ATLAS_AZURE_INSTANCE_M90_PAUSED" | "ATLAS_AZURE_INSTANCE_M200_PAUSED" | "ATLAS_AZURE_INSTANCE_R40_PAUSED" | "ATLAS_AZURE_INSTANCE_R50_PAUSED" | "ATLAS_AZURE_INSTANCE_R60_PAUSED" | "ATLAS_AZURE_INSTANCE_R80_PAUSED" | "ATLAS_AZURE_INSTANCE_R200_PAUSED" | "ATLAS_AZURE_INSTANCE_R300_PAUSED" | "ATLAS_AZURE_INSTANCE_R400_PAUSED" | "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD" | "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD" | "ATLAS_AZURE_STORAGE_P2" | "ATLAS_AZURE_STORAGE_P3" | "ATLAS_AZURE_STORAGE_P4" | "ATLAS_AZURE_STORAGE_P6" | "ATLAS_AZURE_STORAGE_P10" | "ATLAS_AZURE_STORAGE_P15" | "ATLAS_AZURE_STORAGE_P20" | "ATLAS_AZURE_STORAGE_P30" | "ATLAS_AZURE_STORAGE_P40" | "ATLAS_AZURE_STORAGE_P50" | "ATLAS_AZURE_DATA_TRANSFER" | "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN" | "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT" | "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN" | "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT" | "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN" | "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT" | "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT" | "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT" | "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50" | "ATLAS_AZURE_STANDARD_STORAGE" | "ATLAS_AZURE_EXTENDED_STANDARD_IOPS" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE" | "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS" | "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE" | "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS" | "ATLAS_BI_CONNECTOR" | "ATLAS_ADVANCED_SECURITY" | "ATLAS_ENTERPRISE_AUDITING" | "ATLAS_FREE_SUPPORT" | "ATLAS_SUPPORT" | "ATLAS_NDS_BACKFILL_SUPPORT" | "STITCH_DATA_DOWNLOADED_FREE_TIER" | "STITCH_DATA_DOWNLOADED" | "STITCH_COMPUTE_FREE_TIER" | "STITCH_COMPUTE" | "CREDIT" | "MINIMUM_CHARGE" | "CHARTS_DATA_DOWNLOADED_FREE_TIER" | "CHARTS_DATA_DOWNLOADED" | "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION" | "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION" | "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET" | "ATLAS_DATA_LAKE_AWS_DATA_SCANNED" | "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION" | "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS" | "ATLAS_NDS_AWS_DATA_LAKE_STORAGE" | "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION" | "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT" | "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT" | "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET" | "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION" | "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION" | "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET" | "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED" | "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS" | "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE" | "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED" | "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS" | "ATLAS_NDS_GCP_DATA_LAKE_STORAGE" | "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS" | "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE" | "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS" | "ATLAS_NDS_AZURE_OBJECT_STORAGE" | "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE" | "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS" | "ATLAS_NDS_GCP_OBJECT_STORAGE" | "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE" | "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE" | "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER" | "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE" | "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER" | "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE" | "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER" | "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE" | "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS" | "ATLAS_NDS_AZURE_CMK_PRIVATE_NETWORKING" | "ATLAS_NDS_AWS_CMK_PRIVATE_NETWORKING" | "ATLAS_NDS_AWS_OBJECT_STORAGE" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40" | "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE" | "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS" | "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM" | "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40" | "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50" | "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60" | "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE" | "ATLAS_NDS_AWS_SERVERLESS_RPU" | "ATLAS_NDS_AWS_SERVERLESS_WPU" | "ATLAS_NDS_AWS_SERVERLESS_STORAGE" | "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP" | "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM" | "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW" | "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER" | "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL" | "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION" | "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET" | "ATLAS_NDS_GCP_SERVERLESS_RPU" | "ATLAS_NDS_GCP_SERVERLESS_WPU" | "ATLAS_NDS_GCP_SERVERLESS_STORAGE" | "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP" | "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM" | "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW" | "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER" | "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL" | "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION" | "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET" | "ATLAS_NDS_AZURE_SERVERLESS_RPU" | "ATLAS_NDS_AZURE_SERVERLESS_WPU" | "ATLAS_NDS_AZURE_SERVERLESS_STORAGE" | "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP" | "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM" | "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW" | "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER" | "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL" | "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION" | "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET" | "REALM_APP_REQUESTS_FREE_TIER" | "REALM_APP_REQUESTS" | "REALM_APP_COMPUTE_FREE_TIER" | "REALM_APP_COMPUTE" | "REALM_APP_SYNC_FREE_TIER" | "REALM_APP_SYNC" | "REALM_APP_DATA_TRANSFER_FREE_TIER" | "REALM_APP_DATA_TRANSFER" | "GCP_SNAPSHOT_COPY_DISK" | "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10" | "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30" | "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50" | "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10" | "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30" | "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50" | "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER" | "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER" | "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" | "ATLAS_AZURE_STREAM_PROCESSING_PRIVATELINK" | "ATLAS_AWS_STREAM_PROCESSING_PRIVATELINK" | "ATLAS_FLEX_AWS_100_USAGE_HOURS" | "ATLAS_FLEX_AWS_200_USAGE_HOURS" | "ATLAS_FLEX_AWS_300_USAGE_HOURS" | "ATLAS_FLEX_AWS_400_USAGE_HOURS" | "ATLAS_FLEX_AWS_500_USAGE_HOURS" | "ATLAS_FLEX_AZURE_100_USAGE_HOURS" | "ATLAS_FLEX_AZURE_200_USAGE_HOURS" | "ATLAS_FLEX_AZURE_300_USAGE_HOURS" | "ATLAS_FLEX_AZURE_400_USAGE_HOURS" | "ATLAS_FLEX_AZURE_500_USAGE_HOURS" | "ATLAS_FLEX_GCP_100_USAGE_HOURS" | "ATLAS_FLEX_GCP_200_USAGE_HOURS" | "ATLAS_FLEX_GCP_300_USAGE_HOURS" | "ATLAS_FLEX_GCP_400_USAGE_HOURS" | "ATLAS_FLEX_GCP_500_USAGE_HOURS" | "ATLAS_FLEX_AWS_LEGACY_100_USAGE_HOURS" | "ATLAS_FLEX_AWS_LEGACY_200_USAGE_HOURS" | "ATLAS_FLEX_AWS_LEGACY_300_USAGE_HOURS" | "ATLAS_FLEX_AWS_LEGACY_400_USAGE_HOURS" | "ATLAS_FLEX_AWS_LEGACY_500_USAGE_HOURS" | "ATLAS_FLEX_AZURE_LEGACY_100_USAGE_HOURS" | "ATLAS_FLEX_AZURE_LEGACY_200_USAGE_HOURS" | "ATLAS_FLEX_AZURE_LEGACY_300_USAGE_HOURS" | "ATLAS_FLEX_AZURE_LEGACY_400_USAGE_HOURS" | "ATLAS_FLEX_AZURE_LEGACY_500_USAGE_HOURS" | "ATLAS_FLEX_GCP_LEGACY_100_USAGE_HOURS" | "ATLAS_FLEX_GCP_LEGACY_200_USAGE_HOURS" | "ATLAS_FLEX_GCP_LEGACY_300_USAGE_HOURS" | "ATLAS_FLEX_GCP_LEGACY_400_USAGE_HOURS" | "ATLAS_FLEX_GCP_LEGACY_500_USAGE_HOURS";
|
|
3904
|
+
/**
|
|
3905
|
+
* Format: date-time
|
|
3906
|
+
* @description Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
3907
|
+
*/
|
|
3908
|
+
readonly startDate?: string;
|
|
3909
|
+
/** @description Human-readable label that identifies the Atlas App Services application associated with this line item. */
|
|
3910
|
+
readonly stitchAppName?: string;
|
|
3911
|
+
/** @description A map of key-value pairs corresponding to the tags associated with the line item resource. */
|
|
3912
|
+
readonly tags?: {
|
|
3913
|
+
[key: string]: string[];
|
|
3914
|
+
};
|
|
3915
|
+
/**
|
|
3916
|
+
* Format: double
|
|
3917
|
+
* @description Lower bound for usage amount range in current SKU tier.
|
|
3918
|
+
*
|
|
3919
|
+
* **NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.
|
|
3920
|
+
*/
|
|
3921
|
+
readonly tierLowerBound?: number;
|
|
3922
|
+
/**
|
|
3923
|
+
* Format: double
|
|
3924
|
+
* @description Upper bound for usage amount range in current SKU tier.
|
|
3925
|
+
*
|
|
3926
|
+
* **NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.
|
|
3927
|
+
*/
|
|
3928
|
+
readonly tierUpperBound?: number;
|
|
3929
|
+
/**
|
|
3930
|
+
* Format: int64
|
|
3931
|
+
* @description Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.
|
|
3932
|
+
*/
|
|
3933
|
+
readonly totalPriceCents?: number;
|
|
3120
3934
|
/** @description Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like. */
|
|
3121
3935
|
readonly unit?: string;
|
|
3122
3936
|
/**
|
|
@@ -3198,6 +4012,120 @@ export interface components {
|
|
|
3198
4012
|
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3199
4013
|
readonly links?: components["schemas"]["Link"][];
|
|
3200
4014
|
};
|
|
4015
|
+
NumberMetricAlertView: {
|
|
4016
|
+
/**
|
|
4017
|
+
* Format: date-time
|
|
4018
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
4019
|
+
*
|
|
4020
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
4021
|
+
*
|
|
4022
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
4023
|
+
*/
|
|
4024
|
+
acknowledgedUntil?: string;
|
|
4025
|
+
/**
|
|
4026
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
4027
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
4028
|
+
*/
|
|
4029
|
+
acknowledgementComment?: string;
|
|
4030
|
+
/**
|
|
4031
|
+
* Format: email
|
|
4032
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
4033
|
+
*/
|
|
4034
|
+
readonly acknowledgingUsername?: string;
|
|
4035
|
+
/**
|
|
4036
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
4037
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4038
|
+
*/
|
|
4039
|
+
readonly alertConfigId: string;
|
|
4040
|
+
/**
|
|
4041
|
+
* @description Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
|
|
4042
|
+
* @example cluster1
|
|
4043
|
+
*/
|
|
4044
|
+
readonly clusterName?: string;
|
|
4045
|
+
/**
|
|
4046
|
+
* Format: date-time
|
|
4047
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
4048
|
+
*/
|
|
4049
|
+
readonly created: string;
|
|
4050
|
+
currentValue?: components["schemas"]["NumberMetricValueView"];
|
|
4051
|
+
eventTypeName: components["schemas"]["HostMetricEventTypeViewAlertable"];
|
|
4052
|
+
/**
|
|
4053
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
4054
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4055
|
+
*/
|
|
4056
|
+
readonly groupId?: string;
|
|
4057
|
+
/**
|
|
4058
|
+
* @description Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
|
|
4059
|
+
* @example cloud-test.mongodb.com:27017
|
|
4060
|
+
*/
|
|
4061
|
+
readonly hostnameAndPort?: string;
|
|
4062
|
+
/**
|
|
4063
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
4064
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4065
|
+
*/
|
|
4066
|
+
readonly id: string;
|
|
4067
|
+
/**
|
|
4068
|
+
* Format: date-time
|
|
4069
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
4070
|
+
*/
|
|
4071
|
+
readonly lastNotified?: string;
|
|
4072
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4073
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4074
|
+
/**
|
|
4075
|
+
* @description Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.
|
|
4076
|
+
*
|
|
4077
|
+
* To learn more about the available metrics, see <a href="https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types" target="_blank">Host Metrics</a>.
|
|
4078
|
+
*
|
|
4079
|
+
* **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href="https://dochub.mongodb.org/core/alert-config-serverless-measurements" target="_blank">Serverless Measurements</a>.
|
|
4080
|
+
* @example ASSERT_USER
|
|
4081
|
+
*/
|
|
4082
|
+
readonly metricName?: string;
|
|
4083
|
+
/**
|
|
4084
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
4085
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4086
|
+
*/
|
|
4087
|
+
readonly orgId?: string;
|
|
4088
|
+
/**
|
|
4089
|
+
* @description Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
|
|
4090
|
+
* @example event-replica-set
|
|
4091
|
+
*/
|
|
4092
|
+
readonly replicaSetName?: string;
|
|
4093
|
+
/**
|
|
4094
|
+
* Format: date-time
|
|
4095
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
4096
|
+
*/
|
|
4097
|
+
readonly resolved?: string;
|
|
4098
|
+
/**
|
|
4099
|
+
* @description State of this alert at the time you requested its details.
|
|
4100
|
+
* @example OPEN
|
|
4101
|
+
* @enum {string}
|
|
4102
|
+
*/
|
|
4103
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
4104
|
+
/**
|
|
4105
|
+
* Format: date-time
|
|
4106
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
4107
|
+
*/
|
|
4108
|
+
readonly updated: string;
|
|
4109
|
+
};
|
|
4110
|
+
/**
|
|
4111
|
+
* Number Metric Units
|
|
4112
|
+
* @description Element used to express the quantity. This can be an element of time, storage capacity, and the like.
|
|
4113
|
+
* @example COUNT
|
|
4114
|
+
* @enum {string}
|
|
4115
|
+
*/
|
|
4116
|
+
NumberMetricUnits: "COUNT" | "THOUSAND" | "MILLION" | "BILLION";
|
|
4117
|
+
/**
|
|
4118
|
+
* Number Metric Value
|
|
4119
|
+
* @description Measurement of the **metricName** recorded at the time of the event.
|
|
4120
|
+
*/
|
|
4121
|
+
NumberMetricValueView: {
|
|
4122
|
+
/**
|
|
4123
|
+
* Format: double
|
|
4124
|
+
* @description Amount of the **metricName** recorded at the time of the event. This value triggered the alert.
|
|
4125
|
+
*/
|
|
4126
|
+
readonly number?: number;
|
|
4127
|
+
units?: components["schemas"]["NumberMetricUnits"];
|
|
4128
|
+
};
|
|
3201
4129
|
/**
|
|
3202
4130
|
* On-Demand Cloud Provider Snapshot Source
|
|
3203
4131
|
* @description On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.
|
|
@@ -3333,113 +4261,352 @@ export interface components {
|
|
|
3333
4261
|
/** @description List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs. */
|
|
3334
4262
|
readonly teamIds?: string[];
|
|
3335
4263
|
/**
|
|
3336
|
-
* Format: email
|
|
3337
|
-
* @description Email address that represents the username of the MongoDB Cloud user.
|
|
4264
|
+
* Format: email
|
|
4265
|
+
* @description Email address that represents the username of the MongoDB Cloud user.
|
|
4266
|
+
*/
|
|
4267
|
+
readonly username: string;
|
|
4268
|
+
} & (components["schemas"]["OrgPendingUserResponse"] | components["schemas"]["OrgActiveUserResponse"]);
|
|
4269
|
+
/** @description Organization- and project-level roles assigned to one MongoDB Cloud user within one organization. */
|
|
4270
|
+
OrgUserRolesResponse: {
|
|
4271
|
+
/** @description List of project-level role assignments assigned to the MongoDB Cloud user. */
|
|
4272
|
+
groupRoleAssignments?: components["schemas"]["GroupRoleAssignment"][];
|
|
4273
|
+
/** @description One or more organization-level roles assigned to the MongoDB Cloud user. */
|
|
4274
|
+
orgRoles?: ("ORG_OWNER" | "ORG_GROUP_CREATOR" | "ORG_BILLING_ADMIN" | "ORG_BILLING_READ_ONLY" | "ORG_READ_ONLY" | "ORG_MEMBER")[];
|
|
4275
|
+
};
|
|
4276
|
+
PaginatedAlertView: {
|
|
4277
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4278
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4279
|
+
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
4280
|
+
readonly results?: components["schemas"]["AlertViewForNdsGroup"][];
|
|
4281
|
+
/**
|
|
4282
|
+
* Format: int32
|
|
4283
|
+
* @description Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.
|
|
4284
|
+
*/
|
|
4285
|
+
readonly totalCount?: number;
|
|
4286
|
+
};
|
|
4287
|
+
/** @description List of MongoDB Database users granted access to databases in the specified project. */
|
|
4288
|
+
PaginatedApiAtlasDatabaseUserView: {
|
|
4289
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4290
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4291
|
+
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
4292
|
+
readonly results?: components["schemas"]["CloudDatabaseUser"][];
|
|
4293
|
+
/**
|
|
4294
|
+
* Format: int32
|
|
4295
|
+
* @description Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.
|
|
4296
|
+
*/
|
|
4297
|
+
readonly totalCount?: number;
|
|
4298
|
+
};
|
|
4299
|
+
PaginatedAtlasGroupView: {
|
|
4300
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4301
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4302
|
+
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
4303
|
+
readonly results?: components["schemas"]["Group"][];
|
|
4304
|
+
/**
|
|
4305
|
+
* Format: int32
|
|
4306
|
+
* @description Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.
|
|
4307
|
+
*/
|
|
4308
|
+
readonly totalCount?: number;
|
|
4309
|
+
};
|
|
4310
|
+
PaginatedClusterDescription20240805: {
|
|
4311
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4312
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4313
|
+
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
4314
|
+
readonly results?: components["schemas"]["ClusterDescription20240805"][];
|
|
4315
|
+
/**
|
|
4316
|
+
* Format: int32
|
|
4317
|
+
* @description Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.
|
|
4318
|
+
*/
|
|
4319
|
+
readonly totalCount?: number;
|
|
4320
|
+
};
|
|
4321
|
+
PaginatedFlexClusters20241113: {
|
|
4322
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4323
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4324
|
+
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
4325
|
+
readonly results?: components["schemas"]["FlexClusterDescription20241113"][];
|
|
4326
|
+
/**
|
|
4327
|
+
* Format: int32
|
|
4328
|
+
* @description Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.
|
|
4329
|
+
*/
|
|
4330
|
+
readonly totalCount?: number;
|
|
4331
|
+
};
|
|
4332
|
+
PaginatedNetworkAccessView: {
|
|
4333
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4334
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4335
|
+
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
4336
|
+
readonly results?: components["schemas"]["NetworkPermissionEntry"][];
|
|
4337
|
+
/**
|
|
4338
|
+
* Format: int32
|
|
4339
|
+
* @description Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.
|
|
4340
|
+
*/
|
|
4341
|
+
readonly totalCount?: number;
|
|
4342
|
+
};
|
|
4343
|
+
PaginatedOrgGroupView: {
|
|
4344
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4345
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4346
|
+
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
4347
|
+
readonly results?: components["schemas"]["OrgGroup"][];
|
|
4348
|
+
/**
|
|
4349
|
+
* Format: int32
|
|
4350
|
+
* @description Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.
|
|
4351
|
+
*/
|
|
4352
|
+
readonly totalCount?: number;
|
|
4353
|
+
};
|
|
4354
|
+
PaginatedOrganizationView: {
|
|
4355
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4356
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4357
|
+
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
4358
|
+
readonly results?: components["schemas"]["AtlasOrganization"][];
|
|
4359
|
+
/**
|
|
4360
|
+
* Format: int32
|
|
4361
|
+
* @description Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.
|
|
4362
|
+
*/
|
|
4363
|
+
readonly totalCount?: number;
|
|
4364
|
+
};
|
|
4365
|
+
/**
|
|
4366
|
+
* Periodic Cloud Provider Snapshot Source
|
|
4367
|
+
* @description Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.
|
|
4368
|
+
*/
|
|
4369
|
+
PeriodicCpsSnapshotSource: Omit<components["schemas"]["IngestionSource"], "type"> & {
|
|
4370
|
+
/** @description Human-readable name that identifies the cluster. */
|
|
4371
|
+
clusterName?: string;
|
|
4372
|
+
/** @description Human-readable name that identifies the collection. */
|
|
4373
|
+
collectionName?: string;
|
|
4374
|
+
/** @description Human-readable name that identifies the database. */
|
|
4375
|
+
databaseName?: string;
|
|
4376
|
+
/**
|
|
4377
|
+
* @description Unique 24-hexadecimal character string that identifies the project.
|
|
4378
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4379
|
+
*/
|
|
4380
|
+
readonly groupId?: string;
|
|
4381
|
+
/**
|
|
4382
|
+
* @description Unique 24-hexadecimal character string that identifies a policy item.
|
|
4383
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4384
|
+
*/
|
|
4385
|
+
policyItemId?: string;
|
|
4386
|
+
} & {
|
|
4387
|
+
/**
|
|
4388
|
+
* @description discriminator enum property added by openapi-typescript
|
|
4389
|
+
* @enum {string}
|
|
4390
|
+
*/
|
|
4391
|
+
type: "PERIODIC_CPS";
|
|
4392
|
+
};
|
|
4393
|
+
RawMetricAlertView: {
|
|
4394
|
+
/**
|
|
4395
|
+
* Format: date-time
|
|
4396
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
4397
|
+
*
|
|
4398
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
4399
|
+
*
|
|
4400
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
4401
|
+
*/
|
|
4402
|
+
acknowledgedUntil?: string;
|
|
4403
|
+
/**
|
|
4404
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
4405
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
4406
|
+
*/
|
|
4407
|
+
acknowledgementComment?: string;
|
|
4408
|
+
/**
|
|
4409
|
+
* Format: email
|
|
4410
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
4411
|
+
*/
|
|
4412
|
+
readonly acknowledgingUsername?: string;
|
|
4413
|
+
/**
|
|
4414
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
4415
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4416
|
+
*/
|
|
4417
|
+
readonly alertConfigId: string;
|
|
4418
|
+
/**
|
|
4419
|
+
* @description Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
|
|
4420
|
+
* @example cluster1
|
|
4421
|
+
*/
|
|
4422
|
+
readonly clusterName?: string;
|
|
4423
|
+
/**
|
|
4424
|
+
* Format: date-time
|
|
4425
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
4426
|
+
*/
|
|
4427
|
+
readonly created: string;
|
|
4428
|
+
currentValue?: components["schemas"]["RawMetricValueView"];
|
|
4429
|
+
eventTypeName: components["schemas"]["HostMetricEventTypeViewAlertable"];
|
|
4430
|
+
/**
|
|
4431
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
4432
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4433
|
+
*/
|
|
4434
|
+
readonly groupId?: string;
|
|
4435
|
+
/**
|
|
4436
|
+
* @description Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
|
|
4437
|
+
* @example cloud-test.mongodb.com:27017
|
|
4438
|
+
*/
|
|
4439
|
+
readonly hostnameAndPort?: string;
|
|
4440
|
+
/**
|
|
4441
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
4442
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4443
|
+
*/
|
|
4444
|
+
readonly id: string;
|
|
4445
|
+
/**
|
|
4446
|
+
* Format: date-time
|
|
4447
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
4448
|
+
*/
|
|
4449
|
+
readonly lastNotified?: string;
|
|
4450
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4451
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4452
|
+
/**
|
|
4453
|
+
* @description Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.
|
|
4454
|
+
*
|
|
4455
|
+
* To learn more about the available metrics, see <a href="https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types" target="_blank">Host Metrics</a>.
|
|
4456
|
+
*
|
|
4457
|
+
* **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href="https://dochub.mongodb.org/core/alert-config-serverless-measurements" target="_blank">Serverless Measurements</a>.
|
|
4458
|
+
* @example ASSERT_USER
|
|
4459
|
+
*/
|
|
4460
|
+
readonly metricName?: string;
|
|
4461
|
+
/**
|
|
4462
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
4463
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4464
|
+
*/
|
|
4465
|
+
readonly orgId?: string;
|
|
4466
|
+
/**
|
|
4467
|
+
* @description Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
|
|
4468
|
+
* @example event-replica-set
|
|
4469
|
+
*/
|
|
4470
|
+
readonly replicaSetName?: string;
|
|
4471
|
+
/**
|
|
4472
|
+
* Format: date-time
|
|
4473
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
4474
|
+
*/
|
|
4475
|
+
readonly resolved?: string;
|
|
4476
|
+
/**
|
|
4477
|
+
* @description State of this alert at the time you requested its details.
|
|
4478
|
+
* @example OPEN
|
|
4479
|
+
* @enum {string}
|
|
4480
|
+
*/
|
|
4481
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
4482
|
+
/**
|
|
4483
|
+
* Format: date-time
|
|
4484
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
4485
|
+
*/
|
|
4486
|
+
readonly updated: string;
|
|
4487
|
+
};
|
|
4488
|
+
/**
|
|
4489
|
+
* Raw Metric Units
|
|
4490
|
+
* @description Element used to express the quantity. This can be an element of time, storage capacity, and the like.
|
|
4491
|
+
* @default RAW
|
|
4492
|
+
* @enum {string}
|
|
4493
|
+
*/
|
|
4494
|
+
RawMetricUnits: "RAW";
|
|
4495
|
+
/**
|
|
4496
|
+
* Raw Metric Value
|
|
4497
|
+
* @description Measurement of the **metricName** recorded at the time of the event.
|
|
4498
|
+
*/
|
|
4499
|
+
RawMetricValueView: {
|
|
4500
|
+
/**
|
|
4501
|
+
* Format: double
|
|
4502
|
+
* @description Amount of the **metricName** recorded at the time of the event. This value triggered the alert.
|
|
4503
|
+
*/
|
|
4504
|
+
readonly number?: number;
|
|
4505
|
+
units?: components["schemas"]["RawMetricUnits"];
|
|
4506
|
+
};
|
|
4507
|
+
/**
|
|
4508
|
+
* ReplicaSet Alerts
|
|
4509
|
+
* @description ReplicaSet alert notifies about different activities on replica set of mongod instances.
|
|
4510
|
+
*/
|
|
4511
|
+
ReplicaSetAlertViewForNdsGroup: {
|
|
4512
|
+
/**
|
|
4513
|
+
* Format: date-time
|
|
4514
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
4515
|
+
*
|
|
4516
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
4517
|
+
*
|
|
4518
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
4519
|
+
*/
|
|
4520
|
+
acknowledgedUntil?: string;
|
|
4521
|
+
/**
|
|
4522
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
4523
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
4524
|
+
*/
|
|
4525
|
+
acknowledgementComment?: string;
|
|
4526
|
+
/**
|
|
4527
|
+
* Format: email
|
|
4528
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
4529
|
+
*/
|
|
4530
|
+
readonly acknowledgingUsername?: string;
|
|
4531
|
+
/**
|
|
4532
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
4533
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4534
|
+
*/
|
|
4535
|
+
readonly alertConfigId: string;
|
|
4536
|
+
/**
|
|
4537
|
+
* @description Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
|
|
4538
|
+
* @example cluster1
|
|
3338
4539
|
*/
|
|
3339
|
-
readonly
|
|
3340
|
-
} & (components["schemas"]["OrgPendingUserResponse"] | components["schemas"]["OrgActiveUserResponse"]);
|
|
3341
|
-
/** @description Organization- and project-level roles assigned to one MongoDB Cloud user within one organization. */
|
|
3342
|
-
OrgUserRolesResponse: {
|
|
3343
|
-
/** @description List of project-level role assignments assigned to the MongoDB Cloud user. */
|
|
3344
|
-
groupRoleAssignments?: components["schemas"]["GroupRoleAssignment"][];
|
|
3345
|
-
/** @description One or more organization-level roles assigned to the MongoDB Cloud user. */
|
|
3346
|
-
orgRoles?: ("ORG_OWNER" | "ORG_GROUP_CREATOR" | "ORG_BILLING_ADMIN" | "ORG_BILLING_READ_ONLY" | "ORG_READ_ONLY" | "ORG_MEMBER")[];
|
|
3347
|
-
};
|
|
3348
|
-
/** @description List of MongoDB Database users granted access to databases in the specified project. */
|
|
3349
|
-
PaginatedApiAtlasDatabaseUserView: {
|
|
3350
|
-
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3351
|
-
readonly links?: components["schemas"]["Link"][];
|
|
3352
|
-
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
3353
|
-
readonly results?: components["schemas"]["CloudDatabaseUser"][];
|
|
4540
|
+
readonly clusterName?: string;
|
|
3354
4541
|
/**
|
|
3355
|
-
* Format:
|
|
3356
|
-
* @description
|
|
4542
|
+
* Format: date-time
|
|
4543
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
3357
4544
|
*/
|
|
3358
|
-
readonly
|
|
3359
|
-
|
|
3360
|
-
PaginatedAtlasGroupView: {
|
|
3361
|
-
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3362
|
-
readonly links?: components["schemas"]["Link"][];
|
|
3363
|
-
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
3364
|
-
readonly results?: components["schemas"]["Group"][];
|
|
4545
|
+
readonly created: string;
|
|
4546
|
+
eventTypeName: components["schemas"]["ReplicaSetEventTypeViewForNdsGroupAlertable"];
|
|
3365
4547
|
/**
|
|
3366
|
-
*
|
|
3367
|
-
* @
|
|
4548
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
4549
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3368
4550
|
*/
|
|
3369
|
-
readonly
|
|
3370
|
-
};
|
|
3371
|
-
PaginatedClusterDescription20240805: {
|
|
3372
|
-
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3373
|
-
readonly links?: components["schemas"]["Link"][];
|
|
3374
|
-
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
3375
|
-
readonly results?: components["schemas"]["ClusterDescription20240805"][];
|
|
4551
|
+
readonly groupId?: string;
|
|
3376
4552
|
/**
|
|
3377
|
-
*
|
|
3378
|
-
* @
|
|
4553
|
+
* @description Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
|
|
4554
|
+
* @example cloud-test.mongodb.com:27017
|
|
3379
4555
|
*/
|
|
3380
|
-
readonly
|
|
3381
|
-
};
|
|
3382
|
-
PaginatedNetworkAccessView: {
|
|
3383
|
-
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3384
|
-
readonly links?: components["schemas"]["Link"][];
|
|
3385
|
-
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
3386
|
-
readonly results?: components["schemas"]["NetworkPermissionEntry"][];
|
|
4556
|
+
readonly hostnameAndPort?: string;
|
|
3387
4557
|
/**
|
|
3388
|
-
*
|
|
3389
|
-
* @
|
|
4558
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
4559
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3390
4560
|
*/
|
|
3391
|
-
readonly
|
|
3392
|
-
};
|
|
3393
|
-
PaginatedOrgGroupView: {
|
|
3394
|
-
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3395
|
-
readonly links?: components["schemas"]["Link"][];
|
|
3396
|
-
/** @description List of returned documents that MongoDB Cloud provides when completing this request. */
|
|
3397
|
-
readonly results?: components["schemas"]["OrgGroup"][];
|
|
4561
|
+
readonly id: string;
|
|
3398
4562
|
/**
|
|
3399
|
-
* Format:
|
|
3400
|
-
* @description
|
|
4563
|
+
* Format: date-time
|
|
4564
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
3401
4565
|
*/
|
|
3402
|
-
readonly
|
|
3403
|
-
};
|
|
3404
|
-
PaginatedOrganizationView: {
|
|
4566
|
+
readonly lastNotified?: string;
|
|
3405
4567
|
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
3406
4568
|
readonly links?: components["schemas"]["Link"][];
|
|
3407
|
-
/** @description List of
|
|
3408
|
-
readonly
|
|
4569
|
+
/** @description List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state. */
|
|
4570
|
+
readonly nonRunningHostIds?: string[];
|
|
3409
4571
|
/**
|
|
3410
|
-
*
|
|
3411
|
-
* @
|
|
4572
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
4573
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
3412
4574
|
*/
|
|
3413
|
-
readonly
|
|
3414
|
-
};
|
|
3415
|
-
/**
|
|
3416
|
-
* Periodic Cloud Provider Snapshot Source
|
|
3417
|
-
* @description Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.
|
|
3418
|
-
*/
|
|
3419
|
-
PeriodicCpsSnapshotSource: Omit<components["schemas"]["IngestionSource"], "type"> & {
|
|
3420
|
-
/** @description Human-readable name that identifies the cluster. */
|
|
3421
|
-
clusterName?: string;
|
|
3422
|
-
/** @description Human-readable name that identifies the collection. */
|
|
3423
|
-
collectionName?: string;
|
|
3424
|
-
/** @description Human-readable name that identifies the database. */
|
|
3425
|
-
databaseName?: string;
|
|
4575
|
+
readonly orgId?: string;
|
|
3426
4576
|
/**
|
|
3427
|
-
* @description Unique 24-hexadecimal character string that identifies the
|
|
4577
|
+
* @description Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.
|
|
3428
4578
|
* @example 32b6e34b3d91647abb20e7b8
|
|
3429
4579
|
*/
|
|
3430
|
-
readonly
|
|
4580
|
+
readonly parentClusterId?: string;
|
|
3431
4581
|
/**
|
|
3432
|
-
* @description
|
|
3433
|
-
* @example
|
|
4582
|
+
* @description Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
|
|
4583
|
+
* @example event-replica-set
|
|
3434
4584
|
*/
|
|
3435
|
-
|
|
3436
|
-
} & {
|
|
4585
|
+
readonly replicaSetName?: string;
|
|
3437
4586
|
/**
|
|
3438
|
-
*
|
|
4587
|
+
* Format: date-time
|
|
4588
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
4589
|
+
*/
|
|
4590
|
+
readonly resolved?: string;
|
|
4591
|
+
/**
|
|
4592
|
+
* @description State of this alert at the time you requested its details.
|
|
4593
|
+
* @example OPEN
|
|
3439
4594
|
* @enum {string}
|
|
3440
4595
|
*/
|
|
3441
|
-
|
|
4596
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
4597
|
+
/**
|
|
4598
|
+
* Format: date-time
|
|
4599
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
4600
|
+
*/
|
|
4601
|
+
readonly updated: string;
|
|
3442
4602
|
};
|
|
4603
|
+
/**
|
|
4604
|
+
* ReplicaSet Event Types
|
|
4605
|
+
* @description Incident that triggered this alert.
|
|
4606
|
+
* @example NO_PRIMARY
|
|
4607
|
+
* @enum {string}
|
|
4608
|
+
*/
|
|
4609
|
+
ReplicaSetEventTypeViewForNdsGroupAlertable: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" | "NO_PRIMARY" | "PRIMARY_ELECTED" | "TOO_MANY_ELECTIONS" | "TOO_FEW_HEALTHY_MEMBERS" | "TOO_MANY_UNHEALTHY_MEMBERS";
|
|
3443
4610
|
/**
|
|
3444
4611
|
* Replication Specifications
|
|
3445
4612
|
* @description Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.
|
|
@@ -3571,7 +4738,7 @@ export interface components {
|
|
|
3571
4738
|
SearchIndexDefinitionVersion: {
|
|
3572
4739
|
/**
|
|
3573
4740
|
* Format: date-time
|
|
3574
|
-
* @description The time at which this index definition was created.
|
|
4741
|
+
* @description The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
3575
4742
|
*/
|
|
3576
4743
|
createdAt?: string;
|
|
3577
4744
|
/**
|
|
@@ -3731,6 +4898,100 @@ export interface components {
|
|
|
3731
4898
|
*/
|
|
3732
4899
|
providerName: "AWS" | "AZURE";
|
|
3733
4900
|
};
|
|
4901
|
+
/**
|
|
4902
|
+
* Stream Processor Alerts
|
|
4903
|
+
* @description Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.
|
|
4904
|
+
*/
|
|
4905
|
+
StreamProcessorAlertViewForNdsGroup: {
|
|
4906
|
+
/**
|
|
4907
|
+
* Format: date-time
|
|
4908
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
4909
|
+
*
|
|
4910
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
4911
|
+
*
|
|
4912
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
4913
|
+
*/
|
|
4914
|
+
acknowledgedUntil?: string;
|
|
4915
|
+
/**
|
|
4916
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
4917
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
4918
|
+
*/
|
|
4919
|
+
acknowledgementComment?: string;
|
|
4920
|
+
/**
|
|
4921
|
+
* Format: email
|
|
4922
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
4923
|
+
*/
|
|
4924
|
+
readonly acknowledgingUsername?: string;
|
|
4925
|
+
/**
|
|
4926
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
4927
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4928
|
+
*/
|
|
4929
|
+
readonly alertConfigId: string;
|
|
4930
|
+
/**
|
|
4931
|
+
* Format: date-time
|
|
4932
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
4933
|
+
*/
|
|
4934
|
+
readonly created: string;
|
|
4935
|
+
eventTypeName: components["schemas"]["HostEventTypeViewForNdsGroupAlertable"];
|
|
4936
|
+
/**
|
|
4937
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
4938
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4939
|
+
*/
|
|
4940
|
+
readonly groupId?: string;
|
|
4941
|
+
/**
|
|
4942
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
4943
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4944
|
+
*/
|
|
4945
|
+
readonly id: string;
|
|
4946
|
+
/**
|
|
4947
|
+
* @description The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.
|
|
4948
|
+
* @example foobar
|
|
4949
|
+
*/
|
|
4950
|
+
readonly instanceName?: string;
|
|
4951
|
+
/**
|
|
4952
|
+
* Format: date-time
|
|
4953
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
4954
|
+
*/
|
|
4955
|
+
readonly lastNotified?: string;
|
|
4956
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
4957
|
+
readonly links?: components["schemas"]["Link"][];
|
|
4958
|
+
/**
|
|
4959
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
4960
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
4961
|
+
*/
|
|
4962
|
+
readonly orgId?: string;
|
|
4963
|
+
/**
|
|
4964
|
+
* @description The error message associated with the Stream Processor to which this alert applies.
|
|
4965
|
+
* @example MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)
|
|
4966
|
+
*/
|
|
4967
|
+
readonly processorErrorMsg?: string;
|
|
4968
|
+
/**
|
|
4969
|
+
* @description The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.
|
|
4970
|
+
* @example foobar
|
|
4971
|
+
*/
|
|
4972
|
+
readonly processorName?: string;
|
|
4973
|
+
/**
|
|
4974
|
+
* @description The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.
|
|
4975
|
+
* @example STARTED
|
|
4976
|
+
*/
|
|
4977
|
+
readonly processorState?: string;
|
|
4978
|
+
/**
|
|
4979
|
+
* Format: date-time
|
|
4980
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
4981
|
+
*/
|
|
4982
|
+
readonly resolved?: string;
|
|
4983
|
+
/**
|
|
4984
|
+
* @description State of this alert at the time you requested its details.
|
|
4985
|
+
* @example OPEN
|
|
4986
|
+
* @enum {string}
|
|
4987
|
+
*/
|
|
4988
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
4989
|
+
/**
|
|
4990
|
+
* Format: date-time
|
|
4991
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
4992
|
+
*/
|
|
4993
|
+
readonly updated: string;
|
|
4994
|
+
};
|
|
3734
4995
|
/** @description AWS configurations for AWS-based connection types. */
|
|
3735
4996
|
StreamsAWSConnectionConfig: {
|
|
3736
4997
|
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
@@ -3871,12 +5132,16 @@ export interface components {
|
|
|
3871
5132
|
readonly links?: components["schemas"]["Link"][];
|
|
3872
5133
|
/** @description Reserved. Will be used by PRIVATE_LINK connection type. */
|
|
3873
5134
|
name?: string;
|
|
5135
|
+
/** @description Reserved. Will be used by TRANSIT_GATEWAY connection type. */
|
|
5136
|
+
tgwId?: string;
|
|
3874
5137
|
/**
|
|
3875
5138
|
* Networking Access Type
|
|
3876
|
-
* @description Selected networking type. Either PUBLIC, VPC or
|
|
5139
|
+
* @description Selected networking type. Either PUBLIC, VPC, PRIVATE_LINK, or TRANSIT_GATEWAY. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. TRANSIT_GATEWAY support is coming soon.
|
|
3877
5140
|
* @enum {string}
|
|
3878
5141
|
*/
|
|
3879
|
-
type?: "PUBLIC" | "VPC" | "PRIVATE_LINK";
|
|
5142
|
+
type?: "PUBLIC" | "VPC" | "PRIVATE_LINK" | "TRANSIT_GATEWAY";
|
|
5143
|
+
/** @description Reserved. Will be used by TRANSIT_GATEWAY connection type. */
|
|
5144
|
+
vpcCIDR?: string;
|
|
3880
5145
|
};
|
|
3881
5146
|
/** @description Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. */
|
|
3882
5147
|
StreamsKafkaSecurity: {
|
|
@@ -4107,61 +5372,175 @@ export interface components {
|
|
|
4107
5372
|
* ]
|
|
4108
5373
|
* }
|
|
4109
5374
|
*/
|
|
4110
|
-
storedSource?: Record<string, never>;
|
|
4111
|
-
/** @description Rule sets that map words to their synonyms in this index. */
|
|
4112
|
-
synonyms?: components["schemas"]["SearchSynonymMappingDefinition"][];
|
|
4113
|
-
};
|
|
4114
|
-
/** Text Search Index Response */
|
|
4115
|
-
TextSearchIndexResponse: Omit<components["schemas"]["SearchIndexResponse"], "type"> & {
|
|
4116
|
-
latestDefinition?: components["schemas"]["TextSearchIndexDefinition"];
|
|
4117
|
-
/** @description List of documents detailing index status on each host. */
|
|
4118
|
-
statusDetail?: components["schemas"]["TextSearchHostStatusDetail"][];
|
|
5375
|
+
storedSource?: Record<string, never>;
|
|
5376
|
+
/** @description Rule sets that map words to their synonyms in this index. */
|
|
5377
|
+
synonyms?: components["schemas"]["SearchSynonymMappingDefinition"][];
|
|
5378
|
+
};
|
|
5379
|
+
/** Text Search Index Response */
|
|
5380
|
+
TextSearchIndexResponse: Omit<components["schemas"]["SearchIndexResponse"], "type"> & {
|
|
5381
|
+
latestDefinition?: components["schemas"]["TextSearchIndexDefinition"];
|
|
5382
|
+
/** @description List of documents detailing index status on each host. */
|
|
5383
|
+
statusDetail?: components["schemas"]["TextSearchHostStatusDetail"][];
|
|
5384
|
+
/**
|
|
5385
|
+
* @description Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.
|
|
5386
|
+
* @enum {string}
|
|
5387
|
+
*/
|
|
5388
|
+
synonymMappingStatus?: "FAILED" | "BUILDING" | "READY";
|
|
5389
|
+
/** @description A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined. */
|
|
5390
|
+
synonymMappingStatusDetail?: {
|
|
5391
|
+
[key: string]: components["schemas"]["SynonymMappingStatusDetail"];
|
|
5392
|
+
}[];
|
|
5393
|
+
} & {
|
|
5394
|
+
/**
|
|
5395
|
+
* @description discriminator enum property added by openapi-typescript
|
|
5396
|
+
* @enum {string}
|
|
5397
|
+
*/
|
|
5398
|
+
type: "search";
|
|
5399
|
+
};
|
|
5400
|
+
/**
|
|
5401
|
+
* Text Search Index Status Detail
|
|
5402
|
+
* @description Contains status information about a text search index.
|
|
5403
|
+
*/
|
|
5404
|
+
TextSearchIndexStatusDetail: {
|
|
5405
|
+
definition?: components["schemas"]["TextSearchIndexDefinition"];
|
|
5406
|
+
definitionVersion?: components["schemas"]["SearchIndexDefinitionVersion"];
|
|
5407
|
+
/** @description Optional message describing an error. */
|
|
5408
|
+
message?: string;
|
|
5409
|
+
/** @description Flag that indicates whether the index generation is queryable on the host. */
|
|
5410
|
+
queryable?: boolean;
|
|
5411
|
+
/**
|
|
5412
|
+
* @description Condition of the search index when you made this request.
|
|
5413
|
+
*
|
|
5414
|
+
* - `DELETING`: The index is being deleted.
|
|
5415
|
+
* - `FAILED` The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
|
|
5416
|
+
* - `STALE`: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
|
|
5417
|
+
* - `PENDING`: Atlas has not yet started building the index.
|
|
5418
|
+
* - `BUILDING`: Atlas is building or re-building the index after an edit.
|
|
5419
|
+
* - `READY`: The index is ready and can support queries.
|
|
5420
|
+
* @enum {string}
|
|
5421
|
+
*/
|
|
5422
|
+
status?: "DELETING" | "FAILED" | "STALE" | "PENDING" | "BUILDING" | "READY" | "DOES_NOT_EXIST";
|
|
5423
|
+
/**
|
|
5424
|
+
* @description Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.
|
|
5425
|
+
* @enum {string}
|
|
5426
|
+
*/
|
|
5427
|
+
synonymMappingStatus?: "FAILED" | "BUILDING" | "READY";
|
|
5428
|
+
/** @description List of synonym statuses by mapping. */
|
|
5429
|
+
synonymMappingStatusDetail?: components["schemas"]["SynonymMappingStatusDetailMap"][];
|
|
5430
|
+
};
|
|
5431
|
+
TimeMetricAlertView: {
|
|
5432
|
+
/**
|
|
5433
|
+
* Format: date-time
|
|
5434
|
+
* @description Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
|
5435
|
+
*
|
|
5436
|
+
* - To acknowledge this alert forever, set the parameter value to 100 years in the future.
|
|
5437
|
+
*
|
|
5438
|
+
* - To unacknowledge a previously acknowledged alert, do not set this parameter value.
|
|
5439
|
+
*/
|
|
5440
|
+
acknowledgedUntil?: string;
|
|
5441
|
+
/**
|
|
5442
|
+
* @description Comment that a MongoDB Cloud user submitted when acknowledging the alert.
|
|
5443
|
+
* @example Expiration on 3/19. Silencing for 7days.
|
|
5444
|
+
*/
|
|
5445
|
+
acknowledgementComment?: string;
|
|
5446
|
+
/**
|
|
5447
|
+
* Format: email
|
|
5448
|
+
* @description MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
|
|
5449
|
+
*/
|
|
5450
|
+
readonly acknowledgingUsername?: string;
|
|
5451
|
+
/**
|
|
5452
|
+
* @description Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
|
|
5453
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
5454
|
+
*/
|
|
5455
|
+
readonly alertConfigId: string;
|
|
5456
|
+
/**
|
|
5457
|
+
* @description Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
|
|
5458
|
+
* @example cluster1
|
|
5459
|
+
*/
|
|
5460
|
+
readonly clusterName?: string;
|
|
5461
|
+
/**
|
|
5462
|
+
* Format: date-time
|
|
5463
|
+
* @description Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
5464
|
+
*/
|
|
5465
|
+
readonly created: string;
|
|
5466
|
+
currentValue?: components["schemas"]["TimeMetricValueView"];
|
|
5467
|
+
eventTypeName: components["schemas"]["HostMetricEventTypeViewAlertable"];
|
|
5468
|
+
/**
|
|
5469
|
+
* @description Unique 24-hexadecimal digit string that identifies the project that owns this alert.
|
|
5470
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
5471
|
+
*/
|
|
5472
|
+
readonly groupId?: string;
|
|
5473
|
+
/**
|
|
5474
|
+
* @description Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
|
|
5475
|
+
* @example cloud-test.mongodb.com:27017
|
|
5476
|
+
*/
|
|
5477
|
+
readonly hostnameAndPort?: string;
|
|
5478
|
+
/**
|
|
5479
|
+
* @description Unique 24-hexadecimal digit string that identifies this alert.
|
|
5480
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
5481
|
+
*/
|
|
5482
|
+
readonly id: string;
|
|
5483
|
+
/**
|
|
5484
|
+
* Format: date-time
|
|
5485
|
+
* @description Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
|
|
5486
|
+
*/
|
|
5487
|
+
readonly lastNotified?: string;
|
|
5488
|
+
/** @description List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. */
|
|
5489
|
+
readonly links?: components["schemas"]["Link"][];
|
|
5490
|
+
/**
|
|
5491
|
+
* @description Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.
|
|
5492
|
+
*
|
|
5493
|
+
* To learn more about the available metrics, see <a href="https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types" target="_blank">Host Metrics</a>.
|
|
5494
|
+
*
|
|
5495
|
+
* **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href="https://dochub.mongodb.org/core/alert-config-serverless-measurements" target="_blank">Serverless Measurements</a>.
|
|
5496
|
+
* @example ASSERT_USER
|
|
5497
|
+
*/
|
|
5498
|
+
readonly metricName?: string;
|
|
5499
|
+
/**
|
|
5500
|
+
* @description Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
|
|
5501
|
+
* @example 32b6e34b3d91647abb20e7b8
|
|
5502
|
+
*/
|
|
5503
|
+
readonly orgId?: string;
|
|
5504
|
+
/**
|
|
5505
|
+
* @description Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
|
|
5506
|
+
* @example event-replica-set
|
|
5507
|
+
*/
|
|
5508
|
+
readonly replicaSetName?: string;
|
|
4119
5509
|
/**
|
|
4120
|
-
*
|
|
4121
|
-
* @
|
|
5510
|
+
* Format: date-time
|
|
5511
|
+
* @description Date and time that this alert changed to `"status" : "CLOSED"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `"status" : "CLOSED"`.
|
|
4122
5512
|
*/
|
|
4123
|
-
|
|
4124
|
-
/** @description A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined. */
|
|
4125
|
-
synonymMappingStatusDetail?: {
|
|
4126
|
-
[key: string]: components["schemas"]["SynonymMappingStatusDetail"];
|
|
4127
|
-
}[];
|
|
4128
|
-
} & {
|
|
5513
|
+
readonly resolved?: string;
|
|
4129
5514
|
/**
|
|
4130
|
-
* @description
|
|
5515
|
+
* @description State of this alert at the time you requested its details.
|
|
5516
|
+
* @example OPEN
|
|
4131
5517
|
* @enum {string}
|
|
4132
5518
|
*/
|
|
4133
|
-
|
|
5519
|
+
readonly status: "CANCELLED" | "CLOSED" | "OPEN" | "TRACKING";
|
|
5520
|
+
/**
|
|
5521
|
+
* Format: date-time
|
|
5522
|
+
* @description Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
|
|
5523
|
+
*/
|
|
5524
|
+
readonly updated: string;
|
|
4134
5525
|
};
|
|
4135
5526
|
/**
|
|
4136
|
-
*
|
|
4137
|
-
* @description
|
|
5527
|
+
* Time Metric Units
|
|
5528
|
+
* @description Element used to express the quantity. This can be an element of time, storage capacity, and the like.
|
|
5529
|
+
* @default HOURS
|
|
5530
|
+
* @enum {string}
|
|
4138
5531
|
*/
|
|
4139
|
-
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
|
-
|
|
4143
|
-
|
|
4144
|
-
|
|
4145
|
-
queryable?: boolean;
|
|
4146
|
-
/**
|
|
4147
|
-
* @description Condition of the search index when you made this request.
|
|
4148
|
-
*
|
|
4149
|
-
* - `DELETING`: The index is being deleted.
|
|
4150
|
-
* - `FAILED` The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
|
|
4151
|
-
* - `STALE`: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
|
|
4152
|
-
* - `PENDING`: Atlas has not yet started building the index.
|
|
4153
|
-
* - `BUILDING`: Atlas is building or re-building the index after an edit.
|
|
4154
|
-
* - `READY`: The index is ready and can support queries.
|
|
4155
|
-
* @enum {string}
|
|
4156
|
-
*/
|
|
4157
|
-
status?: "DELETING" | "FAILED" | "STALE" | "PENDING" | "BUILDING" | "READY" | "DOES_NOT_EXIST";
|
|
5532
|
+
TimeMetricUnits: "NANOSECONDS" | "MILLISECONDS" | "MILLION_MINUTES" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS";
|
|
5533
|
+
/**
|
|
5534
|
+
* Time Metric Value
|
|
5535
|
+
* @description Measurement of the **metricName** recorded at the time of the event.
|
|
5536
|
+
*/
|
|
5537
|
+
TimeMetricValueView: {
|
|
4158
5538
|
/**
|
|
4159
|
-
*
|
|
4160
|
-
* @
|
|
5539
|
+
* Format: double
|
|
5540
|
+
* @description Amount of the **metricName** recorded at the time of the event. This value triggered the alert.
|
|
4161
5541
|
*/
|
|
4162
|
-
|
|
4163
|
-
|
|
4164
|
-
synonymMappingStatusDetail?: components["schemas"]["SynonymMappingStatusDetailMap"][];
|
|
5542
|
+
readonly number?: number;
|
|
5543
|
+
units?: components["schemas"]["TimeMetricUnits"];
|
|
4165
5544
|
};
|
|
4166
5545
|
/**
|
|
4167
5546
|
* englishPossessive
|
|
@@ -4954,11 +6333,14 @@ export type AwsRegionConfig = components['schemas']['AWSRegionConfig'];
|
|
|
4954
6333
|
export type AwsRegionConfig20240805 = components['schemas']['AWSRegionConfig20240805'];
|
|
4955
6334
|
export type AdvancedAutoScalingSettings = components['schemas']['AdvancedAutoScalingSettings'];
|
|
4956
6335
|
export type AdvancedComputeAutoScaling = components['schemas']['AdvancedComputeAutoScaling'];
|
|
6336
|
+
export type AlertViewForNdsGroup = components['schemas']['AlertViewForNdsGroup'];
|
|
4957
6337
|
export type ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView = components['schemas']['ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView'];
|
|
4958
6338
|
export type ApiAtlasClusterAdvancedConfigurationView = components['schemas']['ApiAtlasClusterAdvancedConfigurationView'];
|
|
4959
6339
|
export type ApiAtlasFtsAnalyzersViewManual = components['schemas']['ApiAtlasFTSAnalyzersViewManual'];
|
|
4960
6340
|
export type ApiAtlasFtsMappingsViewManual = components['schemas']['ApiAtlasFTSMappingsViewManual'];
|
|
4961
6341
|
export type ApiError = components['schemas']['ApiError'];
|
|
6342
|
+
export type AppServiceAlertView = components['schemas']['AppServiceAlertView'];
|
|
6343
|
+
export type AppServiceEventTypeViewAlertable = components['schemas']['AppServiceEventTypeViewAlertable'];
|
|
4962
6344
|
export type AtlasOrganization = components['schemas']['AtlasOrganization'];
|
|
4963
6345
|
export type AtlasSearchAnalyzer = components['schemas']['AtlasSearchAnalyzer'];
|
|
4964
6346
|
export type AzureCloudProviderContainer = components['schemas']['AzureCloudProviderContainer'];
|
|
@@ -5003,10 +6385,12 @@ export type CloudProviderContainer = components['schemas']['CloudProviderContain
|
|
|
5003
6385
|
export type CloudProviderGcpAutoScaling = components['schemas']['CloudProviderGCPAutoScaling'];
|
|
5004
6386
|
export type CloudRegionConfig = components['schemas']['CloudRegionConfig'];
|
|
5005
6387
|
export type CloudRegionConfig20240805 = components['schemas']['CloudRegionConfig20240805'];
|
|
6388
|
+
export type ClusterAlertView = components['schemas']['ClusterAlertView'];
|
|
5006
6389
|
export type ClusterConnectionStrings = components['schemas']['ClusterConnectionStrings'];
|
|
5007
6390
|
export type ClusterDescription20240805 = components['schemas']['ClusterDescription20240805'];
|
|
5008
6391
|
export type ClusterDescriptionConnectionStringsPrivateEndpoint = components['schemas']['ClusterDescriptionConnectionStringsPrivateEndpoint'];
|
|
5009
6392
|
export type ClusterDescriptionConnectionStringsPrivateEndpointEndpoint = components['schemas']['ClusterDescriptionConnectionStringsPrivateEndpointEndpoint'];
|
|
6393
|
+
export type ClusterEventTypeViewAlertable = components['schemas']['ClusterEventTypeViewAlertable'];
|
|
5010
6394
|
export type ClusterFlexProviderSettings = components['schemas']['ClusterFlexProviderSettings'];
|
|
5011
6395
|
export type ClusterFreeAutoScaling = components['schemas']['ClusterFreeAutoScaling'];
|
|
5012
6396
|
export type ClusterFreeProviderSettings = components['schemas']['ClusterFreeProviderSettings'];
|
|
@@ -5037,11 +6421,15 @@ export type DataLakeHttpStore = components['schemas']['DataLakeHTTPStore'];
|
|
|
5037
6421
|
export type DataLakePipelinesPartitionField = components['schemas']['DataLakePipelinesPartitionField'];
|
|
5038
6422
|
export type DataLakeS3StoreSettings = components['schemas']['DataLakeS3StoreSettings'];
|
|
5039
6423
|
export type DataLakeStoreSettings = components['schemas']['DataLakeStoreSettings'];
|
|
6424
|
+
export type DataMetricAlertView = components['schemas']['DataMetricAlertView'];
|
|
6425
|
+
export type DataMetricUnits = components['schemas']['DataMetricUnits'];
|
|
6426
|
+
export type DataMetricValueView = components['schemas']['DataMetricValueView'];
|
|
5040
6427
|
export type DataProcessRegionView = components['schemas']['DataProcessRegionView'];
|
|
5041
6428
|
export type DatabaseUserRole = components['schemas']['DatabaseUserRole'];
|
|
5042
6429
|
export type DateCriteriaView = components['schemas']['DateCriteriaView'];
|
|
5043
6430
|
export type DedicatedHardwareSpec = components['schemas']['DedicatedHardwareSpec'];
|
|
5044
6431
|
export type DedicatedHardwareSpec20240805 = components['schemas']['DedicatedHardwareSpec20240805'];
|
|
6432
|
+
export type DefaultAlertViewForNdsGroup = components['schemas']['DefaultAlertViewForNdsGroup'];
|
|
5045
6433
|
export type DefaultScheduleView = components['schemas']['DefaultScheduleView'];
|
|
5046
6434
|
export type DiskBackupSnapshotAwsExportBucketRequest = components['schemas']['DiskBackupSnapshotAWSExportBucketRequest'];
|
|
5047
6435
|
export type DiskBackupSnapshotAwsExportBucketResponse = components['schemas']['DiskBackupSnapshotAWSExportBucketResponse'];
|
|
@@ -5049,10 +6437,18 @@ export type DiskBackupSnapshotAzureExportBucketRequest = components['schemas']['
|
|
|
5049
6437
|
export type DiskBackupSnapshotAzureExportBucketResponse = components['schemas']['DiskBackupSnapshotAzureExportBucketResponse'];
|
|
5050
6438
|
export type DiskBackupSnapshotExportBucketRequest = components['schemas']['DiskBackupSnapshotExportBucketRequest'];
|
|
5051
6439
|
export type DiskBackupSnapshotExportBucketResponse = components['schemas']['DiskBackupSnapshotExportBucketResponse'];
|
|
6440
|
+
export type DiskBackupSnapshotGcpExportBucketRequest = components['schemas']['DiskBackupSnapshotGCPExportBucketRequest'];
|
|
6441
|
+
export type DiskBackupSnapshotGcpExportBucketResponse = components['schemas']['DiskBackupSnapshotGCPExportBucketResponse'];
|
|
5052
6442
|
export type DiskGbAutoScaling = components['schemas']['DiskGBAutoScaling'];
|
|
5053
6443
|
export type EmployeeAccessGrantView = components['schemas']['EmployeeAccessGrantView'];
|
|
5054
6444
|
export type FieldViolation = components['schemas']['FieldViolation'];
|
|
5055
6445
|
export type Fields = components['schemas']['Fields'];
|
|
6446
|
+
export type FlexBackupSettings20241113 = components['schemas']['FlexBackupSettings20241113'];
|
|
6447
|
+
export type FlexClusterDescription20241113 = components['schemas']['FlexClusterDescription20241113'];
|
|
6448
|
+
export type FlexClusterDescriptionCreate20241113 = components['schemas']['FlexClusterDescriptionCreate20241113'];
|
|
6449
|
+
export type FlexConnectionStrings20241113 = components['schemas']['FlexConnectionStrings20241113'];
|
|
6450
|
+
export type FlexProviderSettings20241113 = components['schemas']['FlexProviderSettings20241113'];
|
|
6451
|
+
export type FlexProviderSettingsCreate20241113 = components['schemas']['FlexProviderSettingsCreate20241113'];
|
|
5056
6452
|
export type FreeComputeAutoScalingRules = components['schemas']['FreeComputeAutoScalingRules'];
|
|
5057
6453
|
export type GcpCloudProviderContainer = components['schemas']['GCPCloudProviderContainer'];
|
|
5058
6454
|
export type GcpComputeAutoScaling = components['schemas']['GCPComputeAutoScaling'];
|
|
@@ -5069,12 +6465,20 @@ export type GroupRoleAssignment = components['schemas']['GroupRoleAssignment'];
|
|
|
5069
6465
|
export type GroupUserResponse = components['schemas']['GroupUserResponse'];
|
|
5070
6466
|
export type HardwareSpec = components['schemas']['HardwareSpec'];
|
|
5071
6467
|
export type HardwareSpec20240805 = components['schemas']['HardwareSpec20240805'];
|
|
6468
|
+
export type HostAlertViewForNdsGroup = components['schemas']['HostAlertViewForNdsGroup'];
|
|
6469
|
+
export type HostEventTypeViewForNdsGroupAlertable = components['schemas']['HostEventTypeViewForNdsGroupAlertable'];
|
|
6470
|
+
export type HostMetricAlert = components['schemas']['HostMetricAlert'];
|
|
6471
|
+
export type HostMetricEventTypeViewAlertable = components['schemas']['HostMetricEventTypeViewAlertable'];
|
|
6472
|
+
export type HostMetricValue = components['schemas']['HostMetricValue'];
|
|
5072
6473
|
export type IngestionSink = components['schemas']['IngestionSink'];
|
|
5073
6474
|
export type IngestionSource = components['schemas']['IngestionSource'];
|
|
5074
6475
|
export type InvoiceLineItem = components['schemas']['InvoiceLineItem'];
|
|
5075
6476
|
export type Link = components['schemas']['Link'];
|
|
5076
6477
|
export type MonthlyScheduleView = components['schemas']['MonthlyScheduleView'];
|
|
5077
6478
|
export type NetworkPermissionEntry = components['schemas']['NetworkPermissionEntry'];
|
|
6479
|
+
export type NumberMetricAlertView = components['schemas']['NumberMetricAlertView'];
|
|
6480
|
+
export type NumberMetricUnits = components['schemas']['NumberMetricUnits'];
|
|
6481
|
+
export type NumberMetricValueView = components['schemas']['NumberMetricValueView'];
|
|
5078
6482
|
export type OnDemandCpsSnapshotSource = components['schemas']['OnDemandCpsSnapshotSource'];
|
|
5079
6483
|
export type OnlineArchiveSchedule = components['schemas']['OnlineArchiveSchedule'];
|
|
5080
6484
|
export type OrgActiveUserResponse = components['schemas']['OrgActiveUserResponse'];
|
|
@@ -5082,13 +6486,20 @@ export type OrgGroup = components['schemas']['OrgGroup'];
|
|
|
5082
6486
|
export type OrgPendingUserResponse = components['schemas']['OrgPendingUserResponse'];
|
|
5083
6487
|
export type OrgUserResponse = components['schemas']['OrgUserResponse'];
|
|
5084
6488
|
export type OrgUserRolesResponse = components['schemas']['OrgUserRolesResponse'];
|
|
6489
|
+
export type PaginatedAlertView = components['schemas']['PaginatedAlertView'];
|
|
5085
6490
|
export type PaginatedApiAtlasDatabaseUserView = components['schemas']['PaginatedApiAtlasDatabaseUserView'];
|
|
5086
6491
|
export type PaginatedAtlasGroupView = components['schemas']['PaginatedAtlasGroupView'];
|
|
5087
6492
|
export type PaginatedClusterDescription20240805 = components['schemas']['PaginatedClusterDescription20240805'];
|
|
6493
|
+
export type PaginatedFlexClusters20241113 = components['schemas']['PaginatedFlexClusters20241113'];
|
|
5088
6494
|
export type PaginatedNetworkAccessView = components['schemas']['PaginatedNetworkAccessView'];
|
|
5089
6495
|
export type PaginatedOrgGroupView = components['schemas']['PaginatedOrgGroupView'];
|
|
5090
6496
|
export type PaginatedOrganizationView = components['schemas']['PaginatedOrganizationView'];
|
|
5091
6497
|
export type PeriodicCpsSnapshotSource = components['schemas']['PeriodicCpsSnapshotSource'];
|
|
6498
|
+
export type RawMetricAlertView = components['schemas']['RawMetricAlertView'];
|
|
6499
|
+
export type RawMetricUnits = components['schemas']['RawMetricUnits'];
|
|
6500
|
+
export type RawMetricValueView = components['schemas']['RawMetricValueView'];
|
|
6501
|
+
export type ReplicaSetAlertViewForNdsGroup = components['schemas']['ReplicaSetAlertViewForNdsGroup'];
|
|
6502
|
+
export type ReplicaSetEventTypeViewForNdsGroupAlertable = components['schemas']['ReplicaSetEventTypeViewForNdsGroupAlertable'];
|
|
5092
6503
|
export type ReplicationSpec20240805 = components['schemas']['ReplicationSpec20240805'];
|
|
5093
6504
|
export type ResourceTag = components['schemas']['ResourceTag'];
|
|
5094
6505
|
export type SearchHostStatusDetail = components['schemas']['SearchHostStatusDetail'];
|
|
@@ -5104,6 +6515,7 @@ export type SearchSynonymMappingDefinition = components['schemas']['SearchSynony
|
|
|
5104
6515
|
export type ServerlessAwsTenantEndpointUpdate = components['schemas']['ServerlessAWSTenantEndpointUpdate'];
|
|
5105
6516
|
export type ServerlessAzureTenantEndpointUpdate = components['schemas']['ServerlessAzureTenantEndpointUpdate'];
|
|
5106
6517
|
export type ServerlessTenantEndpointUpdate = components['schemas']['ServerlessTenantEndpointUpdate'];
|
|
6518
|
+
export type StreamProcessorAlertViewForNdsGroup = components['schemas']['StreamProcessorAlertViewForNdsGroup'];
|
|
5107
6519
|
export type StreamsAwsConnectionConfig = components['schemas']['StreamsAWSConnectionConfig'];
|
|
5108
6520
|
export type StreamsAwsLambdaConnection = components['schemas']['StreamsAWSLambdaConnection'];
|
|
5109
6521
|
export type StreamsClusterConnection = components['schemas']['StreamsClusterConnection'];
|
|
@@ -5128,6 +6540,9 @@ export type TextSearchIndexCreateRequest = components['schemas']['TextSearchInde
|
|
|
5128
6540
|
export type TextSearchIndexDefinition = components['schemas']['TextSearchIndexDefinition'];
|
|
5129
6541
|
export type TextSearchIndexResponse = components['schemas']['TextSearchIndexResponse'];
|
|
5130
6542
|
export type TextSearchIndexStatusDetail = components['schemas']['TextSearchIndexStatusDetail'];
|
|
6543
|
+
export type TimeMetricAlertView = components['schemas']['TimeMetricAlertView'];
|
|
6544
|
+
export type TimeMetricUnits = components['schemas']['TimeMetricUnits'];
|
|
6545
|
+
export type TimeMetricValueView = components['schemas']['TimeMetricValueView'];
|
|
5131
6546
|
export type TokenFilterEnglishPossessive = components['schemas']['TokenFilterEnglishPossessive'];
|
|
5132
6547
|
export type TokenFilterFlattenGraph = components['schemas']['TokenFilterFlattenGraph'];
|
|
5133
6548
|
export type TokenFilterPorterStemming = components['schemas']['TokenFilterPorterStemming'];
|
|
@@ -5215,6 +6630,7 @@ export interface operations {
|
|
|
5215
6630
|
};
|
|
5216
6631
|
};
|
|
5217
6632
|
401: components["responses"]["unauthorized"];
|
|
6633
|
+
403: components["responses"]["forbidden"];
|
|
5218
6634
|
500: components["responses"]["internalServerError"];
|
|
5219
6635
|
};
|
|
5220
6636
|
};
|
|
@@ -5248,6 +6664,8 @@ export interface operations {
|
|
|
5248
6664
|
};
|
|
5249
6665
|
};
|
|
5250
6666
|
400: components["responses"]["badRequest"];
|
|
6667
|
+
401: components["responses"]["unauthorized"];
|
|
6668
|
+
403: components["responses"]["forbidden"];
|
|
5251
6669
|
404: components["responses"]["notFound"];
|
|
5252
6670
|
500: components["responses"]["internalServerError"];
|
|
5253
6671
|
};
|
|
@@ -5319,6 +6737,8 @@ export interface operations {
|
|
|
5319
6737
|
};
|
|
5320
6738
|
};
|
|
5321
6739
|
400: components["responses"]["badRequest"];
|
|
6740
|
+
401: components["responses"]["unauthorized"];
|
|
6741
|
+
403: components["responses"]["forbidden"];
|
|
5322
6742
|
404: components["responses"]["notFound"];
|
|
5323
6743
|
500: components["responses"]["internalServerError"];
|
|
5324
6744
|
};
|
|
@@ -5352,6 +6772,8 @@ export interface operations {
|
|
|
5352
6772
|
};
|
|
5353
6773
|
};
|
|
5354
6774
|
400: components["responses"]["badRequest"];
|
|
6775
|
+
401: components["responses"]["unauthorized"];
|
|
6776
|
+
403: components["responses"]["forbidden"];
|
|
5355
6777
|
404: components["responses"]["notFound"];
|
|
5356
6778
|
409: components["responses"]["conflict"];
|
|
5357
6779
|
500: components["responses"]["internalServerError"];
|
|
@@ -5392,6 +6814,8 @@ export interface operations {
|
|
|
5392
6814
|
};
|
|
5393
6815
|
};
|
|
5394
6816
|
401: components["responses"]["unauthorized"];
|
|
6817
|
+
403: components["responses"]["forbidden"];
|
|
6818
|
+
404: components["responses"]["notFound"];
|
|
5395
6819
|
500: components["responses"]["internalServerError"];
|
|
5396
6820
|
};
|
|
5397
6821
|
};
|
|
@@ -5437,6 +6861,7 @@ export interface operations {
|
|
|
5437
6861
|
400: components["responses"]["badRequest"];
|
|
5438
6862
|
401: components["responses"]["unauthorized"];
|
|
5439
6863
|
403: components["responses"]["forbidden"];
|
|
6864
|
+
404: components["responses"]["notFound"];
|
|
5440
6865
|
500: components["responses"]["internalServerError"];
|
|
5441
6866
|
};
|
|
5442
6867
|
};
|
|
@@ -5474,6 +6899,50 @@ export interface operations {
|
|
|
5474
6899
|
"application/vnd.atlas.2023-01-01+json": unknown;
|
|
5475
6900
|
};
|
|
5476
6901
|
};
|
|
6902
|
+
401: components["responses"]["unauthorized"];
|
|
6903
|
+
403: components["responses"]["forbidden"];
|
|
6904
|
+
404: components["responses"]["notFound"];
|
|
6905
|
+
500: components["responses"]["internalServerError"];
|
|
6906
|
+
};
|
|
6907
|
+
};
|
|
6908
|
+
listAlerts: {
|
|
6909
|
+
parameters: {
|
|
6910
|
+
query?: {
|
|
6911
|
+
/** @description Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. */
|
|
6912
|
+
envelope?: components["parameters"]["envelope"];
|
|
6913
|
+
/** @description Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. */
|
|
6914
|
+
includeCount?: components["parameters"]["includeCount"];
|
|
6915
|
+
/** @description Number of items that the response returns per page. */
|
|
6916
|
+
itemsPerPage?: components["parameters"]["itemsPerPage"];
|
|
6917
|
+
/** @description Number of the page that displays the current set of the total objects that the response returns. */
|
|
6918
|
+
pageNum?: components["parameters"]["pageNum"];
|
|
6919
|
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
|
|
6920
|
+
pretty?: components["parameters"]["pretty"];
|
|
6921
|
+
/** @description Status of the alerts to return. Omit to return all alerts in all statuses. */
|
|
6922
|
+
status?: "OPEN" | "TRACKING" | "CLOSED";
|
|
6923
|
+
};
|
|
6924
|
+
header?: never;
|
|
6925
|
+
path: {
|
|
6926
|
+
/** @description Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
|
|
6927
|
+
*
|
|
6928
|
+
* **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. */
|
|
6929
|
+
groupId: components["parameters"]["groupId"];
|
|
6930
|
+
};
|
|
6931
|
+
cookie?: never;
|
|
6932
|
+
};
|
|
6933
|
+
requestBody?: never;
|
|
6934
|
+
responses: {
|
|
6935
|
+
/** @description OK */
|
|
6936
|
+
200: {
|
|
6937
|
+
headers: {
|
|
6938
|
+
[name: string]: unknown;
|
|
6939
|
+
};
|
|
6940
|
+
content: {
|
|
6941
|
+
"application/vnd.atlas.2023-01-01+json": components["schemas"]["PaginatedAlertView"];
|
|
6942
|
+
};
|
|
6943
|
+
};
|
|
6944
|
+
400: components["responses"]["badRequest"];
|
|
6945
|
+
401: components["responses"]["unauthorized"];
|
|
5477
6946
|
403: components["responses"]["forbidden"];
|
|
5478
6947
|
404: components["responses"]["notFound"];
|
|
5479
6948
|
500: components["responses"]["internalServerError"];
|
|
@@ -5516,6 +6985,8 @@ export interface operations {
|
|
|
5516
6985
|
};
|
|
5517
6986
|
};
|
|
5518
6987
|
401: components["responses"]["unauthorized"];
|
|
6988
|
+
403: components["responses"]["forbidden"];
|
|
6989
|
+
404: components["responses"]["notFound"];
|
|
5519
6990
|
500: components["responses"]["internalServerError"];
|
|
5520
6991
|
};
|
|
5521
6992
|
};
|
|
@@ -5556,6 +7027,7 @@ export interface operations {
|
|
|
5556
7027
|
401: components["responses"]["unauthorized"];
|
|
5557
7028
|
402: components["responses"]["paymentRequired"];
|
|
5558
7029
|
403: components["responses"]["forbidden"];
|
|
7030
|
+
404: components["responses"]["notFound"];
|
|
5559
7031
|
409: components["responses"]["conflict"];
|
|
5560
7032
|
500: components["responses"]["internalServerError"];
|
|
5561
7033
|
};
|
|
@@ -5591,6 +7063,7 @@ export interface operations {
|
|
|
5591
7063
|
};
|
|
5592
7064
|
};
|
|
5593
7065
|
401: components["responses"]["unauthorized"];
|
|
7066
|
+
403: components["responses"]["forbidden"];
|
|
5594
7067
|
404: components["responses"]["notFound"];
|
|
5595
7068
|
409: components["responses"]["conflict"];
|
|
5596
7069
|
500: components["responses"]["internalServerError"];
|
|
@@ -5630,6 +7103,7 @@ export interface operations {
|
|
|
5630
7103
|
};
|
|
5631
7104
|
400: components["responses"]["badRequest"];
|
|
5632
7105
|
401: components["responses"]["unauthorized"];
|
|
7106
|
+
403: components["responses"]["forbidden"];
|
|
5633
7107
|
404: components["responses"]["notFound"];
|
|
5634
7108
|
409: components["responses"]["conflict"];
|
|
5635
7109
|
500: components["responses"]["internalServerError"];
|
|
@@ -5670,6 +7144,8 @@ export interface operations {
|
|
|
5670
7144
|
};
|
|
5671
7145
|
};
|
|
5672
7146
|
401: components["responses"]["unauthorized"];
|
|
7147
|
+
403: components["responses"]["forbidden"];
|
|
7148
|
+
404: components["responses"]["notFound"];
|
|
5673
7149
|
500: components["responses"]["internalServerError"];
|
|
5674
7150
|
};
|
|
5675
7151
|
};
|
|
@@ -5765,6 +7241,165 @@ export interface operations {
|
|
|
5765
7241
|
500: components["responses"]["internalServerError"];
|
|
5766
7242
|
};
|
|
5767
7243
|
};
|
|
7244
|
+
listFlexClusters: {
|
|
7245
|
+
parameters: {
|
|
7246
|
+
query?: {
|
|
7247
|
+
/** @description Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. */
|
|
7248
|
+
envelope?: components["parameters"]["envelope"];
|
|
7249
|
+
/** @description Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. */
|
|
7250
|
+
includeCount?: components["parameters"]["includeCount"];
|
|
7251
|
+
/** @description Number of items that the response returns per page. */
|
|
7252
|
+
itemsPerPage?: components["parameters"]["itemsPerPage"];
|
|
7253
|
+
/** @description Number of the page that displays the current set of the total objects that the response returns. */
|
|
7254
|
+
pageNum?: components["parameters"]["pageNum"];
|
|
7255
|
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
|
|
7256
|
+
pretty?: components["parameters"]["pretty"];
|
|
7257
|
+
};
|
|
7258
|
+
header?: never;
|
|
7259
|
+
path: {
|
|
7260
|
+
/** @description Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
|
|
7261
|
+
*
|
|
7262
|
+
* **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. */
|
|
7263
|
+
groupId: components["parameters"]["groupId"];
|
|
7264
|
+
};
|
|
7265
|
+
cookie?: never;
|
|
7266
|
+
};
|
|
7267
|
+
requestBody?: never;
|
|
7268
|
+
responses: {
|
|
7269
|
+
/** @description OK */
|
|
7270
|
+
200: {
|
|
7271
|
+
headers: {
|
|
7272
|
+
[name: string]: unknown;
|
|
7273
|
+
};
|
|
7274
|
+
content: {
|
|
7275
|
+
"application/vnd.atlas.2024-11-13+json": components["schemas"]["PaginatedFlexClusters20241113"];
|
|
7276
|
+
};
|
|
7277
|
+
};
|
|
7278
|
+
401: components["responses"]["unauthorized"];
|
|
7279
|
+
403: components["responses"]["forbidden"];
|
|
7280
|
+
404: components["responses"]["notFound"];
|
|
7281
|
+
409: components["responses"]["conflict"];
|
|
7282
|
+
500: components["responses"]["internalServerError"];
|
|
7283
|
+
};
|
|
7284
|
+
};
|
|
7285
|
+
createFlexCluster: {
|
|
7286
|
+
parameters: {
|
|
7287
|
+
query?: {
|
|
7288
|
+
/** @description Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. */
|
|
7289
|
+
envelope?: components["parameters"]["envelope"];
|
|
7290
|
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
|
|
7291
|
+
pretty?: components["parameters"]["pretty"];
|
|
7292
|
+
};
|
|
7293
|
+
header?: never;
|
|
7294
|
+
path: {
|
|
7295
|
+
/** @description Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
|
|
7296
|
+
*
|
|
7297
|
+
* **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. */
|
|
7298
|
+
groupId: components["parameters"]["groupId"];
|
|
7299
|
+
};
|
|
7300
|
+
cookie?: never;
|
|
7301
|
+
};
|
|
7302
|
+
/** @description Create One Flex Cluster in One Project. */
|
|
7303
|
+
requestBody: {
|
|
7304
|
+
content: {
|
|
7305
|
+
"application/vnd.atlas.2024-11-13+json": components["schemas"]["FlexClusterDescriptionCreate20241113"];
|
|
7306
|
+
};
|
|
7307
|
+
};
|
|
7308
|
+
responses: {
|
|
7309
|
+
/** @description Created */
|
|
7310
|
+
201: {
|
|
7311
|
+
headers: {
|
|
7312
|
+
[name: string]: unknown;
|
|
7313
|
+
};
|
|
7314
|
+
content: {
|
|
7315
|
+
"application/vnd.atlas.2024-11-13+json": components["schemas"]["FlexClusterDescription20241113"];
|
|
7316
|
+
};
|
|
7317
|
+
};
|
|
7318
|
+
400: components["responses"]["badRequest"];
|
|
7319
|
+
401: components["responses"]["unauthorized"];
|
|
7320
|
+
402: components["responses"]["paymentRequired"];
|
|
7321
|
+
403: components["responses"]["forbidden"];
|
|
7322
|
+
404: components["responses"]["notFound"];
|
|
7323
|
+
409: components["responses"]["conflict"];
|
|
7324
|
+
500: components["responses"]["internalServerError"];
|
|
7325
|
+
};
|
|
7326
|
+
};
|
|
7327
|
+
getFlexCluster: {
|
|
7328
|
+
parameters: {
|
|
7329
|
+
query?: {
|
|
7330
|
+
/** @description Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. */
|
|
7331
|
+
envelope?: components["parameters"]["envelope"];
|
|
7332
|
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
|
|
7333
|
+
pretty?: components["parameters"]["pretty"];
|
|
7334
|
+
};
|
|
7335
|
+
header?: never;
|
|
7336
|
+
path: {
|
|
7337
|
+
/** @description Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
|
|
7338
|
+
*
|
|
7339
|
+
* **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. */
|
|
7340
|
+
groupId: components["parameters"]["groupId"];
|
|
7341
|
+
/** @description Human-readable label that identifies the flex cluster. */
|
|
7342
|
+
name: string;
|
|
7343
|
+
};
|
|
7344
|
+
cookie?: never;
|
|
7345
|
+
};
|
|
7346
|
+
requestBody?: never;
|
|
7347
|
+
responses: {
|
|
7348
|
+
/** @description OK */
|
|
7349
|
+
200: {
|
|
7350
|
+
headers: {
|
|
7351
|
+
[name: string]: unknown;
|
|
7352
|
+
};
|
|
7353
|
+
content: {
|
|
7354
|
+
"application/vnd.atlas.2024-11-13+json": components["schemas"]["FlexClusterDescription20241113"];
|
|
7355
|
+
};
|
|
7356
|
+
};
|
|
7357
|
+
400: components["responses"]["badRequest"];
|
|
7358
|
+
401: components["responses"]["unauthorized"];
|
|
7359
|
+
403: components["responses"]["forbidden"];
|
|
7360
|
+
404: components["responses"]["notFound"];
|
|
7361
|
+
409: components["responses"]["conflict"];
|
|
7362
|
+
500: components["responses"]["internalServerError"];
|
|
7363
|
+
};
|
|
7364
|
+
};
|
|
7365
|
+
deleteFlexCluster: {
|
|
7366
|
+
parameters: {
|
|
7367
|
+
query?: {
|
|
7368
|
+
/** @description Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. */
|
|
7369
|
+
envelope?: components["parameters"]["envelope"];
|
|
7370
|
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
|
|
7371
|
+
pretty?: components["parameters"]["pretty"];
|
|
7372
|
+
};
|
|
7373
|
+
header?: never;
|
|
7374
|
+
path: {
|
|
7375
|
+
/** @description Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
|
|
7376
|
+
*
|
|
7377
|
+
* **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. */
|
|
7378
|
+
groupId: components["parameters"]["groupId"];
|
|
7379
|
+
/** @description Human-readable label that identifies the flex cluster. */
|
|
7380
|
+
name: string;
|
|
7381
|
+
};
|
|
7382
|
+
cookie?: never;
|
|
7383
|
+
};
|
|
7384
|
+
requestBody?: never;
|
|
7385
|
+
responses: {
|
|
7386
|
+
/** @description This endpoint does not return a response body. */
|
|
7387
|
+
204: {
|
|
7388
|
+
headers: {
|
|
7389
|
+
[name: string]: unknown;
|
|
7390
|
+
};
|
|
7391
|
+
content: {
|
|
7392
|
+
"application/vnd.atlas.2024-11-13+json": unknown;
|
|
7393
|
+
};
|
|
7394
|
+
};
|
|
7395
|
+
400: components["responses"]["badRequest"];
|
|
7396
|
+
401: components["responses"]["unauthorized"];
|
|
7397
|
+
403: components["responses"]["forbidden"];
|
|
7398
|
+
404: components["responses"]["notFound"];
|
|
7399
|
+
409: components["responses"]["conflict"];
|
|
7400
|
+
500: components["responses"]["internalServerError"];
|
|
7401
|
+
};
|
|
7402
|
+
};
|
|
5768
7403
|
listOrganizations: {
|
|
5769
7404
|
parameters: {
|
|
5770
7405
|
query?: {
|
|
@@ -5798,6 +7433,7 @@ export interface operations {
|
|
|
5798
7433
|
};
|
|
5799
7434
|
400: components["responses"]["badRequest"];
|
|
5800
7435
|
401: components["responses"]["unauthorized"];
|
|
7436
|
+
403: components["responses"]["forbidden"];
|
|
5801
7437
|
404: components["responses"]["notFound"];
|
|
5802
7438
|
409: components["responses"]["conflict"];
|
|
5803
7439
|
500: components["responses"]["internalServerError"];
|
|
@@ -5839,6 +7475,7 @@ export interface operations {
|
|
|
5839
7475
|
};
|
|
5840
7476
|
400: components["responses"]["badRequest"];
|
|
5841
7477
|
401: components["responses"]["unauthorized"];
|
|
7478
|
+
403: components["responses"]["forbidden"];
|
|
5842
7479
|
404: components["responses"]["notFound"];
|
|
5843
7480
|
500: components["responses"]["internalServerError"];
|
|
5844
7481
|
};
|