MongoDB Atlas API 2.0
  • 2025-03-12（最新）
  • 2025-02-19
  • 2024-11-13
  • 2024-10-23
  • 2024-08-05
  • 2024-05-30
  • 2023-11-15
  • 2023-10-01
  • 2023-02-01
  • 2023-01-01
Reduce によるAPI Docs

MongoDB Atlas Administration API (2.0)

リソース バージョン 2025-03-12

OpenAPI 仕様をダウンロード: ダウンロード

ライセンス: CC BY-NC-SA 3.0 US サービス利用規約

MongoDB Atlas Administration API を使用すると、開発者は MongoDB Atlas のすべてのコンポーネントを管理できます。

Atlas 管理 API は、OAuth2 サービス アカウントまたは HTTP ダイジェスト認証を使用してリクエストを認証します。HTTP リクエストを構築する際には、プログラムによる API 公開キーと対応する秘密キーをユーザー名とパスワードとして指定してください。たとえば、データベース アクセス履歴を取得するために cURL を使用する場合は、ターミナルで以下のコマンドを実行します。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"

詳細については、「Atlas Administration API の使い始める」を参照してください。サポートについては、MongoDB サポートを参照してください。

MongoDB のPostman ワークスペースの Atlas Administration API を通じて利用可能なさまざまなエンドポイントを確認することもできます。

アクセス トラッキング

Atlas データベース配置に対して行われた認証試行のアクセス ログを返します。データベース アクセス履歴を表示するには、プロジェクト オーナーまたは組織オーナー ロールが必要です。

クラスター名を使用して、1 つのクラスターのデータベース アクセス履歴を返す

クラスター名で識別される 1 つのクラスターのアクセス ログを返します。アクセス ログには、クラスターに対して行われた認証リクエストの一覧が含まれます。この機能は、テナント階層クラスター（M0、M2、M5）では使用できません。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト モニタリング管理者" ロールまたは "プロジェクト データベース アクセス管理者" ロールが付与されている必要があります。

データベース アクセス履歴
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
authResult
ブール値

レスポンスが成功した認証試行のみを返すかどうかを示すフラグ。

end
integer <int64>

データベース履歴の取得を停止する日時。end を指定する場合は、start も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。

ipAddress
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

データベースへの認証を試みた 1 つのインターネット プロトコル アドレス。

nLogs
integer <int32> [ 0 .. 20000 ]
デフォルト: 20000

ログから返される最大行数。

始める
integer <int64>

MongoDB Cloud がデータベース履歴の取得を開始する日時。start を指定する場合は、end も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。

応答

リクエスト サンプル 

atlas api listAccessLogsByClusterName --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "accessLogs": [
    ]
}

ホスト名を使用して 1 つのクラスターのデータベース アクセス履歴を返す

クラスターのホスト名で識別される 1 つのクラスターのアクセス ログを返します。アクセス ログには、クラスターに対して行われた認証リクエストのリストが含まれます。この機能は、テナント階層クラスター（M0、M2、M5）では使用できません。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト モニタリング管理者" ロールまたは "プロジェクト データベース アクセス管理者" ロールが付与されている必要があります。

データベース アクセス履歴
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

Hostname
必須
string

ダウンロード対象のログファイルを保存する MongoDB ホストの完全修飾ドメイン名または IP アドレス。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
authResult
ブール値

レスポンスが成功した認証試行のみを返すかどうかを示すフラグ。

end
integer <int64>

データベース履歴の取得を停止する日時。end を指定する場合は、start も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。

ipAddress
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

データベースへの認証を試みた 1 つのインターネット プロトコル アドレス。

nLogs
integer <int32> [ 0 .. 20000 ]
デフォルト: 20000

ログから返される最大行数。

始める
integer <int64>

MongoDB Cloud がデータベース履歴の取得を開始する日時。start を指定する場合は、end も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。

応答

リクエスト サンプル 

atlas api listAccessLogsByHostname --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "accessLogs": [
    ]
}

Alert Configurations

アラートをトリガーする条件と、MongoDB Cloud がユーザーに通知する方法を返したり編集したりします。このコレクションは現在も改訂中であり、変更される可能性があります。

すべてのアラート構成一致するフィールド名を返します

アラート構成を作成または更新するときに matchers.fieldName パラメータが受け入れるすべてのフィールド名を取得します。割り当てられた任意のロールを使用して、このエンドポイントを正常に呼び出すことができます。

認可:
ServiceAccountsDigestAuth
クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listAlertConfigurationMatchersFieldNames --held

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
[
  • "APPLICATION_ID"
]

1 つのプロジェクトのすべてのアラート構成を返す

1 つのプロジェクトに対するすべてのアラート設定を返します。これらのアラート設定は、プロジェクト内のすべてのコンポーネントに適用されます。アラート設定では、アラートのトリガー条件や通知方法が定義されます。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト読み取り専用" ロールが付与されている必要があります。

このリソースは現在も改訂中であり、変更される可能性があります。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listAlertConfigurations -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのプロジェクトに 1 つのアラート構成を作成する

指定されたプロジェクトに対して 1 件のアラート設定を作成します。アラート設定では、アラートのトリガー条件や通知方法が定義されます。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "組織オーナー" ロールまたは "プロジェクト オーナー" ロールが付与されている必要があります。

このリソースは現在も改訂中であり、変更される可能性があります。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクトに対して 1 つのアラート構成を作成します。

One of
enabled
ブール値
デフォルト: false

指定されたプロジェクトに対して誰かがこのアラート構成を有効にしたかどうかを示すフラグ。

必須
課金イベント タイプ（オブジェクト）または Cps バックアップ イベント タイプ（オブジェクト）またはデータ保護イベント タイプ（オブジェクト）または Full Text Search インデックス監査タイプ（オブジェクト）またはグループ イベント タイプ（オブジェクト）または NDS 監査タイプ（オブジェクト）または NDS メンテナンス ウィンドウ監査タイプ（オブジェクト）または Atlas Online Archive イベント タイプ（オブジェクト）またはユーザー イベント タイプ（オブジェクト）またはリソース イベント タイプ（オブジェクト）またはストリーム プロセッサ イベント タイプ（オブジェクト）または NDS オートスケーリング監査タイプ (オブジェクト）または Atlas リソース ポリシー監査タイプ（オブジェクト）

このアラートをトリガーしたインシデント。

の配列 オブジェクト （マッチャー）

ターゲット リソースの一致条件。

必須
の配列 Datadog 通知（オブジェクト）、メール通知（オブジェクト）、グループ通知（オブジェクト）、HipChat 通知（オブジェクト）、Microsoft Teams 通知（オブジェクト）、OpsGenie 通知（オブジェクト）、OpsGenie 通知（オブジェクト）、組織通知（オブジェクト）、PagerDuty 通知（オブジェクト）、Slack 通知（オブジェクト）、SMS 通知（オブジェクト）、チーム通知（オブジェクト）、ユーザー通知（オブジェクト）、VictorOps 通知（オブジェクト）、Webhook 通知（オブジェクト）のいずれか (AlertsNotificationRootForGroup)

MongoDB Cloud が通知を送信するターゲットを含むリスト。

重大度オーバーライド
string (EventSeverity)
列挙: "INFO" "WARNING" "ERROR" "CRITAL"

イベントの 重大度 。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "severityOverride": "INFO"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "severityOverride": "INFO",
  • "updated": "2019-08-24T14:15:22Z"
}

1 つのプロジェクトからの 1 つのアラート構成を削除

指定されたプロジェクトから 1 件のアラート設定を削除します。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "組織オーナー" ロールまたは "プロジェクト オーナー" ロールが付与されている必要があります。認証済みユーザーがアクセス可能なすべてのアラート設定を取得するには、"1 つのプロジェクトのすべてのアラート設定を返す（Return All Alert Configurations for One Project）" エンドポイントを使用してください。

このリソースは現在も改訂中であり、変更される可能性があります。

1 つのプロジェクトのすべてのアラート構成を返す
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

alertConfigId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

アラート設定を識別する一意の 24 桁の 16 進数文字列です。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api deleteAlertConfiguration --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

1 つのプロジェクトから 1 つのアラート構成を返す

指定されたプロジェクトから、指定されたアラート設定を返します。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト読み取り専用" ロールが付与されている必要があります。認証済みユーザーがアクセス可能なすべてのアラート設定を取得するには、"1 つのプロジェクトのすべてのアラート設定を返す（Return All Alert Configurations for One Project）" エンドポイントを使用してください。

このリソースは現在も改訂中であり、変更される可能性があります。

1 つのプロジェクトのすべてのアラート構成を返す
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

alertConfigId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

アラート設定を識別する一意の 24 桁の 16 進数文字列です。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getAlertConfiguration --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "severityOverride": "INFO",
  • "updated": "2019-08-24T14:15:22Z"
}

1 つのプロジェクトでの 1 つのアラート構成の状態を切り替える

指定されたプロジェクト内の、指定されたアラート設定を有効化または無効化します。現在有効になっている場合は、このリソースによってアラート設定が無効化されます。現在無効になっている場合は、このリソースによってアラート設定が有効化されます。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "組織オーナー" ロールまたは "プロジェクト オーナー" ロールが付与されている必要があります。

注: このエンドポイントは、アラート設定の有効化または無効化の状態のみを更新します。その他の設定を更新するには、「1 つのアラート設定の更新」をご覧ください。

このリソースは現在も改訂中であり、変更される可能性があります。

1 つのアラート構成の更新
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

alertConfigId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

このアラートをトリガーしたアラート設定を識別する一意の 24 桁の 16 進数文字列です。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクト内の指定されたアラート構成を有効または無効にします。

enabled
ブール値

指定されたプロジェクトで指定されたアラート構成を有効にするか無効にするかを示すフラグ。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "severityOverride": "INFO",
  • "updated": "2019-08-24T14:15:22Z"
}

1 つのプロジェクトの 1 つのアラート構成の更新

指定されたプロジェクト内の 1 つのアラート構成を更新します。アラート設定では、アラートのトリガー条件や通知方法が定義されます。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "組織オーナー" ロールまたは "プロジェクト オーナー" ロールが付与されている必要があります。

注: アラート構成を有効または無効にするには、「1 つのプロジェクトで 1 つのアラート構成の 1 つの状態を切り替える」を参照してください。

このリソースは現在も改訂中であり、変更される可能性があります。

1 つのプロジェクトで 1 つのアラート構成の 1 つの状態を切り替える
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

alertConfigId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

アラート設定を識別する一意の 24 桁の 16 進数文字列です。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクト内の 1 つのアラート構成を更新します。

One of
enabled
ブール値
デフォルト: false

指定されたプロジェクトに対して誰かがこのアラート構成を有効にしたかどうかを示すフラグ。

必須
課金イベント タイプ（オブジェクト）または Cps バックアップ イベント タイプ（オブジェクト）またはデータ保護イベント タイプ（オブジェクト）または Full Text Search インデックス監査タイプ（オブジェクト）またはグループ イベント タイプ（オブジェクト）または NDS 監査タイプ（オブジェクト）または NDS メンテナンス ウィンドウ監査タイプ（オブジェクト）または Atlas Online Archive イベント タイプ（オブジェクト）またはユーザー イベント タイプ（オブジェクト）またはリソース イベント タイプ（オブジェクト）またはストリーム プロセッサ イベント タイプ（オブジェクト）または NDS オートスケーリング監査タイプ (オブジェクト）または Atlas リソース ポリシー監査タイプ（オブジェクト）

このアラートをトリガーしたインシデント。

の配列 オブジェクト （マッチャー）

ターゲット リソースの一致条件。

必須
の配列 Datadog 通知（オブジェクト）、メール通知（オブジェクト）、グループ通知（オブジェクト）、HipChat 通知（オブジェクト）、Microsoft Teams 通知（オブジェクト）、OpsGenie 通知（オブジェクト）、OpsGenie 通知（オブジェクト）、組織通知（オブジェクト）、PagerDuty 通知（オブジェクト）、Slack 通知（オブジェクト）、SMS 通知（オブジェクト）、チーム通知（オブジェクト）、ユーザー通知（オブジェクト）、VictorOps 通知（オブジェクト）、Webhook 通知（オブジェクト）のいずれか (AlertsNotificationRootForGroup)

MongoDB Cloud が通知を送信するターゲットを含むリスト。

重大度オーバーライド
string (EventSeverity)
列挙: "INFO" "WARNING" "ERROR" "CRITAL"

イベントの 重大度 。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "severityOverride": "INFO"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "severityOverride": "INFO",
  • "updated": "2019-08-24T14:15:22Z"
}

1 つのアラートに設定されたすべてのアラート構成を返す

指定されたアラートに設定されているすべてのアラート設定を返します。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト読み取り専用" ロールが付与されている必要があります。認証済みユーザーがアクセス可能なすべてのアラートを取得するには、"1 つのプロジェクトからすべてのアラートを返す" エンドポイントを使用してください。。

このリソースは現在も改訂中であり、変更される可能性があります。

1 つのプロジェクトからすべてのアラートを返す
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

alertId
必須
string^([a-f0-9]{24})$

アラートを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

応答

リクエスト サンプル 

atlas api listAlertConfigurationsByAlertId --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

アラート

定義したアラート条件に基づいて MongoDB Cloud がトリガーするアラートを返し、確認します。このコレクションは現在も改訂中であり、変更される可能性があります。

1 つのアラート構成のすべてのオープン アラートを返す

指定されたアラート設定によってトリガーされた、すべての未解決のアラートを返します。これらのアラート設定は、指定されたプロジェクトにのみ適用されます。アラート設定では、アラートのトリガー条件や通知方法が定義されます。未解決のアラートとは、トリガーされたものの、まだ確認されていない状態のアラートです。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト読み取り専用" ロールが付与されている必要があります。認証済みユーザーがアクセス可能なすべてのアラート設定を取得するには、"1 つのプロジェクトのすべてのアラート設定を返す（Return All Alert Configurations for One Project）" エンドポイントを使用してください。

このリソースは現在も改訂中であり、変更される可能性があります。

1 つのプロジェクトのすべてのアラート構成を返す
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

alertConfigId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

アラート設定を識別する一意の 24 桁の 16 進数文字列です。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listAlertsByAlertConfigurationId --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのプロジェクトからすべてのアラートを返す

すべてのアラートを返します。これらのアラートは、1 つのプロジェクト内のすべてのコンポーネントに適用されます。監視対象のコンポーネントが設定した値に達するか、それを超えたときにアラートを受け取ります。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト読み取り専用" ロールが付与されている必要があります。

このリソースは現在も改訂中であり、変更される可能性があります。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
状態
string
列挙: "OPEN" "TRACKING" "CLOSED"

返すアラートのステータス。省略すると、すべてのステータスのすべてのアラートが返されます。

応答

リクエスト サンプル 

atlas api listAlerts --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのプロジェクトから 1 つのアラートを返す

アラートを 1 つ返します。このアラートは、1 つのプロジェクト内の任意のコンポーネントに適用されます。モニター対象のコンポーネントが設定した値を満たすか超過すると、アラートを受け取ります。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。1 つのプロジェクトからすべてのアラートを返すエンドポイントを使用して、認証されたユーザーがアクセス可能なすべてのアラートを取得してください。

このリソースは現在も改訂中であり、変更される可能性があります。

1 つのプロジェクトからすべてのアラートを返す
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

alertId
必須
string^([a-f0-9]{24})$

アラートを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getAlert --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
  • "acknowledgingUsername": "user@example.com",
  • "alertConfigId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "DEPLOYMENT_FAILURE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastNotified": "2019-08-24T14:15:22Z",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "resolved": "2019-08-24T14:15:22Z",
  • "status": "OPEN",
  • "updated": "2019-08-24T14:15:22Z"
}

1 つのプロジェクトからの 1 つのアラートを確認

既存のアラートを 1 つ受信していることを確認します。このアラートは、1 つのプロジェクト内の任意のコンポーネントに適用されます。アラートを確認すると、通知が連続して行われなくなります。モニター対象コンポーネントが設定した値を満たすか上回ると、アラートを確認するまでアラートが送信されます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。1 つのプロジェクトからすべてのアラートを返すエンドポイントを使用して、認証されたユーザーがアクセス可能なすべてのアラートを取得してください。

このリソースは現在も改訂中であり、変更される可能性があります。非推奨のバージョン: v2-{2023-01-01}

1 つのプロジェクトからすべてのアラートを返す
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

alertId
必須
string^([a-f0-9]{24})$

アラートを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-05-30+json

1 つのアラートを確認または未確認にします。

acknowledgedUntil
string <date-time>

このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。

ISO 8601
acknowledgementComment
string <= 200 文字

MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。

unacknowledgeAlert
ブール値

以前に確認されたアラートを未確認にすることを示すフラグ。この値は、デフォルトで false に設定されています。true に設定されると、acknowledgedUntil パラメータが上書きされます。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
  • "unacknowledgeAlert": true
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
例
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
  • "acknowledgingUsername": "user@example.com",
  • "alertConfigId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "DEPLOYMENT_FAILURE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastNotified": "2019-08-24T14:15:22Z",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "resolved": "2019-08-24T14:15:22Z",
  • "status": "OPEN",
  • "updated": "2019-08-24T14:15:22Z"
}

1 つの Atlas Search インデックスを作成 非推奨

指定されたコレクションに 1 つの Atlas Search インデックスを作成します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。MongoDB v4.2 以降を実行しているクラスターのみが Atlas Search を使用できます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス管理者ロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

Atlas Search インデックスを作成するコレクションを含むクラスターの名前。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたコレクションに 1 つの Atlas Search インデックスを作成します。

コレクション名
必須
string

1 つ以上の Atlas Search インデックスを含むコレクションを識別する、人間が判読できるラベル。

database
必須
string

1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。

name
必須
string

このインデックスを識別する、人間が判読できるラベル。各名前空間内では、名前空間内のすべてのインデックスの名前が一意である必要があります。

numPartitions
integer <int32>
デフォルト: 1

インデックスパーティションの数。許可されている値は［1、2、4］です。

タイプ
string

インデックスのタイプ。デフォルトのタイプは検索です。

analyzer
string
デフォルト: "lucene.standard"
列挙: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

データベース フィールド テキストを検索可能な単語に変換するために選択された特定の定義済みメソッド。この変換により、フィールドのテキストが最小のテキスト単位に縮小されます。これらの単位はタームまたはトークンと呼ばれます。トークン化と呼ばれるこのプロセスでは、フィールド内のテキストにさまざまな変更が加えられます。

  • 単語の抽出
  • 句読点の削除
  • アクセントの削除
  • 小文字への変更
  • 一般的な単語の削除
  • 単語を語幹形態まで縮小（ステミング）
  • 単語を基本形に変更する（レンマ化）。MongoDB Cloud は、選択したプロセスを使用して Atlas Search インデックスを構築します。
Atlas Searchアナライザ
の配列 オブジェクト （アナライザ）

データベース フィールドのテキストを検索可能な単語に変換するユーザー定義メソッドのリスト。

カスタムの Atlas Search アナライザ
オブジェクト （マッピング）

コレクションのフィールドのインデックス仕様。

searchAnalyzer
string
デフォルト: "lucene.standard"
列挙: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

このインデックスを検索するときに単語を識別するために適用される方法。

storedSource
オブジェクト

Atlas Search にすべてのフィールド （true） を保存するかどうかを示すフラグ。デフォルトでは、Atlas は Atlas Search のフィールドを保存しません （false）。または、Atlas Search に保存するフィールドのリストのみを含むオブジェクトを指定するか （include）、または保存しないフィールドのリストを含む （exclude） オブジェクトを指定することもできます。詳細については、ドキュメントを参照してください。

保存済みソース フィールド
の配列 オブジェクト （同義語マッピングの定義）

このインデックス内の単語を同義語にマッピングするルール セット。

同義語マッピング

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "numPartitions": 1,
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "numPartitions": 1,
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

1 つのコレクションのすべての Atlas Search インデックスを返す 非推奨

指定されたコレクションにすべての Atlas Search インデックスを返します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス読み取り書き込みロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。

コレクション名
必須
string

1 つ以上の Atlas Search インデックスを含むコレクションの名前。

databaseName
必須
string

1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listAtlasSearchIndexesDeprecation -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1 つの Atlas Search インデックスを削除 非推奨

ユニークな ID で識別した 1 つの Atlas Search インデックスを削除します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス管理者ロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

1 つ以上のアプリケーション検索インデックスを持つデータベースとコレクションを含むクラスターの名前。

indexId
必須
string^([a-f0-9]{24})$

Atlas Search インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべての Atlas Search インデックスを取得するエンドポイントを使用して、すべての Atlas Search インデックスの ID を検索します。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api deleteAtlasSearchIndexDeprecation -- ヘルプ

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つの Atlas Search インデックスを返す 非推奨

指定されたプロジェクト内の 1 つの Atlas Search インデックスを返します。このインデックスは、ユニークな ID を使用して識別します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス読み取り書き込みロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。

indexId
必須
string^([a-f0-9]{24})$

アプリケーション検索インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべてのアプリケーション検索インデックスを取得するエンドポイントを使用して、すべてのアプリケーション検索インデックスの ID を検索します。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getAtlasSearchIndexDeprecation -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "numPartitions": 1,
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

1 つの Atlas Search インデックスを更新 非推奨

ユニークな ID で識別した 1 つの Atlas Search インデックスを更新します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス管理者ロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

Atlas Search インデックスを更新するコレクションを含むクラスターの名前。

indexId
必須
string^([a-f0-9]{24})$

Atlas Search インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべての Atlas Search インデックスを取得するエンドポイントを使用して、すべての Atlas Search インデックスの ID を検索します。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

Atlas Search インデックスに更新する詳細。

コレクション名
必須
string

1 つ以上の Atlas Search インデックスを含むコレクションを識別する、人間が判読できるラベル。

database
必須
string

1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。

name
必須
string

このインデックスを識別する、人間が判読できるラベル。各名前空間内では、名前空間内のすべてのインデックスの名前が一意である必要があります。

numPartitions
integer <int32>
デフォルト: 1

インデックスパーティションの数。許可されている値は［1、2、4］です。

タイプ
string

インデックスのタイプ。デフォルトのタイプは検索です。

analyzer
string
デフォルト: "lucene.standard"
列挙: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

データベース フィールド テキストを検索可能な単語に変換するために選択された特定の定義済みメソッド。この変換により、フィールドのテキストが最小のテキスト単位に縮小されます。これらの単位はタームまたはトークンと呼ばれます。トークン化と呼ばれるこのプロセスでは、フィールド内のテキストにさまざまな変更が加えられます。

  • 単語の抽出
  • 句読点の削除
  • アクセントの削除
  • 小文字への変更
  • 一般的な単語の削除
  • 単語を語幹形態まで縮小（ステミング）
  • 単語を基本形に変更する（レンマ化）。MongoDB Cloud は、選択したプロセスを使用して Atlas Search インデックスを構築します。
Atlas Searchアナライザ
の配列 オブジェクト （アナライザ）

データベース フィールドのテキストを検索可能な単語に変換するユーザー定義メソッドのリスト。

カスタムの Atlas Search アナライザ
オブジェクト （マッピング）

コレクションのフィールドのインデックス仕様。

searchAnalyzer
string
デフォルト: "lucene.standard"
列挙: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

このインデックスを検索するときに単語を識別するために適用される方法。

storedSource
オブジェクト

Atlas Search にすべてのフィールド （true） を保存するかどうかを示すフラグ。デフォルトでは、Atlas は Atlas Search のフィールドを保存しません （false）。または、Atlas Search に保存するフィールドのリストのみを含むオブジェクトを指定するか （include）、または保存しないフィールドのリストを含む （exclude） オブジェクトを指定することもできます。詳細については、ドキュメントを参照してください。

保存済みソース フィールド
の配列 オブジェクト （同義語マッピングの定義）

このインデックス内の単語を同義語にマッピングするルール セット。

同義語マッピング

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "numPartitions": 1,
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "numPartitions": 1,
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

検索ノードを削除

指定されたクラスターの検索ノードを削除します。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

削除するクラスターを識別するラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api deleteAtlasSearchDeployment --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

すべての検索ノードを返す

指定されたクラスターの検索ノードを返します。非推奨バージョン: v2-{2024-05-30}、v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

検索ノードを返すクラスターを識別するラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getAtlasSearchDeployment -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2025-03-12+json
{
  • "encryptionAtRestProvider": "NONE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

検索ノードを更新

指定されたクラスターの検索ノードを更新します。非推奨のバージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

検索ノードを更新するクラスターを識別するラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-05-30+json

指定されたクラスターの検索ノードを更新します。

必須
の配列 オブジェクト (ApiSearchDeploymentSpecView) = 1 アイテム

クラスターの検索ノードを構成する設定のリスト。

注: 現在、すべてのノードに対して単一の構成を受け入れています。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "specs": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "encryptionAtRestProvider": "NONE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

検索ノードを作成

指定されたクラスターの検索ノードを作成します。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

検索ノードを作成するクラスターを識別するラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-05-30+json

指定されたクラスターの検索ノードを作成します。

必須
の配列 オブジェクト (ApiSearchDeploymentSpecView) = 1 アイテム

クラスターの検索ノードを構成する設定のリスト。

注: 現在、すべてのノードに対して単一の構成を受け入れています。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "specs": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "encryptionAtRestProvider": "NONE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

1 つのクラスターのすべての Atlas Search インデックスを返す

指定されたクラスター上のすべての Atlas Search インデックスを返します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス読み取り書き込みロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listAtlasSearchIndexesCluster --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
[
  • {
    }
]

1 つの Atlas Search インデックスを作成

指定されたコレクションに 1 つの Atlas Search インデックスを作成します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。MongoDB v4.2 以降を実行しているクラスターのみが Atlas Search を使用できます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス管理者ロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

Atlas Search インデックスを作成するコレクションを含むクラスターの名前。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-05-30+json

指定されたコレクションに 1 つの Atlas Search インデックスを作成します。

コレクション名
必須
string

Atlas Search インデックスを作成するコレクションを識別するラベル。

database
必須
string

Atlas Search インデックスを作成するコレクションを含むデータベースを識別するラベル。

name
必須
string

このインデックスを識別するラベル。 各名前空間内では、名前空間内のすべてのインデックスの名前が一意である必要があります。

タイプ
string

インデックスのタイプ。デフォルトのタイプは検索です。

必須
オブジェクト （テキスト検索インデックスの定義）

ユーザーが設定したテキスト検索インデックスの定義。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "type": "search",
  • "definition": {
    }
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "latestDefinition": {
    },
  • "latestDefinitionVersion": {
    },
  • "name": "string",
  • "queryable": true,
  • "status": "DELETING",
  • "statusDetail": [
    ],
  • "type": "search",
  • "synonymMappingStatus": "FAILED",
  • "synonymMappingStatusDetail": [
    ]
}

1 つのコレクションのすべての Atlas Search インデックスを返す

指定されたコレクションにすべての Atlas Search インデックスを返します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス読み取り書き込みロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。

コレクション名
必須
string

1 つ以上の Atlas Search インデックスを含むコレクションの名前。

databaseName
必須
string

1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別するラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listAtlasSearchIndexes --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
[
  • {
    }
]

名前を使用して 1 つの Atlas Search インデックスを削除

データベース、コレクション、および名前で識別した Atlas Search インデックスを 1 つ削除します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス管理者ロールが必要です。この削除は結果整合性があります。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

1 つ以上のアプリケーション検索インデックスを持つデータベースとコレクションを含むクラスターの名前。

コレクション名
必須
string

1 つ以上の Atlas Search インデックスを含むコレクションの名前。

databaseName
必須
string

1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別するラベル。

indexName
必須
string

削除する Atlas Search インデックスの名前。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api deleteAtlasSearchIndexByName -- ヘルプ

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

名前を使用して Atlas Search インデックスを返す

指定されたプロジェクト内の 1 つの Atlas Search インデックスを返します。このインデックスは、データベース、コレクション、および名前を使用して識別します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス読み取り書き込みロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。

コレクション名
必須
string

1 つ以上の Atlas Search インデックスを含むコレクションの名前。

databaseName
必須
string

1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別するラベル。

indexName
必須
string

返す対象の Atlas Search インデックスの名前。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getAtlasSearchIndexByName -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "latestDefinition": {
    },
  • "latestDefinitionVersion": {
    },
  • "name": "string",
  • "queryable": true,
  • "status": "DELETING",
  • "statusDetail": [
    ],
  • "type": "search",
  • "synonymMappingStatus": "FAILED",
  • "synonymMappingStatusDetail": [
    ]
}

名前を使用して 1 つの Atlas Search インデックスを更新

データベース、コレクション、名前、およびインデックス名で識別した Atlas Search インデックスを 1 つ削除します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス管理者ロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

Atlas Search インデックスを更新するコレクションを含むクラスターの名前。

コレクション名
必須
string

1 つ以上の Atlas Search インデックスを含むコレクションの名前。

databaseName
必須
string

1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別するラベル。

indexName
必須
string

更新する Atlas Search インデックスの名前。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-05-30+json

Atlas Search インデックスに更新する詳細。

必須
テキスト検索インデックス定義（オブジェクト）またはベクトル検索インデックス定義（オブジェクト）

検索インデックスを更新するインデックス定義。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "definition": {
    }
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "latestDefinition": {
    },
  • "latestDefinitionVersion": {
    },
  • "name": "string",
  • "queryable": true,
  • "status": "DELETING",
  • "statusDetail": [
    ],
  • "type": "search",
  • "synonymMappingStatus": "FAILED",
  • "synonymMappingStatusDetail": [
    ]
}

IDを使用して 1 つの Atlas Search インデックスを削除

ユニークな ID で識別した 1 つの Atlas Search インデックスを削除します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス管理者ロールが必要です。この削除は結果整合性があります。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

1 つ以上のアプリケーション検索インデックスを持つデータベースとコレクションを含むクラスターの名前。

indexId
必須
string^([a-f0-9]{24})$

Atlas Search インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべての Atlas Search インデックスを取得するエンドポイントを使用して、すべての Atlas Search インデックスの ID を検索します。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api deleteAtlasSearchIndex -- ヘルプ

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

ID を使用して Atlas Search インデックスを返す

指定されたプロジェクト内の 1 つの Atlas Search インデックスを返します。このインデックスは、ユニークな ID を使用して識別します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス読み取り書き込みロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。

indexId
必須
string^([a-f0-9]{24})$

アプリケーション検索インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべてのアプリケーション検索インデックスを取得するエンドポイントを使用して、すべてのアプリケーション検索インデックスの ID を検索します。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getAtlasSearchIndex -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "latestDefinition": {
    },
  • "latestDefinitionVersion": {
    },
  • "name": "string",
  • "queryable": true,
  • "status": "DELETING",
  • "statusDetail": [
    ],
  • "type": "search",
  • "synonymMappingStatus": "FAILED",
  • "synonymMappingStatusDetail": [
    ]
}

IDを使用して 1 つの Atlas Search インデックスを更新

ユニークな ID で識別した 1 つの Atlas Search インデックスを更新します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス管理者ロールが必要です。

Atlas Search インデックス
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

Atlas Search インデックスを更新するコレクションを含むクラスターの名前。

indexId
必須
string^([a-f0-9]{24})$

Atlas Search インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべての Atlas Search インデックスを取得するエンドポイントを使用して、すべての Atlas Search インデックスの ID を検索します。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-05-30+json

Atlas Search インデックスに更新する詳細。

必須
テキスト検索インデックス定義（オブジェクト）またはベクトル検索インデックス定義（オブジェクト）

検索インデックスを更新するインデックス定義。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "definition": {
    }
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
例
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "latestDefinition": {
    },
  • "latestDefinitionVersion": {
    },
  • "name": "string",
  • "queryable": true,
  • "status": "DELETING",
  • "statusDetail": [
    ],
  • "type": "search",
  • "synonymMappingStatus": "FAILED",
  • "synonymMappingStatusDetail": [
    ]
}

監査

MongoDB Cloud プロジェクトのデータベース監査設定を返して編集します。

1 つのプロジェクトの監査構成を返す

指定したプロジェクトの監査構成を返します。監査構成は、MongoDB Cloud が監査ログに記録するイベントを定義します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。この機能は、M0、M2、M5、またはサーバーレス クラスターでは使用できません。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getAuditingConfiguration --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "NONE",
  • "enabled": false
}

1 つのプロジェクトの監査構成を更新

指定したプロジェクトの監査構成を更新します。監査構成は、MongoDB Cloud が監査ログに記録するイベントを定義します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。この機能は、M0、M2、M5、またはサーバーレス クラスターでは使用できません。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定したプロジェクトの更新された監査構成。

auditAuthorizationSuccess
ブール値
デフォルト: false

成功した認証を追跡するように監査を誰かが設定したかどうかを示すフラグ。これは、"atype" : "authCheck" 監査フィルターにのみ適用されます。このパラメータを true に設定すると、クラスターのパフォーマンスが低下します。

システム監査メッセージ
auditFilter
string

レコードするイベントを指定する JSON ドキュメント。一重引用符や二重引用符など、解析を妨げる可能性のある文字は、バックスラッシュ（\）を使用してエスケープします。

カスタム監査フィルター
enabled
ブール値
デフォルト: false

指定されたプロジェクトに対して誰かがデータベース監査を有効にしたかどうかを示すフラグ。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "enabled": false
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "NONE",
  • "enabled": false
}

AWS クラスター DNS

AWS での MongoDB Cloud データベース配置のカスタム DNS 構成の返却と編集を行います。リソースにはプロジェクト ID が必要です。AWS で VPC ピアリングを使用し、Amazon Route 53 の代わりに独自の DNS サーバーを使用する場合は、カスタム DNS を有効にします。2020 年 3 月 31 日より前は、カスタム DNS サービスを使用して AWS 内に配置され、MongoDB Cloud と VPC ピアリングされたアプリケーションは、プライベート IP アドレス経由で接続できませんでした。カスタム DNS はパブリック IP アドレスに解決されました。AWS の内部 DNS がプライベート IP アドレスに解決されました。カスタム DNS サービスを使用して AWS に配置されたアプリケーションは、ピアリング接続文字列にプライベート IP を使用する必要があります。

AWS 上の Atlas クラスターの 1 つのカスタム DNS 構成を返す

指定されたプロジェクト内の AWS クラスターのカスタム DNS 構成を返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getAwscustomDns -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

AWS上の Atlas クラスターの 1 つのカスタム DNS 構成の状態を更新

指定されたプロジェクト内の AWS クラスターのカスタム DNS 構成を有効または無効にします。AWS VPC ピアリングを使用し、独自の DNS サーバーを使用する場合は、カスタム DNS を有効にします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Atlas の管理者ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクト内の AWS クラスターのカスタム DNS 構成を有効または無効にします。

enabled
必須
ブール値

AWS（Amazon Web Services）に配置されたプロジェクトのクラスターがカスタム DNS（Domain Name System）を使用するかどうかを示すフラグ。"enabled": true の場合は、ピアリング接続文字列にプライベート IP を使用してクラスターに接続します。

詳細については、MongoDB Atlas ドキュメントの「FAQ: 接続文字列オプション」を参照してください。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

クラウドバックアップ

クラウドバックアップ スナップショット、スナップショット エクスポート バケット、復元ジョブ、およびスケジュールを管理します。このリソースは、クラウドバックアップを使用するクラスターにのみ適用されます。

すべてのスナップショット エクスポート バケットを返す

指定されたプロジェクトに関連付けられているすべてのエクスポート バケットを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。非推奨バージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listExportBuckets --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{}

1 つのスナップショット エクスポート バケットを作成

AWS S3 バケット、Azure Blob ストレージ コンテナ、または Google Cloud ストレージ バケットのスナップショット エクスポート バケットを作成します。作成後、スナップショットはエクスポート バケットおよび参照先の AWS S3 バケット、Azure Blob ストレージ コンテナ、またはGoogle Cloud ストレージ バケットにエクスポートできます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。非推奨バージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-05-30+json

エクスポート バケットが参照するロールと AWS S3 バケット、Azure Blob ストレージ コンテナ、または Google Cloud ストレージ バケットを指定します。

cloudProvider
必須
string

スナップショットがエクスポートされるクラウドプロバイダーを識別する、人間が判読可能なラベル。

bucketName
必須
string [ 3 .. 63 ] 文字

ロールがエクスポートを許可されている AWS S3 バケットを識別する、人間が判読できるラベル。

iamRoleId
必須
string^([a-f0-9]{24})$

MongoDB Cloud が AWS S3 バケットにアクセスするために使用する Unified AWS Access ロール ID を識別する、一意の 24 桁の 16 進文字列。

統合 AWS アクセス ロール ID

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
例

Amazon Web Services

{
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "668c5f0ed436263134491592"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
例

Amazon Web Services

{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "668c5f0ed436263134491592",
  • "links": []
}

1 つのスナップショット エクスポート バケットを削除

エクスポートバケットを削除します。アクセスを取り消す前に、このエクスポートバケットにエクスポートしているこのプロジェクトのすべてのクラスターで、自動エクスポートを無効にする必要があります。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

exportBucketId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

エクスポート バケットを識別する一意の 24 16 進数文字string 。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api deleteExportbucket --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つのスナップショット エクスポート バケットを返す

指定されたプロジェクトに関連付けられた 1 つのエクスポート バケットを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。非推奨バージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

exportBucketId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

エクスポート バケットを識別する一意の 24 16 進数文字string 。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api getExportBucket --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
例

Amazon Web Services

{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "668c5f0ed436263134491592",
  • "links": []
}

バックアップ コンプライアンス ポリシー設定の無効化

指定されたプロジェクトのバックアップ コンプライアンス ポリシー設定を無効にします。前提条件として、サポートチケットを最初にファイルする必要があります。手順は https://www.mongodb.com/ja-jp/docs/atlas/backup/cloud-backup/backup-compliance-policy/ で閲覧できます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api disableDataProtectionSettings --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

バックアップ コンプライアンス ポリシー設定を返す

指定されたプロジェクトのバックアップ コンプライアンス ポリシー設定を返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。非推奨バージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getDataProtectionSettings --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "deletable": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ],
  • "state": "ACTIVE",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUser": "user@example.com"
}

バックアップ コンプライアンス ポリシー設定の更新

指定されたプロジェクトのバックアップ コンプライアンス ポリシー設定を更新します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。非推奨バージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

overwriteBackupPolicies
ブール値
デフォルト: true

非準拠のバックアップ ポリシーを新しいデータ保護設定で上書きするかどうかを示すフラグ。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-10-01+json

新しいバックアップ コンプライアンス ポリシー設定。

authorizedEmail
必須
string <email>

バックアップ コンプライアンス ポリシー設定の更新を許可したユーザーのメールアドレス。

authorizedUserFirstName
必須
string

バックアップ コンプライアンス ポリシー設定の更新を許可したユーザーの名。

authorizedUserLastName
必須
string

バックアップ コンプライアンス ポリシー設定の更新を許可したユーザーの姓。

copyProtectionEnabled
ブール値
デフォルト: false

追加のスナップショット リージョンが削除された場合でも、クラスター ユーザーが他のリージョンにコピーされたバックアップを削除できないようにするかどうかを示すフラグ。指定されていない場合、デフォルト値は false です。

encryptionAtRestEnabled
ブール値
デフォルト: false

バックアップ コンプライアンス ポリシーが設定されているすべてのクラスターで、カスタマー キー管理を使用した保管時の暗号化が必要かどうかを示すフラグ。指定されていない場合、デフォルト値は false です。

カスタマー キー管理を使用した保管時の暗号化
オブジェクト (BackupComplianceOnDemandPolicyItem)

オンデマンド ポリシーの仕様。

pitEnabled
ブール値
デフォルト: false

クラスターがバックアップ コンプライアンス ポリシーを使用して継続的なクラウドバックアップを使用するかどうかを示すフラグ。指定されていない場合、デフォルト値は false です。

継続的なクラウドバックアップ
projectId
string^([a-f0-9]{24})$

バックアップ コンプライアンス ポリシーの対象となるプロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

restoreWindowDays
integer <int32>

バックアップ コンプライアンス ポリシーを使用して継続的なクラウドバックアップで復元できる過去の日数。0 以外の正の整数を指定する必要があります。また、最大保持期間は 1 時間あたりの保持期間を超えることはできません。このパラメータは、バックアップ コンプライアンス ポリシーが設定された継続的なクラウドバックアップにのみ適用されます。

の配列 オブジェクト (BackupComplianceScheduledPolicyItem)

1 つのスケジュールされたポリシーの仕様を含むリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "deletable": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ],
  • "state": "ACTIVE",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUser": "user@example.com"
}

すべてのスナップショットのエクスポート ジョブを返す

指定した Atlas クラスターに関連付けられているすべてのクラウドバックアップ スナップショットのエクスポート ジョブを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Atlas の管理者ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

応答

リクエスト サンプル 

atlas api listBackupExportJobs --hel

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのスナップショット エクスポート ジョブを作成

クラウドバックアップを使用して、専用の Atlas クラスターの 1 つのバックアップ スナップショットをエクスポート バケットにエクスポートします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Atlas の管理者ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

作成するクラウドバックアップ スナップショットのエクスポート ジョブに関する情報。

の配列 オブジェクト (BackupLabel)

エクスポート ジョブの完了時に MongoDB Cloud がバケットにアップロードするメタデータ ファイルに追加するカスタム データを表すキーと値のペアのコレクション。

exportBucketId
必須
string^([a-f0-9]{24})$

エクスポート バケットを識別する一意の 24 16 進数文字string 。

snapshotId
必須
string^([a-f0-9]{24})$

エクスポートするクラウドバックアップ スナップショットを識別する一意の 24 桁の 16 進数文字string 。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "customData": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "components": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customData": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "exportStatus": {
    },
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "prefix": "string",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "Cancelled",
  • "stateReason": {
    }
}

1 つのスナップショットのエクスポート ジョブを返す

指定した Atlas クラスターに関連付けられている 1 つのクラウドバックアップ スナップショットのエクスポート ジョブを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Atlas の管理者ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

exportId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

24エクスポートstring ジョブを識別する一意の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api getBackupExportJob --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "components": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customData": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "exportStatus": {
    },
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "prefix": "string",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "Cancelled",
  • "stateReason": {
    }
}

1 つのクラスターのすべての復元ジョブを返す

指定されたプロジェクトから、1 つのクラスターに対するすべてのクラウドバックアップ復元ジョブを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

返す対象である復元ジョブを持つクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listBackupRestoreJobs --hel

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのクラスターの 1 つのスナップショットを復元

指定したプロジェクトから 1 つのクラスターの 1 つのスナップショットを復元します。Atlas は、オンデマンド スナップショットをすぐに取得し、スケジュールされたスナップショットを定期的に取得します。ステータスが queued または inProgress のオンデマンド スナップショットが存在する場合は、別のスナップショットを作成する前に、Atlas が以前に取得したオンデマンド スナップショットの処理を完了するまで待ちます。

このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定したプロジェクトから 1 つのクラスターの 1 つのスナップショットを復元します。

deliveryType
必須
string
列挙: "automated" 「ダウンロード」 "pointInTime"

作成する復元ジョブを分類する、人間が判読できるラベル。

oplogInc
integer <int32> >= 1

このスナップショットを復元したい Oplog 操作の番号。この数字は Oplog タイムスタンプの 2 番目の部分を表します。"deliveryType" : "pointInTime" および oplogTs が 0 を超えると、リソースはこのパラメータを返します。

oplogTs
integer <int32> >= 1199145600

このスナップショットを復元する日時。このパラメータは、このタイムスタンプを UNIX エポックからの経過秒数で表します。この数字は Oplog タイムスタンプの最初の部分を表します。"deliveryType" : "pointInTime" および oplogTs が 0 を超えると、リソースはこのパラメータを返します。

pointInTimeUTCSeconds
integer <int32> >= 1199145600

MongoDB Cloud がこのスナップショットを復元した日時。このパラメータは、このタイムスタンプを UNIX エポックからの経過秒数で表します。"deliveryType" : "pointInTime" および pointInTimeUTCSeconds が 0 を超えると、リソースはこのパラメータを返します。

snapshotId
string^([a-f0-9]{24})$

スナップショットを識別するユニークな 24 桁の 16 進数の文字列。

targetClusterName
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

復元ジョブがスナップショットを復元するターゲット クラスターを識別する、人間が判読できるラベル。リソースは、"deliveryType": "automated" の場合にこのパラメータを返します。automated と pointInTime の復元タイプでは必須です。

targetGroupId
string^([a-f0-9]{24})$

指定された targetClusterNameの のターゲット プロジェクトを識別する、ユニークな 24 桁 16 進数の文字列。automated と pointInTime の復元タイプでは必須です。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "components": [
    ],
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "privateDownloadDeliveryUrls": [
    ],
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

1 つのクラスターの 1 つの復元ジョブをキャンセル

指定されたプロジェクトからの 1 つのクラスターの、クラウドバックアップ復元ジョブを 1 件キャンセルします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

restoreJobId
必須
string^([a-f0-9]{24})$

削除する復元ジョブを識別するユニークな 24 桁の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api cancelBackupRestoreJob --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つのクラスターの 1 つの復元ジョブを返す

指定されたプロジェクトからの 1 つのクラスターの、クラウドバックアップ復元ジョブを 1 件返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

返す対象である復元ジョブを持つクラスターを識別する、人間が判読できるラベル。

restoreJobId
必須
string^([a-f0-9]{24})$

返す対象である復元ジョブを識別するユニークな 24 桁の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getBackupRestoreJob --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "components": [
    ],
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "privateDownloadDeliveryUrls": [
    ],
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

すべてのクラウドバックアップ スケジュールを削除

指定したクラスターのすべてのクラウドバックアップ スケジュールを削除します。このスケジュールは、MongoDB Cloud がスケジュールされたスナップショットをいつ取得するか、またそれらのスナップショットをどのくらいの期間保存するかを定義します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Atlas の管理者ロールが必要です。非推奨バージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api deleteAllBackupSchedules -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

1 つのクラウドバックアップ スケジュールを返す

指定したプロジェクト内の指定したクラスターのクラウドバックアップ スケジュールを返します。このスケジュールは、MongoDB Cloud がスケジュールされたスナップショットをいつ取得するか、またそれらのスナップショットをどのくらいの期間保存するかを定義します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。非推奨バージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getBackupSchedule --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

1つのクラスターのクラウドバックアップ スケジュールの更新

指定されたプロジェクト内の 1 つのクラスターのクラウドバックアップ スケジュールを更新します。このスケジュールは、MongoDB Cloud がスケジュールされたスナップショットをいつ取得するか、またそれらのスナップショットをどのくらいの期間保存するかを定義します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。非推奨バージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-08-05+json

指定されたプロジェクト内の 1 つのクラスターのクラウドバックアップ スケジュールを更新します。

注: リクエスト本文には、更新するフィールドのみを指定します。

autoExportEnabled
ブール値

MongoDB Cloud がクラウドバックアップ スナップショットをエクスポート バケットに自動的にエクスポートするかどうかを示すフラグ。

の配列 オブジェクト （DiskBackupCopySetting 20240805 ）

目的のバックアップ ポリシー内の各コピー設定アイテムのドキュメントを含むリスト。

の配列 オブジェクト （DeleteCopiedBackups 20240805 ）

削除対象のバックアップ コピーを持つ削除済みコピー設定ごとのドキュメントを含むリスト。

オブジェクト （エクスポート）

クラウドバックアップのスナップショットを自動的にエクスポートするポリシー。

の配列 オブジェクト (ExtraRetentionSetting)

目的のバックアップ ポリシー内の余分な保持設定アイテムごとのドキュメントを含むリスト。

の配列 オブジェクト (AdvancedDiskBackupSnapshotSchedulePolicy) <= 1 アイテム

このバックアップ スケジュールに設定されたルール。

referenceHourOfDay
integer <int32>

MongoDB Cloud がスナップショットを取得する時刻を表す UTC（Coordinated Universal Time、協定世界時）の時刻。

referenceMinuteOfHour
integer <int32>

MongoDB Cloud がスナップショットを取得する時間を表す referenceHourOfDay の分の単位。

restoreWindowDays
integer <int32>

継続的なクラウドバックアップの精度で復元できる過去の日数。0 以外の正の整数を指定する必要があります。このパラメータは継続的なクラウドバックアップにのみ適用されます。

updateSnapshots
ブール値

更新されたバックアップ ポリシーの保持の変更を、MongoDB Cloud が以前に取得したスナップショットに適用するかどうかを示すフラグ。

useOrgAndGroupNamesInExportPrefix
ブール値

MongoDB Cloud がエクスポート バケットにアップロードするメタデータ ファイルのパスに、組織 UUID とプロジェクト UUID の代わりに組織名とプロジェクト名を使用するかどうかを示すフラグ。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "autoExportEnabled": true,
  • "copySettings": [
    ],
  • "deleteCopiedBackups": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "updateSnapshots": true,
  • "useOrgAndGroupNamesInExportPrefix": true
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

すべてのレプリカセットのクラウドバックアップを返す

指定されたプロジェクトから 1 つのクラスターのすべてのスナップショットを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listReplicaSetBackups --hel

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのオンデマンド スナップショットを取得

指定されたクラスターのオンデマンド スナップショットを 1 つ取得します。Atlas は、オンデマンド スナップショットをすぐに取得し、スケジュールされたスナップショットを定期的に取得します。ステータスが queued または inProgress のオンデマンド スナップショットが存在する場合は、別のスナップショットを作成する前に、Atlas が以前に取得したオンデマンド スナップショットの処理を完了するまで待ちます。

このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

1 つのオンデマンド スナップショットを取得します。

説明
string

スナップショットの目的を説明する、人間が判読できるフレーズまたは文章。"status" : "onDemand" の場合、リソースはこのパラメータを返します。

retentionInDays
integer <int32> >= 1

MongoDB Cloud がスナップショットを保持する必要がある日数。最低でも 1 である必要があります。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "description": "string",
  • "retentionInDays": 1
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "replicaSetName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

1 つのシャーディングされたクラスターのクラウドバックアップを削除

指定されたプロジェクトから 1 つのシャーディングされたクラスターのスナップショットを 1 つ削除します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

snapshotId
必須
string^([a-f0-9]{24})$

目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api deleteShardedClusterBackup -- ヘルプ

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

1 つのシャーディングされたクラスターのクラウドバックアップを返す

指定されたプロジェクトから 1 つのシャーディングされたクラスターの 1 つのスナップショットを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

snapshotId
必須
string^([a-f0-9]{24})$

目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getShardedClusterBackup -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "configServerType": "EMBEDDED",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "members": [
    ],
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "snapshotIds": [
    ],
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

すべてのシャーディングされたクラスターのクラウドバックアップを返す

指定されたプロジェクトの 1 つのシャーディングされたクラスターのすべてのスナップショットを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listShardedClusterBackups --hel

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのレプリカセットのクラウドバックアップを削除

指定されたスナップショットを削除します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

snapshotId
必須
string^([a-f0-9]{24})$

目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api deleteReplicaSetBackup --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つのレプリカセットのクラウドバックアップを返す

指定されたクラスターから 1 つのスナップショットを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

snapshotId
必須
string^([a-f0-9]{24})$

目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getReplicaSetBackup --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "replicaSetName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

1 つのクラウドバックアップの有効期限を更新

指定されたプロジェクト内の 1 つのクラスターに対する 1 つのクラウド バックアップ スナップショットの有効期限を変更するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

snapshotId
必須
string^([a-f0-9]{24})$

目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクトの 1 つのクラスターの 1 つのクラウドバックアップ スナップショットの有効期限を変更します。

retentionUnit
必須
string
列挙: "DAYS" "WEEKS" "MONTHS" 「年」

MongoDB Cloud がスナップショットの保持を測定する時間の量。

retentionValue
必須
integer <int32>

MongoDB Cloud がスナップショットを保持する日数、週数、月数、または年数を示す数値。頻度の低いポリシーアイテムの場合、MongoDB Cloud では、頻度の高いポリシーアイテムに指定された値以上の値を指定する必要があります。時間単位のポリシーアイテムで 2 日間の保存が指定されている場合は、週単位のポリシーアイテムの保存期間として 2 日以上を指定します。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "retentionUnit": "DAYS",
  • "retentionValue": 5
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "replicaSetName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

1 つのサーバーレスインスタンスのすべての復元ジョブを返す

指定されたプロジェクトから 1 つのサーバーレスインスタンスのすべての復元ジョブを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

この API は、createServerlessInstance エンドポイントを使用して作成された Flex クラスター、またはサーバーレスインスタンスから移行された Flex クラスターでも使用できます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに listFlexBackupRestoreJobs エンドポイントを使用してください。

listFlexBackupRestoreJobs
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

サーバーレスインスタンスを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listServerlessBackupRestoreJobs --hel

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのサーバーレスインスタンスの 1 つのスナップショットを復元

指定されたプロジェクトから 1 つのサーバーレスインスタンスの 1 つのスナップショットを復元します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

この API は、createServerlessInstance エンドポイントを使用して作成された Flex クラスター、またはサーバーレスインスタンスから移行された Flex クラスターでも使用できます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに createFlexBackupRestoreJob エンドポイントを使用してください。

フレックスバックアップリストアジョブを作成する
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

復元対象のスナップショットを持つサーバーレスインスタンスを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクトから 1 つのサーバーレスインスタンスの 1 つのスナップショットを復元します。

deliveryType
必須
string
列挙: "automated" 「ダウンロード」 "pointInTime"

作成する復元ジョブを分類する、人間が判読できるラベル。

oplogInc
integer <int32> >= 1

このスナップショットを復元したい Oplog 操作の番号。この数字は Oplog タイムスタンプの 2 番目の部分を表します。"deliveryType" : "pointInTime" および oplogTs が 0 を超えると、リソースはこのパラメータを返します。

oplogTs
integer <int32> >= 1199145600

このスナップショットを復元する日時。このパラメータは、このタイムスタンプを UNIX エポックからの経過秒数で表します。この数字は Oplog タイムスタンプの最初の部分を表します。"deliveryType" : "pointInTime" および oplogTs が 0 を超えると、リソースはこのパラメータを返します。

pointInTimeUTCSeconds
integer <int32> >= 1199145600

MongoDB Cloud がこのスナップショットを復元した日時。このパラメータは、このタイムスタンプを UNIX エポックからの経過秒数で表します。"deliveryType" : "pointInTime" および pointInTimeUTCSeconds が 0 を超えると、リソースはこのパラメータを返します。

snapshotId
string^([a-f0-9]{24})$

スナップショットを識別するユニークな 24 桁の 16 進数の文字列。

targetClusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

復元ジョブがスナップショットを復元するターゲット クラスターを識別する、人間が判読できるラベル。リソースは、"deliveryType": "automated" の場合にこのパラメータを返します。

targetGroupId
必須
string^([a-f0-9]{24})$

指定された targetClusterName のターゲット プロジェクトを識別する、ユニークな 24 桁 16 進数の文字列。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

1 つのサーバーレスインスタンスの 1 つの復元ジョブを返す

指定されたプロジェクトから 1 つのサーバーレスインスタンスの 1 つの復元ジョブを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

この API は、createServerlessInstance エンドポイントを使用して作成された Flex クラスター、またはサーバーレスインスタンスから移行された Flex クラスターでも使用できます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに getFlexBackupRestoreJob エンドポイントを使用してください。

getFlexBackupRestoreJob
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

サーバーレスインスタンスを識別する、人間が判読できるラベル。

restoreJobId
必須
string^([a-f0-9]{24})$

返す対象である復元ジョブを識別するユニークな 24 桁の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getServerlessBackupRestoreJob --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

1 つのサーバーレスインスタンスのすべてのスナップショットを返す

指定されたプロジェクトから 1 つのサーバーレスインスタンスのすべてのスナップショットを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。

この API は、createServerlessInstance エンドポイントを使用して作成された Flex クラスター、またはサーバーレスインスタンスから移行された Flex クラスターでも使用できます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに listFlexBackups エンドポイントを使用してください。

listFlexBackups
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

サーバーレスインスタンスを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

応答

リクエスト サンプル 

atlas api listServerlessBackups --hel

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのサーバーレスインスタンスの 1 つのスナップショットを返す

指定されたプロジェクトの 1 つのサーバーレスインスタンスの 1 つのスナップショットを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。

このエンドポイントは、createServerlessInstance API で作成された Flex クラスターや、サーバーレスインスタンスから移行された Flex クラスターでもご利用いただけます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに getFlexBackup エンドポイントをご使用ください。

getFlexBackup
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

サーバーレスインスタンスを識別する、人間が判読できるラベル。

snapshotId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api getServerlessBackup --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongodVersion": "string",
  • "serverlessInstanceName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0
}

クラウド移行サービス

クラウド移行サービスを管理します。移行元の組織、プロジェクト、MongoDB クラスターは、Cloud Manager または Ops Manager に存在します。移行先の組織、プロジェクト、MongoDB クラスターは MongoDBngoDB Cloud に存在します。移行元のデータベースでは、SCRAM-SHA 以外の認証は使用できません。

1 つのローカル管理クラスターを MongoDB Atlas に移行

Cloud Manager または Ops Manager が管理する 1 つのクラスターを MongoDB Atlas に移行します。

移行を開始する前には、必ず移行を検証してください。

この API エンドポイントは、プッシュ ライブ移行にのみ使用できます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。

注意: 時系列コレクションの移行は、MongoDB 6.0 以降ではまだサポートされていません。MongoDB 6.0 以降での移行では、ソースクラスター上の時系列コレクションはすべてスキップされます。非推奨バージョン: v2-{2023-01-01}

移行を検証する
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-05-30+json

1 つの移行が作成されます。

必須
オブジェクト （移行先）

移行の宛先を説明するドキュメント。

dropDestinationData
ブール値
デフォルト: false

移行を開始する前に、移行プロセスが宛先クラスターからすべてのコレクションを削除するかどうかを示すフラグ。

migrationHosts
の配列 string = 1 アイテム

この移行に使用された移行ホストのリスト。

オブジェクト (ShardingRequest)

レプリカセット ソースから MongoDB 6.0 以降のシャーディングされたクラスターの宛先に移行する場合に、宛先クラスターでシャーディングを構成するドキュメント。宛先クラスターでコレクションをシャーディングしない場合は、これを空のままにします。

必須
オブジェクト （移行元）

移行の移行元を説明するドキュメント。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "destination": {
    },
  • "dropDestinationData": false,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "readyForCutover": true,
  • "status": "NEW"
}

1 つの移行リクエストを検証

提供された認証情報、使用可能なディスク容量、MongoDB のバージョンなどが移行リクエストの要件を満たしているかどうかを確認します。確認に合格すると、移行を続行できます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。非推奨のバージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-05-30+json

1 つの移行が検証されます。

必須
オブジェクト （移行先）

移行の宛先を説明するドキュメント。

dropDestinationData
ブール値
デフォルト: false

移行を開始する前に、移行プロセスが宛先クラスターからすべてのコレクションを削除するかどうかを示すフラグ。

migrationHosts
の配列 string = 1 アイテム

この移行に使用された移行ホストのリスト。

オブジェクト (ShardingRequest)

レプリカセット ソースから MongoDB 6.0 以降のシャーディングされたクラスターの宛先に移行する場合に、宛先クラスターでシャーディングを構成するドキュメント。宛先クラスターでコレクションをシャーディングしない場合は、これを空のままにします。

必須
オブジェクト （移行元）

移行の移行元を説明するドキュメント。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "destination": {
    },
  • "dropDestinationData": false,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "errorMessage": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

1 つの移行検証ジョブを返す

1 つの移行検証ジョブの状態を返します。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

validationId
必須
string^([a-f0-9]{24})$
例: 507f1f77bcf86cd799439011

検証ジョブを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api getValidationStatus --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "errorMessage": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

1 つの移行ジョブを返す

1 つのクラスター移行ジョブの詳細を返します。各プッシュ ライブ移行ジョブは、1 つの移行ホストを使用します。このリソースを正常に呼び出すには、API キーに組織ノード ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

liveMigrationId
必須
string^([a-f0-9]{24})$
例: 6296fb4c7c7aa997cf94e9a8

移行を識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getPusshMigration -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "readyForCutover": true,
  • "status": "NEW"
}

1 つの移行したクラスターのカットオーバー

移行されたクラスターを MongoDB Atlas にカットオーバーします。カットオーバーが完了したことを確認します。カットオーバーが完了すると、MongoDB Atlas はライブ移行プロセスを完了し、ソースクラスターとの同期を停止します。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

liveMigrationId
必須
string^([a-f0-9]{24})$
例: 6296fb4c7c7aa997cf94e9a8

移行を識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api waiterMigration --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

移行可能なすべてのプロジェクトを返す

指定された組織に移行できるすべてのプロジェクトを返します。

認可:
ServiceAccountsDigestAuth
path パラメータ
orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listSourceProjects --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1 つのトークンリンクを削除

1 つの組織リンクとそれに関連付けられた公開APIキーを削除します。MongoDB Atlas は、プッシュ ライブ移行にのみトークンリンクを使用します。ライブ移行（プッシュ）により、Cloud Manager または Ops Manager から MongoDB Atlas にデータを安全にプッシュできます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api deleteLinkToken --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つのトークンリンクを作成

リンクを完了するために必要なすべての情報を含む 1 つのトークンリンクを作成します。MongoDB Atlas は、プッシュ ライブ移行にのみトークンリンクを使用します。ライブ移行（プッシュ）により、Cloud Manager または Ops Manager から MongoDB Atlas にデータを安全にプッシュできます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

移行に関連付けられた IP アドレス アクセス リスト エントリ。

accessListIps
の配列 string

API キーに関連付けられた IP アドレス アクセス リスト エントリ。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "accessListIps": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "linkToken": "string"
}

クラウドプロバイダー アクセス

Atlas で AWS IAM ロールを返したり、追加、承認、削除したりします。

すべてのクラウドプロバイダーのアクセス ロールを返す

指定されたプロジェクトへのアクセス権を持つすべてのクラウドプロバイダー アクセス ロールを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listCloudProviderAccessRoles --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "awsIamRoles": [
    ],
  • "azureServicePrincipals": [
    ]
}

1 つのクラウドプロバイダーのアクセス ロールを作成

指定されたクラウドプロバイダーに対して 1 つのアクセス ロールを作成します。一部の MongoDB Cloud 機能では、認証にこれらのクラウドプロバイダー アクセス ロールを使用します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

クラウドプロバイダーへのアクセスを設定する
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたクラウドプロバイダーの 1 つのロールを作成します。

providerName
必須
string

ロールのクラウドプロバイダーを識別する、人間が判読できるラベル。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "providerName": "AWS"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "32b6e34b3d91647abb20e7b8"
}

1 つのクラウドプロバイダーのアクセス ロールの承認を解除

指定されたアクセス ロールの指定されたプロジェクトへのアクセスを取り消します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

cloudProvider
必須
string
列挙: "AWS" "AZURE" "GCP"

認証解除するロールのクラウドプロバイダーを識別する、人間が判読できるラベル。

roleId
必須
string^([a-f0-9]{24})$

ロールを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas apide authorizeCloudProviderAccessRole -- ヘルプ

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つのクラウドプロバイダーのアクセス ロールを返す

指定された ID と、指定されたプロジェクトへのアクセス権を持つアクセス ロールを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

roleId
必須
string^([a-f0-9]{24})$

ロールを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getCloudProviderAccessRole --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "32b6e34b3d91647abb20e7b8"
}

1 つのクラウドプロバイダーのアクセス ロールを承認

指定されたアクセス ロールの指定されたプロジェクトへのアクセス権を付与します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。この API エンドポイントは、MongoDB Cloud サービスの統合アクセスを作成する手順の 1 つです。GCP サービス アカウントへのアクセスには、これは必要ありません。

クラウドプロバイダーへのアクセスを設定する
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

roleId
必須
string^([a-f0-9]{24})$

ロールを識別するユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたアクセス ロールの指定されたプロジェクトへのアクセス権を付与します。

providerName
必須
string

ロールのクラウドプロバイダーを識別する、人間が判読できるラベル。

iamAssumedRoleArn
string [ 20 .. 2048 ] 文字

MongoDB Cloud が AWS アカウントのリソースにアクセスするときに引き受ける AWS（Amazon Web Services）ID と IAM（Identity and Access Management、ID とアクセス管理）ロールを識別する、ARN（Amazon Resource Name、Amazon リソース ネーム）です。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "providerName": "AWS",
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
例
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "32b6e34b3d91647abb20e7b8"
}

クラスター停止時シミュレーション

クラスターの停止時シミュレーションを返したり、開始したり、終了したりします。

1 つの停止時シミュレーションを終了

クラスターの停止時シミュレーションを終了します。

クラスター停止時シミュレーション
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

停止時シミュレーションを実行しているクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api endOutageSimulation -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2019-08-24T14:15:22Z",
  • "state": "START_REQUESTED"
}

1 つの停止時シミュレーションを返す

1 つのクラスターの 1 つの停止時シミュレーションを返します。

クラスター停止時シミュレーション
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

停止時シミュレーションを実行しているクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getOutageSimulation -- ヘルプ

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2019-08-24T14:15:22Z",
  • "state": "START_REQUESTED"
}

1 つの停止時シミュレーションを開始

クラスターの停止時シミュレーションを開始します。

クラスター停止時シミュレーション
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

停止時シミュレーションを実行するクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

停止時シミュレーションについて説明します。

の配列 オブジェクト (AtlasClusterOutageSimulationOutageFilter) non-empty

クラスターの停止時シミュレーションのタイプを指定する設定のリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "outageFilters": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2019-08-24T14:15:22Z",
  • "state": "START_REQUESTED"
}

クラスター

データベース配置を返したり、追加、編集、削除したりします。クラスター構成の変更はコストに影響を与えます。このリソースには、プロジェクトID が必要です。

すべてのプロジェクトで承認されたすべてのクラスターを返す

アクセス可能なすべてのプロジェクトのすべてのクラスターの詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。このレスポンスには、マルチクラウド クラスターは含まれません。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにクラスターレベルの任意のロールを持たせることができます。

認可:
ServiceAccountsDigestAuth
クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listClustersForAllProjects --hel

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのプロジェクトのすべてのクラスターを返す

アクセス可能な特定のプロジェクトのすべてのクラスターの詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。レスポンスには、非対称サイズのシャードがあるクラスターが含まれます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。この機能はサーバーレス クラスターでは利用できません。

このエンドポイントは、createCluster エンドポイントを使用して作成された Flex クラスターや、2026 年 1 月までに Flex クラスターに移行された旧 M2/M5 クラスターでも使用できます。Flex クラスターには、代わりに listFlexClusters エンドポイントを使用してください。非推奨バージョン: v2-{2023-02-01}、v2-{2023-01-01}

listFlexClusters
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
includeDeletedWithRetainedBackups
ブール値
デフォルト: false

バックアップを保持するクラスターを返すかどうかを示すフラグ。

応答

リクエスト サンプル 

atlas api listClusters --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのプロジェクトに 1 つのクラスターを作成

指定されたプロジェクトに 1 つのクラスターを作成します。クラスターには、同じデータセットを維持するホストのグループが含まれます。このリソースは、非対称サイズのシャードを持つクラスターを作成できます。各プロジェクトは最大 25 データベース配置をサポートします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。この機能はサーバーレス クラスターでは利用できません。

M2 または M5 の instanceSize を使用すると、代わりに Flex クラスターが作成されることにご注意ください。M2 または M5 のインスタンスサイズのサポートは、1月2026に終了します。今後、このような構成には createFlexCluster API を使用することをお勧めします。非推奨バージョン: v2-{2024-08-05}、v2-{2023-02-01}、v2-{2023-01-01}

createFlexCluster
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-10-23+json

このプロジェクトで作成するクラスター。

acceptDataRisksAndForceReplicaSetReconfig
string <date-time>

リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み（過半数がコミットされた書込みであっても）が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。 このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

リージョン停止時のレプリカセットの再構成
オブジェクト (ApiAtlasClusterAdvancedConfigurationView)

高度な構成の詳細のサブセットを構成する設定のグループ。

backupEnabled
ブール値
デフォルト: false

クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されている場合、クラスターはバックアップを実行できます。NVMe クラスターの場合、この値を true に設定する必要があります。バックアップは、専用クラスターにはクラウドバックアップを使用し、共有クラスター バックアップをテナント クラスターに使用します。false に設定されている場合は、クラスターはバックアップを使用しません。

クラウドバックアップ
オブジェクト （MongoDB Connector for Business Intelligence の設定）

このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。

MongoDB Connector for Business Intelligence
clusterType
string
列挙: "REPLICASET" "SHARDED" "GEOSHARDED"

クラスターを構成するノードの構成。

configServerManagementMode
string
デフォルト: "ATLAS_MANAGED"
列挙: "ATLAS_MANAGED" "FIXED_TO_DEDICATED"

シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。

ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。

FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。

MongoDB シャーディングされたクラスターのコンフィギュレーション サーバー
diskWarmingMode
string
デフォルト: "FULLY_WARMED"
列挙: "FULLY_WARMED" "VISIBLE_EARLIER"

ディスク ウォーミング モードの選択。

セカンダリ ディスク ウォーミングの影響軽減
encryptionAtRestProvider
string
列挙: "NONE" "AWS" "AZURE" "GCP"

カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマー キー管理を有効にするには、クラスター eplicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize の設定は、M10 以上、かつ "backupEnabled" : false または完全に省略する必要があります。

カスタマー キー管理を使用した保管時の暗号化
globalClusterSelfManagedSharding
ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。

false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。

true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。

この設定は、クラスターが配置されると変更できません。

グローバルクラスターの作成
の配列 オブジェクト （コンポーネント ラベル）
非推奨

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。

クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めします。

Resource Tags
オブジェクト (EmployeeAccessGrantView)

MongoDB 従業員に付与されるクラスターのアクセスレベルと有効期限。

mongoDBMajorVersion
string

クラスターのMongoDBメジャー バージョン。 バイナリ メジャー バージョンに設定します。

作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。

更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。

Atlas で利用可能な MongoDB のバージョン
name
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

paused
ブール値

クラスターが一時停止しているかどうかを示すフラグ。

pitEnabled
ブール値

クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。

継続的なクラウドバックアップ
redactClientLogData
ブール値

ログリダクションを有効または無効にします。

この設定では、ロギング前に特定のログ イベントに付随するメッセージからドキュメント フィールドの内容をすべて編集するように mongod または mongos を構成します。これにより、データベースに格納されている機密性が高い可能性のあるデータをプログラムが診断ログに書き込むことを防止します。エラー コードや操作 コード、行番号、ソース ファイル名などのメタデータは、引き続きログに表示されます。

規制要件へのコンプライアンスを支援するため、redactClientLogData を保管時の暗号化および TLS/SSL（トランスポート暗号化）と組み合わせて使用します。

注: クラスターでこの設定を変更すると、クラスターの更新後すぐにローリング再起動がトリガーされます。

ログ リダクション
replicaSetScalingStratey
string
デフォルト: "WORKLOAD_Type"
列挙: "SEQENTIAL" "WORKLOAD_Type" "NOde_type"

クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。

デフォルトでは、Atlas は WORKLOAD_Type の下でスケーリングされます。 このモードでは、Atlas は分析ノードを運用ノードと並行して拡張できます。

SEQUENTIAL として構成すると、Atlas はすべてのノードを順番にスケーリングします。 このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。

Node_type として構成すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。 このモードは、頻繁にクラスター階層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。 これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響を与える可能性があります。

レプリカセットのスケーリングモードの変更
の配列 オブジェクト （レプリケーションの仕様）

クラスター リージョンを構成する設定のリスト。 この配列には、各シャードのノード構成を表すシャードごとに 1 つのオブジェクトが含まれます。 レプリカセットの場合、ノード構成を表すオブジェクトは 1 つだけです。

rootCertType
string
デフォルト: "ISRGROOTX1"
値: "ISRGROOTX1"

MongoDB Atlasクラスターが使用するルート認証局。 MongoDB Cloud は Internet Security Research Group をサポートしています。

の配列 オブジェクト (Resource Tag)

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。

Resource Tags
terminationProtectionEnabled
ブール値
デフォルト: false

クラスターで終了保護が有効になっているかどうかを示すフラグ。true に設定されていると、MongoDB Cloud はクラスターを削除しません。false に設定されていると、MongoDB Cloud はクラスターを削除します。

versionReleaseSystem
string
デフォルト: "LTS"
列挙: "LTS" "CONTINUOUS"

クラスターが MongoDB のバージョンを管理する方法。値が CONTINUOUS の場合、mongoDBMajorVersion を指定しないでください。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-10-23+json

クラスター

{
  • "clusterType": "SHARDED",
  • "name": "myCluster",
  • "replicationSpecs": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-10-23+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "configServerType": "DEDICATED",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "featureCompatibilityVersion": "string",
  • "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBEmployeeAccessGrant": {},
  • "mongoDBMajorVersion": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "redactClientLogData": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

すべてのクラウドプロバイダーのリージョンを返す

指定された階層の指定されたクラウドプロバイダーで利用可能なリージョンのリストを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
providers
の配列 string

取得対象のリージョンを持つクラウドプロバイダー。複数のプロバイダーを指定した場合、レスポンスではマルチクラウド クラスターをサポートする階層とリージョンのみが返されます。

tier
string

リージョンを取得するクラスター階層。

応答

リクエスト サンプル 

atlas api listCloudProviderRegions --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つの共有階層クラスターのアップグレード

指定されたプロジェクトの共有階層クラスターを Flex または専有（M10+）クラスターにアップグレードします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーのロールが必要です。各プロジェクトは最大 25 クラスターに対応します。

このエンドポイントは、createCluster API を使用して作成された Flex クラスターや、2026 年 1 月までに「M2」または「M5」に instanceSizeName を使用して、Flex クラスターに移行された旧 M2 / M5 クラスターをアップグレードするためにも使用できます。この機能は2026 年 1 月まで利用可能で、それ以降は M0 クラスターでのみ利用可能です。代わりに、upgradeFlexCluster エンドポイントを使用してください。

FlexClusterをアップグレードする
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクト内の共有階層クラスターのアップグレードの詳細。

acceptDataRisksAndForceReplicaSetReconfig
string <date-time>

リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み（過半数がコミットされた書込みであっても）が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。 このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

リージョン停止時のレプリカセットの再構成
オブジェクト (ApiAtlasClusterAdvancedConfigurationView)

高度な構成の詳細のサブセットを構成する設定のグループ。

オブジェクト （自動クラスター スケーリング設定）

クラスターを増やすことができるインスタンス サイズの範囲。

クラスターの自動スケーリング
backupEnabled
ブール値

クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されていると、クラスターはバックアップを実行できます。NVMe クラスターの場合、この値を true に設定する必要があります。バックアップは、専用クラスターにはクラウドバックアップを使用し、テナントクラスターには共有クラスターバックアップを使用します。false に設定されていると、クラスターは MongoDB Cloud バックアップを使用しません。

オブジェクト （MongoDB Connector for Business Intelligence の設定）

このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。

MongoDB Connector for Business Intelligence
clusterType
string
列挙: "REPLICASET" "SHARDED" "GEOSHARDED"

クラスターを構成するノードの構成。

configServerManagementMode
string
デフォルト: "ATLAS_MANAGED"
列挙: "ATLAS_MANAGED" "FIXED_TO_DEDICATED"

シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。

ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。

FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。

MongoDB シャーディングされたクラスターのコンフィギュレーション サーバー
diskSizeGB
数値 <double> [ 10 .. 4096 ]

インスタンス データ ボリュームのストレージ容量（ギガバイト単位）。 この数を増やすと、容量が追加されます。

この値は、M 0 /M 2 /M 5クラスターでは構成できません。

MongoDB Cloud では、replicationSpecs を設定する場合にこのパラメータが必要です。

最小（ 10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。

ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。

ディスク ストレージの最大値は、選択したクラスターの最大 RAM の50倍を超えることはできません。 より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

diskWarmingMode
string
デフォルト: "FULLY_WARMED"
列挙: "FULLY_WARMED" "VISIBLE_EARLIER"

ディスク ウォーミング モードの選択。

セカンダリ ディスク ウォーミングの影響軽減
encryptionAtRestProvider
string
列挙: "NONE" "AWS" "AZURE" "GCP"

カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマー キー管理を有効にするには、クラスター eplicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize の設定は、M10 以上、かつ "backupEnabled" : false または完全に省略する必要があります。

カスタマー キー管理を使用した保管時の暗号化
globalClusterSelfManagedSharding
ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。

false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。

true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。

この設定は、クラスターが配置されると変更できません。

グローバルクラスターの作成
の配列 オブジェクト （コンポーネント ラベル）
非推奨

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。

クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めします。

Resource Tags
オブジェクト (EmployeeAccessGrantView)

MongoDB 従業員に付与されるクラスターのアクセスレベルと有効期限。

mongoDBMajorVersion
string

クラスターの MongoDB メジャー バージョン。

作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。

更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。

Atlas で利用可能な MongoDB のバージョン
mongoDBVersion
string([\d]+\.[\d]+\.[\d]+)

クラスターが実行する MongoDB のバージョン。

name
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

numShards
integer <int32> [ 1 .. 50 ]
デフォルト: 1

シャーディングされたクラスターに配置できるシャードの数は最大 50 個です。リソースは、レプリカセットを示す場合は 1 を返し、シャーディングされたクラスターを示す場合は 2 以上の値を返します。戻り値は、クラスター内のシャードの数と等しくなります。

シャーディング
paused
ブール値

クラスターが一時停止しているかどうかを示すフラグ。

pitEnabled
ブール値

クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。

継続的なクラウドバックアップ
providerBackupEnabled
ブール値

M10 以上のクラスターがクラウドバックアップを実行できるかどうかを示すフラグ。true に設定されていると、クラスターはバックアップを実行できます。これと backupEnabled が false に設定されている場合、クラスターは MongoDB Cloud バックアップを使用しません。

オブジェクト （クラスターのクラウド サービス プロバイダー設定）

プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。

replicaSetScalingStratey
string
デフォルト: "WORKLOAD_Type"
列挙: "SEQENTIAL" "WORKLOAD_Type" "NOde_type"

クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。

デフォルトでは、Atlas は WORKLOAD_Type の下でスケーリングされます。 このモードでは、Atlas は分析ノードを運用ノードと並行して拡張できます。

SEQUENTIAL として構成すると、Atlas はすべてのノードを順番にスケーリングします。 このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。

Node_type として構成すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。 このモードは、頻繁にクラスター階層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。 これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響を与える可能性があります。

レプリカセットのスケーリングモードの変更
replicationFactor
integer <int32>
非推奨
デフォルト: 3
列挙: 3 5 7

レプリカセットに属するノードの数。各ノードはデータベースのコピーを保持し、高可用性とデータの冗長性を提供します。代わりに replicationSpecs を使用してください。

オブジェクト （リージョン構成）

MongoDB Cloud がクラスター ノードをプロビジョニングする物理的なロケーション。

の配列 オブジェクト (LegacyReplicationSpec)

クラスター リージョンを構成する設定のリスト。

  • グローバルクラスターの場合、配列内の各オブジェクトは、MongoDB Cloud がクラスター ノードを配置する 1 つのゾーンを表します。
  • 非グローバルのシャーディングされたクラスターとレプリカセットの場合、1 つのオブジェクトは MongoDB Cloud がクラスター ノードを配置する場所を表します。
rootCertType
string
デフォルト: "ISRGROOTX1"
値: "ISRGROOTX1"

MongoDB Atlasクラスターが使用するルート認証局。 MongoDB Cloud は Internet Security Research Group をサポートしています。

の配列 オブジェクト (Resource Tag)

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。

Resource Tags
terminationProtectionEnabled
ブール値
デフォルト: false

クラスターで終了保護が有効になっているかどうかを示すフラグ。true に設定されていると、MongoDB Cloud はクラスターを削除しません。false に設定されていると、MongoDB Cloud はクラスターを削除します。

versionReleaseSystem
string
デフォルト: "LTS"
列挙: "LTS" "CONTINUOUS"

クラスターが MongoDB のバージョンを管理する方法。値が CONTINUOUS の場合、mongoDBMajorVersion を指定しないでください。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "mongoDBEmployeeAccessGrant": {
    },
  • "mongoDBMajorVersion": "5.0",
  • "mongoDBVersion": "5.0.25",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "configServerType": "DEDICATED",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "featureCompatibilityVersion": "string",
  • "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBEmployeeAccessGrant": {},
  • "mongoDBMajorVersion": "5.0",
  • "mongoDBVersion": "5.0.25",
  • "mongoURI": "string",
  • "mongoURIUpdated": "2019-08-24T14:15:22Z",
  • "mongoURIWithOptions": "string",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "srvAddress": "string",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

1 つの共有クラスターから 1 つのサーバーレスインスタンスへのアップグレード （非推奨）

このエンドポイントは、新しいサーバーレスインスタンスの作成がサポートされなくなったため、2025 年 2 月に廃止されました。Flex クラスターをアップグレードするには、upgradeFlexCluster エンドポイントをご使用ください。

指定されたプロジェクトの共有階層クラスターをサーバーレスインスタンスにアップグレードします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーのロールが必要です。

FlexClusterをアップグレードする
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクト内の共有階層クラスターのアップグレードの詳細。

name
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

サーバーレスインスタンスを識別する、人間が判読できるラベル。

必須
オブジェクト （サーバーレスインスタンスのクラウド サービス プロバイダー設定）

プロビジョニングされた MongoDB サーバーレスインスタンスを構成するクラウドプロバイダー設定のグループ。

オブジェクト （サーバーレス バックアップ オプション）

サーバーレス バックアップを構成する設定のグループ。

の配列 オブジェクト (Resource Tag)

サーバーレスインスタンスにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。

terminationProtectionEnabled
ブール値
デフォルト: false

サーバーレスインスタンスで終了保護が有効になっているかどうかを示すフラグ。true に設定されていると、MongoDB Cloud はサーバーレスインスタンスを削除しません。false に設定されていると、MongoDB Cloud はサーバーレスインスタンスを削除します。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

1 つのプロジェクトから 1 つのクラスタを削除

指定したプロジェクトからクラスターを 1 つ削除します。クラスターを削除するには、終了保護を無効にする必要があります。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。この機能はサーバーレス クラスターでは利用できません。

このエンドポイントは、createCluster エンドポイントを使用して作成された Flex クラスターや、2026 年 1 月までに Flex クラスターに移行された旧 M2/M5 クラスターでも使用できます。Flex クラスターには、代わりに deleteFlexCluster エンドポイントを使用してください。非推奨バージョン: v2-{2023-01-01}

deleteFlexCluster
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
retainBackups
ブール値

削除された専有クラスターのバックアップ スナップショットを保持するかどうかを示すフラグ。

応答

リクエスト サンプル 

atlas api deleteCluster --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つのプロジェクトから 1 つのクラスターを返す

指定されたプロジェクト内の 1 つのクラスターの詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。レスポンスには、非対称サイズのシャードがあるクラスターが含まれます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。この機能はサーバーレス クラスターでは利用できません。

このエンドポイントは、createCluster エンドポイントを使用して作成された Flex クラスターや、2026 年 1 月までに Flex クラスターに移行された旧 M2/M5 クラスターでも使用できます。Flex クラスターには、代わりに getFlexCluster エンドポイントをご利用ください。非推奨バージョン: v2-{2023-02-01}、v2-{2023-01-01}

getFlexCluster
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

このクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getCluster --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "configServerType": "DEDICATED",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "featureCompatibilityVersion": "string",
  • "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBEmployeeAccessGrant": {},
  • "mongoDBMajorVersion": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "redactClientLogData": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

1 つのプロジェクトの 1 つのクラスターを更新

指定されたプロジェクト内の 1 つのクラスターの詳細を更新します。クラスターには、同じデータセットを維持するホストのグループが含まれます。このリソースは、非対称サイズのシャードを持つクラスターを更新できます。クラスターの終了保護を更新するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーのロールが必要です。他のすべての更新については、リクエスト元のサービス アカウントまたは API キーにプロジェクト クラスター マネージャーのロールが必要です。一時停止中のクラスター（paused : true）を変更することはできません。 paused : false を設定するには、このエンドポイントを呼び出す必要があります。このエンドポイントが paused : false で応答したら、クラスターに変更を加えて再度呼び出せます。この機能はサーバーレス クラスターでは利用できません。非推奨バージョン: v2-{2024-08-05}、v2-{2023-02-01}、v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-10-23+json

指定されたプロジェクト内の更新するクラスター。

acceptDataRisksAndForceReplicaSetReconfig
string <date-time>

リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み（過半数がコミットされた書込みであっても）が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。 このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

リージョン停止時のレプリカセットの再構成
オブジェクト (ApiAtlasClusterAdvancedConfigurationView)

高度な構成の詳細のサブセットを構成する設定のグループ。

backupEnabled
ブール値
デフォルト: false

クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されている場合、クラスターはバックアップを実行できます。NVMe クラスターの場合、この値を true に設定する必要があります。バックアップは、専用クラスターにはクラウドバックアップを使用し、共有クラスター バックアップをテナント クラスターに使用します。false に設定されている場合は、クラスターはバックアップを使用しません。

クラウドバックアップ
オブジェクト （MongoDB Connector for Business Intelligence の設定）

このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。

MongoDB Connector for Business Intelligence
clusterType
string
列挙: "REPLICASET" "SHARDED" "GEOSHARDED"

クラスターを構成するノードの構成。

configServerManagementMode
string
デフォルト: "ATLAS_MANAGED"
列挙: "ATLAS_MANAGED" "FIXED_TO_DEDICATED"

シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。

ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。

FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。

MongoDB シャーディングされたクラスターのコンフィギュレーション サーバー
diskWarmingMode
string
デフォルト: "FULLY_WARMED"
列挙: "FULLY_WARMED" "VISIBLE_EARLIER"

ディスク ウォーミング モードの選択。

セカンダリ ディスク ウォーミングの影響軽減
encryptionAtRestProvider
string
列挙: "NONE" "AWS" "AZURE" "GCP"

カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマー キー管理を有効にするには、クラスター eplicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize の設定は、M10 以上、かつ "backupEnabled" : false または完全に省略する必要があります。

カスタマー キー管理を使用した保管時の暗号化
globalClusterSelfManagedSharding
ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。

false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。

true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。

この設定は、クラスターが配置されると変更できません。

グローバルクラスターの作成
の配列 オブジェクト （コンポーネント ラベル）
非推奨

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。

クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めします。

Resource Tags
オブジェクト (EmployeeAccessGrantView)

MongoDB 従業員に付与されるクラスターのアクセスレベルと有効期限。

mongoDBMajorVersion
string

クラスターのMongoDBメジャー バージョン。 バイナリ メジャー バージョンに設定します。

作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。

更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。

Atlas で利用可能な MongoDB のバージョン
name
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

paused
ブール値

クラスターが一時停止しているかどうかを示すフラグ。

pitEnabled
ブール値

クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。

継続的なクラウドバックアップ
redactClientLogData
ブール値

ログリダクションを有効または無効にします。

この設定では、ロギング前に特定のログ イベントに付随するメッセージからドキュメント フィールドの内容をすべて編集するように mongod または mongos を構成します。これにより、データベースに格納されている機密性が高い可能性のあるデータをプログラムが診断ログに書き込むことを防止します。エラー コードや操作 コード、行番号、ソース ファイル名などのメタデータは、引き続きログに表示されます。

規制要件へのコンプライアンスを支援するため、redactClientLogData を保管時の暗号化および TLS/SSL（トランスポート暗号化）と組み合わせて使用します。

注: クラスターでこの設定を変更すると、クラスターの更新後すぐにローリング再起動がトリガーされます。

ログ リダクション
replicaSetScalingStratey
string
デフォルト: "WORKLOAD_Type"
列挙: "SEQENTIAL" "WORKLOAD_Type" "NOde_type"

クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。

デフォルトでは、Atlas は WORKLOAD_Type の下でスケーリングされます。 このモードでは、Atlas は分析ノードを運用ノードと並行して拡張できます。

SEQUENTIAL として構成すると、Atlas はすべてのノードを順番にスケーリングします。 このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。

Node_type として構成すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。 このモードは、頻繁にクラスター階層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。 これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響を与える可能性があります。

レプリカセットのスケーリングモードの変更
の配列 オブジェクト （レプリケーションの仕様）

クラスター リージョンを構成する設定のリスト。 この配列には、各シャードのノード構成を表すシャードごとに 1 つのオブジェクトが含まれます。 レプリカセットの場合、ノード構成を表すオブジェクトは 1 つだけです。

rootCertType
string
デフォルト: "ISRGROOTX1"
値: "ISRGROOTX1"

MongoDB Atlasクラスターが使用するルート認証局。 MongoDB Cloud は Internet Security Research Group をサポートしています。

の配列 オブジェクト (Resource Tag)

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。

Resource Tags
terminationProtectionEnabled
ブール値
デフォルト: false

クラスターで終了保護が有効になっているかどうかを示すフラグ。true に設定されていると、MongoDB Cloud はクラスターを削除しません。false に設定されていると、MongoDB Cloud はクラスターを削除します。

versionReleaseSystem
string
デフォルト: "LTS"
列挙: "LTS" "CONTINUOUS"

クラスターが MongoDB のバージョンを管理する方法。値が CONTINUOUS の場合、mongoDBMajorVersion を指定しないでください。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-10-23+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "mongoDBEmployeeAccessGrant": {
    },
  • "mongoDBMajorVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "redactClientLogData": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-10-23+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "configServerType": "DEDICATED",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "featureCompatibilityVersion": "string",
  • "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBEmployeeAccessGrant": {},
  • "mongoDBMajorVersion": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "redactClientLogData": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

1 つのシャードクラスタのオートスケーリング構成を返す 非推奨

シャーディングされたクラスターの AutoScaling の内部構成を返します。このエンドポイントとなる接続されたデバイスは診断目的で使用でき、古い API から更新されたシャーディングされたクラスターが各シャードのオートスケーリングを個別にサポートするようになったことを確認するために使用されます。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

このクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api autoScalingConfiguration --hel

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "autoScalingMode": "INDEPENDENT_SHARD_SCALING"
}

1 つのクラスターの高度な構成オプションを返す

指定されたプロジェクト内の 1 つのクラスターの高度な構成の詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。高度な設定の詳細には、読み取り保証/書込み保証、インデックス制限および oplog 制限、およびその他のデータベース設定が含まれます。この機能は、M0 無料クラスター、M2 および M5 の共有階層クラスター、Flex クラスター、またはサーバーレス クラスターでは使用できません。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。非推奨バージョン: v2-{2023-01-01}

グローバルクラスター
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getClusterAdvancedConfiguration --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultWriteConcern": "string",
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "tlsCipherConfigMode": "CUSTOM",
  • "transactionLifetimeLimitSeconds": 1
}

1 つのクラスターの高度な構成オプションを更新

指定されたプロジェクト内の 1 つのクラスターの高度な構成の詳細を更新します。クラスターには、同じデータセットを維持するホストのグループが含まれます。高度な設定の詳細には、読み取り保証/書込み保証、インデックス制限および oplog 制限、およびその他のデータベース設定が含まれます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーのロールが必要です。この機能は、M0 無料クラスター、M2 および M5 の共有階層クラスター、 Flex クラスター、またはサーバーレス クラスターでは使用できません。非推奨バージョン: v2-{2023-01-01}

グローバルクラスター
認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-08-05+json

指定されたプロジェクト内の 1 つのクラスターに追加する高度な構成の詳細。

changeStreamOptionsPreAndPostImagesExpirationAfterSeconds
integer <int32>
デフォルト: -1

変更前と変更後のイメージの最小保持時間（秒単位）。

このオプションは ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` クラスター パラメータ。 この設定は、変更ストリームの変更前と変更後のイメージの保持ポリシーを制御します。 変更前と変更後のイメージは、それぞれドキュメント変更前と変更後のドキュメントのバージョンです。 ``expireAfterSeconds`` は、MongoDB が変更前と変更後のイメージを保持する期間を制御します。 - 1 （オフ）に設定すると、MongoDB はデフォルトの保持ポリシーを使用します。対応する変更ストリーム イベントが oplog から削除されるまで、変更前と変更後のイメージは保持されます。 変更前と変更後のイメージの最小保持時間を設定するには、0 より大きい整数値を指定します。 この値が低く設定しすぎると、Realm 同期や trigger の処理が中断されるリスクが高まります。 デフォルト値は - 1 （オフ）です。
chunkMigrationConcurrency
integer <int32>

チャンク移行のソース シャードおよび受信シャード上のスレッドの数。スレッドの数は、シャーディングされたクラスター内の CPU コアの合計数の半分を超えてはなりません。

このオプションは、`chunkMigrationConcurrency` `mongod` 構成ファイル オプションに相当します。
customOpensslCisphereConfigTls12
の配列 string
アイテム列挙: "TLS_ECDHE_RSA_With_AES_256_GCM_SHA384" "TLS_ECDHE_RSA_With_AES_128_GCM_SHA256"

TLS 1.2 のカスタム OpenSSL 暗号スイート リスト。 このフィールドは、tlsCipherConfigMode が CUSTOM に設定されている場合にのみ有効です。

このオプションは、`opensslCisphereConfig` `mongod`構成ファイルオプションに相当します。
デフォルトMaxTimeMS
integer <int32>

個々の読み取り操作完了のためのデフォルトの時間制限（ミリ秒単位）。

このオプションは、defaultMaxTimeMS クラスター パラメータに対応します。
defaultWriteConcern
string

ドライバーによって何も指定されていない場合に、書込み (write) 操作に対して MongoDB が要求する確認応答のデフォルト レベル。

このオプションは、暗黙のデフォルトの書込み保証 (write concern) に相当します。
javascriptEnabled
ブール値

クラスターが JavaScript のサーバー側実行を行う操作の許可の是非を示すフラグ。8.0+ を使用する場合、よりパフォーマンスの高い代替手段として、サーバーサイドの JavaScript を無効にし、集約パイプラインの演算子を使用することをお勧めします。

このオプションは、クラスター内の `mongod` および `mongos` それぞれの`security.javascriptEnabled` の構成ファイル オプションを変更することに相当します。
minimumEnabledTlsProtocol
string
列挙: "TLS1_0" "TLS1_1" "TLS1_2"

クラスターが受信接続に受け入れる TLS（Transport Layer Security）の最小バージョン。TLS 1.0 または 1.1 を使用するクラスターでは、TLS プロトコルの最小バージョンとして TLS 1.2 を設定することを検討する必要があります。

このオプションは、`net.ssl.disabledProtocols` `mongod` 構成ファイル オプションに相当します。
noTableScan
ブール値

結果を返すためにコレクションスキャンが必要なクエリについて、クラスターで実行が無効化されているかどうかを示すフラグ。

このオプションは、`notablescan` `mongod` 構成ファイル オプションに相当します。
oplogMinRetentionHours
数値または null <double>

クラスターの oplog の最小保持ウィンドウ（単位は時間）。null 値の場合、MongoDB Cloud が計算するデフォルトの最小 oplog window をクラスターが使用することを示します。

このオプションは `storage.oplogMinRetentionHours` `mongod` 構成ファイル オプションに相当します。
oplogSizeMB
整数または null <int32>

クラスターの oplog のストレージ制限（単位はメガバイト）。null 値の場合、MongoDB Cloud が計算するデフォルトの oplog サイズをクラスターが使用することを示します。

このオプションは、`replication.oplogSizeMB` `mongod` 構成ファイル オプションに相当します。
queryStatsLogVerbosity
integer <int32>

1（無効）または 3（有効）に設定できます。3 に設定されている場合、Atlas は編集され、匿名化された $queryStats 出力を MongoDB ログに含めます。$queryStats 出力にはリテラル値またはフィールド値は含まれません。この設定を有効にすると、クラスターのパフォーマンスに影響を与える可能性があります。

このオプションは、logComponentVerbosity サーバー パラメータの queryStats コンポーネントに相当します。
sampleRefreshIntervalBIConnector
integer <int32> >= 0
デフォルト: 0

mongosqld プロセスがデータを再サンプリングしてリレーショナル スキーマを作成する間隔（単位は秒）。

このオプションは、`sampleRefreshIntervalSecs` `mongosqld` オプションに相当します。
sampleSizeBIConnector
integer <int32> >= 0

スキーマ情報を収集するときにサンプリングするデータベースあたりのドキュメントの数。

このオプションは、`sampleSize` `mongosqld` オプションに相当します。
tlsCisphereConfigMode
string
列挙: "CUSTOM" "DEFAULT"

TLS 暗号スイートの 構成モード。 デフォルトモードでは、デフォルトの暗号スイートが使用されます。 カスタムモードでは、 TLS 1.2 と TLS 1.3 の両方のカスタム暗号スイートを指定できます。

transactionLifetimeLimitSeconds
integer <int64> >= 1

マルチドキュメントトランザクションの有効期間（単位は秒）。Atlas は、この制限を超えるトランザクションは期限切れと見なし、定期的なクリーンアップ プロセスによって中断します。

このオプションは、`transactionLifetimeLimitSeconds` `mongod` 構成ファイル オプションに相当します。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultWriteConcern": "string",
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "tlsCipherConfigMode": "CUSTOM",
  • "transactionLifetimeLimitSeconds": 1
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultWriteConcern": "string",
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "tlsCipherConfigMode": "CUSTOM",
  • "transactionLifetimeLimitSeconds": 1
}

1 つのクラスターのフェイルオーバーのテスト

指定されたプロジェクト内の指定されたクラスターのフェイルオーバー テストを開始します。クラスターには、同じデータセットを維持するホストのグループが含まれます。フェイルオーバー テストは、MongoDB Cloud がクラスターのプライマリ ノードの障害をどのように取り扱うかを確認します。テスト中、MongoDB Cloud はプライマリ ノードをシャットダウンし、新しいプライマリを選択します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーのロールが必要です。非推奨バージョン: v2-{2023-01-01}

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api TestFailover -- ヘルプ

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

すべてのクラスター操作のステータスを返す

指定されたプロジェクト内の指定されたクラスターに対して行ったすべての変更のステータスを返します。このリソースを使用して、MongoDB Cloud による変更プロセスの進行状況を確認します。レスポンスには、新しい専有クラスターの配置は含まれません。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

クラスターを識別する人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getClusterStatus --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{}

1 つのクラスターのMongoDB従業員クラスターアクセス権の付与

MongoDB 従業員クラスター アクセスは、指定された期間と 1 つのクラスターに対して指定されたレベルで付与されます。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

このクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-08-05+json

アクセス レベルと有効期限を付与します。

expirationTime
必須
string <date-time>

従業員アクセス権の有効期限。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

granType
必須
string
列挙: "CLUSTER_DATABASE_LOGS" "CLUSTER_INFREE" "CLUSTER_INFREE_AND_AP_SERVICES_SYNC_DATA"

MongoDB 従業員に付与するアクセス権のレベル。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-08-05+json
{
  • "expirationTime": "2019-08-24T14:15:22Z",
  • "grantType": "CLUSTER_DATABASE_LOGS"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つのプロジェクトの 1 つのクラスターの機能互換性バージョン

機能の互換性バージョン（FCV）を現在のMongoDBバージョンに固定し、固定の有効期限を設定します。クラスターに FCV ピンがすでに存在する場合、このメソッドを呼び出すと既存のピンの有効期限のみが更新され、FCV は再固定されません。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

このクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2024-05-30+json

FCV 固定構成を調整するための任意のリクエスト パラメーター。

expirationDate
string <date-time>

固定 FCV の有効期限。指定しない場合、有効期限は、FCV が最初に固定された日からデフォルトで 4 週間になります。このフィールドは固定された日付から 4 週間を超えることはできないことに注意してください。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2024-05-30+json
{
  • "expirationDate": "2019-08-24T14:15:22Z"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つのクラスターのMongoDB従業員クラスターアクセスを取り消す

以前に付与された MongoDB 従業員クラスターへのアクセスを取り消します。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

このクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api revokeMongoDbEmployeeAccess --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つのプロジェクトの 1 つのクラスターの機能の互換性バージョンの固定を解除します

固定されている機能の互換性バージョン（FCV）の固定を解除します。この機能は、Rapid Release のクラスターでは使用できません。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

このクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api unpingFeatureCompatibilityVersion --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

サンプル データセットを 1 つのクラスターにロード

MongoDB サンプル データセットを指定したクラスターにロードすることを要求します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

name
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

サンプル データセットをロードするクラスターを識別する、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api loadSampleDataset --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

1 つのクラスターのサンプル データセット ロードのステータスを返す

サンプル データセットを 1 つのクラスターにロードする進行状況を確認します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

sampleDatasetId
必須
string^([a-f0-9]{24})$

ロードされたサンプル データセットを識別するユニークな 24 桁の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api getSampleDatasetLoadStatus --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

コレクション レベルのメトリクス

指定されたクラスターまたはプロセスの固定された名前空間の返却、追加、編集を行います。コレクション レベルのレイテンシ メトリクス データも返します。

ピン留めされた名前空間を返す

指定されたクラスターの固定された名前空間のリストを返します。これは、クエリ レイテンシ メトリクスを収集するためにユーザーが手動で選択した名前空間のセットです。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

固定された名前空間を取得するためのクラスターを識別する、人間が判読可能なラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api getPinnedNamespaces --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "pinnedNamespaces": [
    ]
}

ピン留めされた名前空間を追加する

指定された名前空間のリストを既存の固定された名前空間リストに追加して、特定のグループとクラスターのコレクションレベルのレイテンシ メトリクスを収集します。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

名前空間を固定するクラスターを識別する、人間が判読可能なラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

リクエスト ボディ スキーマ: application/vnd.atlas.2023-11-15+json

クエリ レイテンシ メトリクス コレクション用に固定する名前空間文字列（データベース名とコレクション名の組み合わせ）のリスト。

名前空間
の配列 string unique

指定されたホストまたはクラスター上の名前空間文字列（データベースとコレクションの組み合わせ）のリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "pinnedNamespaces": [
    ]
}

名前空間を固定する

指定されたグループとクラスターのコレクションレベルのレイテンシ メトリクスを収集するために、指定された名前空間のリストを固定します。これにより、グループとクラスターに対して、固定された名前空間リストが初期化されるか、既存の固定された名前空間リストが置き換えられます。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

名前空間を固定するクラスターを識別する、人間が判読可能なラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

リクエスト ボディ スキーマ: application/vnd.atlas.2023-11-15+json

クエリ レイテンシ メトリクス コレクション用に固定する名前空間文字列（データベース名とコレクション名の組み合わせ）のリスト。

名前空間
の配列 string unique

指定されたホストまたはクラスター上の名前空間文字列（データベースとコレクションの組み合わせ）のリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "pinnedNamespaces": [
    ]
}

名前空間の固定を解除します

指定されたグループとクラスターのコレクション レベルのレイテンシ メトリクス収集のために、指定された名前空間のリストの固定を解除します。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

名前空間の固定を解除するクラスターを識別する、人間が判読可能なラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

リクエスト ボディ スキーマ: application/vnd.atlas.2023-11-15+json

クエリ レイテンシ メトリクス コレクション用に固定する名前空間文字列（データベース名とコレクション名の組み合わせ）のリスト。

名前空間
の配列 string unique

指定されたホストまたはクラスター上の名前空間文字列（データベースとコレクションの組み合わせ）のリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "pinnedNamespaces": [
    ]
}

クラスターからランク付けされた名前空間を返す

指定されたクラスターから名前空間のサブセットを、指定された時間枠内の合計実行時間の最も長い順（降順）でソートして返します。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

名前空間を固定するクラスターを識別する、人間が判読可能なラベル。

clusterView
必須
string
列挙: 「プライマリ」 「セカンダリ」 "INDIVIDUAL_PROCESS"

メトリクスを取得するクラスター トポロジーを識別する、人間が判読可能なラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

始める
string <date-time>

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

end
string <date-time>

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

period
string
例: period=PT10H

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

応答

リクエスト サンプル 

atlas api getCollStatsLatencyNamespacesForCluster --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "identifierId": "string",
  • "rankedNamespaces": [
    ]
}

クラスターレベルのクエリ レイテンシを返す

指定された名前空間に対するコレクション統計レイテンシのクラスター レベルの測定値一覧を取得します。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

clusterName
必須
string^[a-zA-Z0-9][a-zA-Z0-9-]*$

メトリクスを取得するクラスターを識別する、人間が判読可能なラベル。

clusterView
必須
string
列挙: 「プライマリ」 「セカンダリ」 "INDIVIDUAL_PROCESS"

メトリクスを取得するクラスター トポロジーを識別する、人間が判読可能なラベル。

databaseName
必須
string
例: mydb

データベースを識別する、人間が判読可能なラベル。

コレクション名
必須
string
例: mycoll

コレクションを識別する、人間が判読可能なラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

メトリクス
の配列 string unique
アイテム列挙: "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_VALUE" "READS_P95_VALUE" "READS_P99_VALUE" "WRITES_OPS" "WRITES_LATENCY" "AVERAGE_WRITES_LATENCY" "WRITES_P50_VALUE" "WRITES_P95_VALUE" "WRITES_P99_VALUE" "COMMANDS_OPS" "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_VALUE" "COMMANDS_P95_VALUE" "COMMANDS_P99_VALUE" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_VALUE" "TOTAL_OPS_P95_VALUE" "TOTAL_OPS_P99_VALUE"

関連するデータ シリーズについて取得するメトリクスを含むリスト。このパラメーターを設定しない場合、このリソースはすべてのコレクション統計レイテンシのメトリクスに対するデータ シリーズを返します。

始める
string <date-time>

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

end
string <date-time>

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

period
string
例: period=PT10H

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

応答

リクエスト サンプル 

atlas api getCollStatsLatencyNamespaceClusterMeasurements --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "clusterView": "string",
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "measurements": [
    ],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

すべてのメトリクス名を返します

リクエスト時に指定されたプロジェクトに対して、使用可能なすべてのコレクション統計レイテンシのメトリクス名とそれぞれのユニットを返します。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api getCollStatsLatencyNamespaceMetrics -- ヘルプ

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

ホストからランク付けされた名前空間を返す

指定されたプロセスから名前空間のサブセットを、指定された時間枠内の合計実行時間が最も長い順（降順）で順位付けして返します。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: my.host.name.com:27017

MongoDB プロセスを提供するホスト名と IANA ポートの組み合わせ。ホストは MongoDB プロセス（mongod あるいは mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 あるいは IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

始める
string <date-time>

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

end
string <date-time>

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

period
string
例: period=PT10H

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

応答

リクエスト サンプル 

atlas api getCollStatsLatencyNamespacesForHost --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "identifierId": "string",
  • "rankedNamespaces": [
    ]
}

ホストレベルのクエリレイテンシを返す

指定された名前空間に対するコレクション統計レイテンシのプロセスレベルの測定値一覧を取得します。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: my.host.name.com:27017

MongoDB プロセスを提供するホスト名と IANA ポートの組み合わせ。ホストは MongoDB プロセス（mongod あるいは mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 あるいは IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

databaseName
必須
string
例: mydb

データベースを識別する、人間が判読可能なラベル。

コレクション名
必須
string
例: mycoll

コレクションを識別する、人間が判読可能なラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

メトリクス
の配列 string unique
アイテム列挙: "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_VALUE" "READS_P95_VALUE" "READS_P99_VALUE" "WRITES_OPS" "WRITES_LATENCY" "AVERAGE_WRITES_LATENCY" "WRITES_P50_VALUE" "WRITES_P95_VALUE" "WRITES_P99_VALUE" "COMMANDS_OPS" "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_VALUE" "COMMANDS_P95_VALUE" "COMMANDS_P99_VALUE" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_VALUE" "TOTAL_OPS_P95_VALUE" "TOTAL_OPS_P99_VALUE"

関連するデータ シリーズについて取得するメトリクスを含むリスト。このパラメーターを設定しない場合、このリソースはすべてのコレクション統計レイテンシのメトリクスに対するデータ シリーズを返します。

始める
string <date-time>

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

end
string <date-time>

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

period
string
例: period=PT10H

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

応答

リクエスト サンプル 

atlas api getCollStatsLatencyNamespaceHostMeasurements --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-11-15+json
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "measurements": [
    ],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

カスタムデータベースロール

カスタム データベースユーザーの権限ロールの返却、追加、編集、削除を行います。カスタムロールを使用して、MongoDB Cloud の組み込みロールでは記述できないアクションのカスタムセットを指定できます。プロジェクトレベルで、プロジェクト内のすべてのクラスターに対してカスタムロールを定義します。このリソースは、MongoDB 権限アクションのサブセットをサポートします。カスタムロールのアクションのサブセットを作成できます。カスタムロールアクションの幅広いリストを作成するには、MongoDB クラウド ユーザー インターフェースを使用してください。カスタムロールには、すべてのプロジェクトのクラスターがサポートし、プロジェクトのクラスターが使用する各 MongoDB バージョンと互換性のあるアクションを含める必要があります。たとえば、プロジェクトに MongoDB 4.2 クラスターがある場合、MongoDB 4.4 で導入されたアクションを使用するカスタムロールを作成することはできません。

1 つのプロジェクトのすべてのカスタムロールを返す

指定されたプロジェクトのカスタムロールをすべて返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api listCustomDatabaseRoles --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1 つのカスタムロールを作成

指定されたプロジェクトに 1 つのカスタムロールを作成します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに、プロジェクト オーナー ロール、プロジェクト ストリーム処理オーナー ロール、またはプロジェクト データベース アクセス管理者ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクトに 1 つのカスタムロールを作成します。

の配列 オブジェクト （データベース権限アクション）

ロールが付与する個々の権限アクションのリスト。

の配列 オブジェクト （継承された役割） unique

このカスタムロールが継承する組み込みロールのリスト。

roleName
必須
string

リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

1 つのプロジェクトから 1 つのカスタムロールを削除

指定されたプロジェクトからカスタムロールを 1 つ削除します。親ロールやアクションを持たない子ロールを 1 つ以上残すことになる場合、カスタムロールを削除することはできません。また、ロールが割り当てられないデータベースユーザーを 1 人以上残すことになる場合も、カスタムロールを削除できません。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに、プロジェクト オーナー ロール、プロジェクト ストリーム処理オーナー ロール、またはプロジェクト データベース アクセス管理者ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

roleName
必須
string

リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api deleteCustomDatabaseRole --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1 つのプロジェクトの 1 つのカスタムロールを返す

指定されたプロジェクトの 1 つのカスタムロールを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

roleName
必須
string

リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api getCustomDatabaseRole --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

1 つのプロジェクトの 1 つのカスタムロールを更新

指定されたプロジェクト内の 1 つのカスタムロールを更新します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに、プロジェクト オーナー ロール、プロジェクト ストリーム処理オーナー ロール、またはプロジェクト データベース アクセス管理者ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

roleName
必須
string

リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクト内の 1 つのカスタムロールを更新します。

の配列 オブジェクト （データベース権限アクション）

ロールが付与する個々の権限アクションのリスト。

の配列 オブジェクト （継承された役割） unique

このカスタムロールが継承する組み込みロールのリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ]
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

Data Federation

フェデレーティッドデータベースインスタンスの返却、追加、編集、削除を行います。このリソースには、プロジェクトIDが必要です。フェデレーティッドデータベースインスタンスの構成変更はコストに影響する可能性があります。

1 つのプロジェクトのすべてのフェデレーティッドデータベースインスタンスを返す

指定されたプロジェクト内のすべてのフェデレーティッドデータベースインスタンスの詳細を返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用以上のロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
タイプ
string
デフォルト: "USER"
列挙: "USER" "ONLINE_ARCHIVE"

返却対象のフェデレーティッドデータベースインスタンスのタイプ。

応答

リクエスト サンプル 

atlas api listFederatedDatabases --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1 つのプロジェクトに 1 つのフェデレーティッドデータベースインスタンスを作成

指定されたプロジェクトに 1 つのフェデレーティッドデータベースインスタンスを作成します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーまたはプロジェクト チャート管理者ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint
skipRoleValidation
ブール値
デフォルト: false

このリクエストで、リクエスト元 IAM ロールの S3 バケット読み取り可否を確認するかどうかを示すフラグ。AWS は、バケットに書き込む前に、ロールがバケット内のオブジェクトを一覧できるかどうかを確認します。一部の IAM ロールには書き込み権限のみが必要です。このフラグを使用すると、そのチェックをスキップできます。

リクエスト ボディ スキーマ: application/vnd.atlas.2023-01-01+json

指定されたプロジェクトに 1 つのフェデレーティッドデータベースインスタンスを作成するための詳細。

オブジェクト （データフェデレーション クラウドプロバイダー）

このフェデレーティッドデータベースインスタンスがホストされているクラウドプロバイダー。

オブジェクト (DataLakeDataProcessRegion)

フェデレーティッドデータベースインスタンスがクライアント接続をルーティングするクラウドプロバイダーのリージョンに関する情報。

name
string

フェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

オブジェクト (DataLakeStorage)

各データ ストアの構成情報と MongoDB Cloud データベースへのマッピング。

応答

リクエスト サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

1 つのプロジェクトから 1 つのフェデレーティッドデータベースインスタンスを削除

指定されたプロジェクトから 1 つのフェデレーティッドデータベースインスタンスを削除します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーまたはプロジェクト チャート管理者ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

tenantName
必須
string

削除対象のフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

Prettyprint

応答

リクエスト サンプル 

atlas api deleteFederatedDatabase --help

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

1 つのプロジェクトの 1 つのフェデレーティッドデータベースインスタンスを返す

指定されたプロジェクト内の 1 つのフェデレーティッドデータベースインスタンスの詳細を返します。このリソースを使用するには、リクエスト元の サービス アカウント またはAPIキーに プロジェクト読み取り専用 ロールまたは プロジェクト Charts 管理者 ロールが必要です。

認可:
ServiceAccountsDigestAuth
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

tenantName
必須
string

返却対象のフェデレーティッド データベースを特定する、人間が判読可能なラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

リクエスト サンプル 

atlas api getFederatedDatabase --help

応答サンプル

コンテンツタイプ
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {