MongoDB Atlas Administration API
Reduce によるAPI Docs

MongoDB Atlas Administration API (1.0)

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

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

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

Atlas Administration API では、リクエストの認証に HTTP ダイジェスト認証を使用します。HTTP リクエストを作成する際は、ユーザー名とパスワードとして、プログラマティック API 公開キーと、それに対応する秘密キーを指定する必要があります。たとえば、cURL を使用して データベース アクセス履歴を返すには、ターミナルで次のコマンドを実行します。

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

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

アクセス トラッキング

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

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

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

データベース アクセス履歴
認可:
DigestAuthServiceAccounts
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=false

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

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

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

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エポック時間を使用します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "accessLogs": [
    ]
}

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

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

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

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

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

Hostname
必須
string

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

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

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

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

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

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エポック時間を使用します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "accessLogs": [
    ]
}

Alert Configurations

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

すべてのアラート設定マッチャーのフィールド名を取得

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • "APPLICATION_ID"
]

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

1 つのプロジェクトのすべてのアラート構成を返します。これらのアラート構成は、プロジェクト内のどのコンポーネントにも適用されます。アラート構成では、アラートの Triggers と通知方法を定義します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

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

指定されたプロジェクトに対して 1 つのアラート構成を作成します。アラート構成では、アラートの Triggers と通知方法を定義します。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。

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

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

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

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

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

必須
請求イベント タイプ（オブジェクト）または Cps バックアップ イベント タイプ（オブジェクト）またはデータ保護イベント タイプ（オブジェクト）または FTS インデックス監査タイプ（オブジェクト）またはグループ イベント タイプ（オブジェクト）または NDS監査タイプ（オブジェクト）または NDS メンテナンスウィンドウ監査タイプ（オブジェクト）または「オンラインアーカイブイベント タイプ」（オブジェクト）または「 ユーザー イベント タイプ 」（オブジェクト）または「 リソース イベントタイプ 」（オブジェクト）または「 ストリームプロセッサ イベントタイプ 」（オブジェクト）または NDS オートスケーリング監査タイプ（オブジェクト）

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

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

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

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

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

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "matchers": [
    ],
  • "notifications": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

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

指定されたプロジェクトから 1 つのアラート構成を削除します。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。

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

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

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

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

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

アラート構成を識別するユニークな 24 桁の 16 進数の文字列。/alertConfigs エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのアラート構成を取得します。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
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 キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

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

アラート構成を識別するユニークな 24 桁の 16 進数の文字列。/alertConfigs エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのアラート構成を取得します。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

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

指定されたプロジェクト内の指定されたアラート構成を有効または無効にします。リソースは、指定されたアラート構成が現在有効になっている場合は有効にします。リソースは、指定されたアラート構成が現在無効になっている場合は無効にします。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。

注: このエンドポイントは、アラート構成の有効/無効状態のみを更新します。この構成以外を更新するには、「1 つのアラート構成の更新」を参照してください。

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

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

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

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

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

このアラートをトリガーしたアラート構成を識別するユニークな 24 桁の 16 進数の文字列。/alertConfigs エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのアラート構成を取得します。

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

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

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

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

リクエスト ボディ スキーマ: application/json

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

enabled
ブール値

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

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "enabled": true
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

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

指定されたプロジェクト内の 1 つのアラート構成を更新します。アラート構成では、アラートの Triggers と通知方法を定義します。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。

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

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

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

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

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

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

アラート構成を識別するユニークな 24 桁の 16 進数の文字列。/alertConfigs エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのアラート構成を取得します。

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

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

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

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

リクエスト ボディ スキーマ: application/json

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

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

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

必須
請求イベント タイプ（オブジェクト）または Cps バックアップ イベント タイプ（オブジェクト）またはデータ保護イベント タイプ（オブジェクト）または FTS インデックス監査タイプ（オブジェクト）またはグループ イベント タイプ（オブジェクト）または NDS監査タイプ（オブジェクト）または NDS メンテナンスウィンドウ監査タイプ（オブジェクト）または「オンラインアーカイブイベント タイプ」（オブジェクト）または「 ユーザー イベント タイプ 」（オブジェクト）または「 リソース イベントタイプ 」（オブジェクト）または「 ストリームプロセッサ イベントタイプ 」（オブジェクト）または NDS オートスケーリング監査タイプ（オブジェクト）

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

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

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

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

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

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "matchers": [
    ],
  • "notifications": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

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

指定されたアラートに設定されているすべてのアラート構成を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

アラート

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

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

指定されたアラート構成がトリガーするすべてのオープン アラートを返します。これらのアラート構成は、指定されたプロジェクトにのみ適用されます。アラート構成では、アラートの Triggers と通知方法を定義します。オープン アラートは、トリガーされていても、まだ未確認です。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

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

アラート構成を識別するユニークな 24 桁の 16 進数の文字列。/alertConfigs エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのアラート構成を取得します。

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

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

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

すべてのアラートを返します。これらのアラートは、1 つのプロジェクト内のすべてのコンポーネントに適用されます。モニター対象のコンポーネントが設定した値を満たすか超過すると、アラートを受け取ります。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

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

アラートを 1 つ返します。このアラートは、1 つのプロジェクト内の任意のコンポーネントに適用されます。モニター対象のコンポーネントが設定した値を満たすか超過すると、アラートを受け取ります。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ 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 キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。

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

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

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

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

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

acknowledgedUntil
string <date-time>

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

  • このアラートを永久的に確認するには、パラメータ値を 100 年後に設定します。

  • 以前に確認されたアラートを未確認にするには、このパラメータ値を設定しないでください。

ISO 8601
acknowledgementComment
string <= 200 文字

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

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days."
}

応答サンプル

コンテンツタイプ
application/ 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 カスタムアナライザを返します。 カスタムアナライザは、フィールドをインデックス化するために実行する操作を定義します。 このリソースを使用するには、リクエスト元の API キーにプロジェクトのデータアクセスに関する読み取りおよび書込みロールが必要です。

カスタムアナライザ
認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

1 つのクラスターのすべてのユーザー定義アナライザを更新

指定されたクラスター上の 1 つ以上の Atlas Search カスタムアナライザを更新します。 カスタムアナライザは、フィールドをインデックス化するために実行する操作を定義します。 このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。

カスタムアナライザ
認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/json

指定されたクラスター上の 1 つ以上の Atlas Search カスタムアナライザを更新します。

配列
の配列 htmlStrict（オブジェクト）、icuNormalize（オブジェクト）、または mapping（オブジェクト）、または Persian（オブジェクト）

テキストを 1 文字ずつ検査し、フィルタリング操作を実行するフィルター。

name
必須
string

カスタムアナライザを識別する、人間が判読できる名前。 名前はインデックス内で一意である必要があり、次のいずれかの文字列で始まらない必要があります。

  • lucene.
  • builtin.
  • mongodb.
の配列 Assci nGram（オブジェクト）、porterSteming（オブジェクト）、regex（オブジェクト）、またはレプリカセット（オブジェクト）、single（オブジェクト）、snowballStorage（オブジェクト）、spanishPluralSteming（オブジェクト）、ステミング（オブジェクト）、ストップワード（オブジェクト）、drim（オブジェクト）、またはwordDelimiterGraph (object)

次のような操作を実行するフィルター。

  • ステミング 。これにより、「toring」、「thaled」、「torages」などの関連単語を語幹単語の「torage」に減らします。

  • 編集 : 公開ドキュメントから機密情報を排除します。

必須
オブジェクト

トークンを作成するために使用する トークナイザ 。 トークンは、Atlas Search がインデックスを作成するためにテキストを個別のチャンクに分割する方法を決定します。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

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

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

Atlas Search インデックス
認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/json

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

コレクション名
必須
string

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

database
必須
string

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

name
必須
string

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

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

インデックスパーティションの数。 注：この機能は現在プレビュー段階です。

タイプ
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/ JSON
例
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "numPartitions": 1,
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

応答サンプル

コンテンツタイプ
application/ 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 インデックス
認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

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

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

Atlas Search インデックス
認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

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

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

Atlas Search インデックス
認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ 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 インデックス
認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/json

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

コレクション名
必須
string

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

database
必須
string

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

name
必須
string

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

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

インデックスパーティションの数。 注：この機能は現在プレビュー段階です。

タイプ
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/ JSON
例
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "numPartitions": 1,
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

応答サンプル

コンテンツタイプ
application/ 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": [
    ]
}

監査

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

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "NONE",
  • "enabled": false
}

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

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

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

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

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

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

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

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

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

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

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "enabled": false
}

応答サンプル

コンテンツタイプ
application/ 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 キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "enabled": true
}

AWS 上の Atlas クラスターの 1 つのカスタム DNS 構成の状態を切り替える

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

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

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

enabled
必須
ブール値

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

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

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "enabled": true
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "enabled": true
}

クラウドバックアップ

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

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

指定されたプロジェクトに関連付けられているすべてのエクスポート バケットを返します。 このリソースを使用するには、リクエスト元のAPIキーにプロジェクト読み取り専用ロールまたはプロジェクトバックアップマネージャー ロールが必要です。

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

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

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

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

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{}

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

指定されたAmazon Web Services S3 バケットのエクスポート バケットを作成します。 作成が完了すると、スナップショットはエクスポート バケットとその参照先のAmazon Web Services S3 バケットにエクスポートできます。 このリソース を使用するには、リクエスト元のAPIキーにプロジェクト バックアップ マネージャーのロールが必要です。

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

エクスポートAmazon Web Services 3バケットが参照するAmazon Web Services S バケットと IAM ロールを指定します。

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

ロールがエクスポートを許可されているAmazon Web Services S3 バケットまたはAzureストレージ コンテナを識別する、人間が判読できるラベル。

cloudProvider
必須
string
列挙: "AWS" "AZURE"

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

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

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

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8",
  • "links": []
}

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

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

認可:
DigestAuthServiceAccounts
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=false

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

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

指定されたプロジェクトに関連付けられた 1 つのエクスポート バケットを返します。 このリソースを使用するには、リクエスト元のAPIキーにプロジェクト読み取り専用ロールまたはプロジェクトバックアップマネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8",
  • "links": []
}

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

指定されたプロジェクトのバックアップ コンプライアンス ポリシー設定を返します。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ 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 キーにプロジェクト オーナーのロールが必要です。

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

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

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/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/ JSON
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ]
}

応答サンプル

コンテンツタイプ
application/ 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 の管理者ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

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

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

認可:
DigestAuthServiceAccounts
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=false

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

リクエスト ボディ スキーマ: application/json

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

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

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

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

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

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

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

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "customData": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/ 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 の管理者ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

応答

応答サンプル

コンテンツタイプ
application/ 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 キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

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

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

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

認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/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/ JSON
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/ 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 キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

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

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

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ 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 の管理者ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

応答

応答サンプル

コンテンツタイプ
application/ 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 キーにプロジェクトの読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ 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 キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/json

指定されたプロジェクト内の 1 つのクラスターのクラウドバックアップ スケジュールを更新します。

注: リクエスト本文には、更新するフィールドのみを指定します。

autoExportEnabled
ブール値

MongoDB Cloud がクラウドバックアップ スナップショットをエクスポート バケットに自動的にエクスポートするかどうかを示すフラグ。

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

目的のバックアップ ポリシー内の各コピー設定アイテムのドキュメントを含むリスト。

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

削除対象のバックアップ コピーを持つ削除済みコピー設定ごとのドキュメントを含むリスト。

オブジェクト （エクスポート）

クラウドバックアップのスナップショットを自動的にエクスポートするポリシー。

の配列 オブジェクト (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/ JSON
{
  • "autoExportEnabled": true,
  • "copySettings": [
    ],
  • "deleteCopiedBackups": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "updateSnapshots": true,
  • "useOrgAndGroupNamesInExportPrefix": true
}

応答サンプル

コンテンツタイプ
application/ 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 キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのオンデマンド スナップショットを取得

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

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

認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/json

1 つのオンデマンド スナップショットを取得します。

説明
string

スナップショットの目的を説明する、人間が判読できるフレーズまたは文章。"status" : "onDemand" の場合、リソースはこのパラメータを返します。

retentionInDays
integer <int32> >= 1

MongoDB Cloud がスナップショットを保持する必要がある日数。最低でも 1 である必要があります。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "description": "string",
  • "retentionInDays": 1
}

応答サンプル

コンテンツタイプ
application/ 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 キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

1 つのシャーディングされたクラスターのクラウドバックアップを返す

指定されたプロジェクトから 1 つのシャーディングされたクラスターの 1 つのスナップショットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ 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 キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのレプリカセットのクラウドバックアップを削除

指定されたスナップショットを削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト バックアップ マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

1 つのレプリカセットのクラウドバックアップを返す

指定されたクラスターから 1 つのスナップショットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ 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 キーにはプロジェクト バックアップ マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/json

指定されたプロジェクトの 1 つのクラスターの 1 つのクラウドバックアップ スナップショットの有効期限を変更します。

retentionUnit
必須
string
列挙: "DAYS" "WEEKS" "MONTHS" 「年」

MongoDB Cloud がスナップショットの保持を測定する時間の量。

retentionValue
必須
integer <int32>

MongoDB Cloud がスナップショットを保持する日数、週数、月数、または年数を示す数値。頻度の低いポリシーアイテムの場合、MongoDB Cloud では、頻度の高いポリシーアイテムに指定された値以上の値を指定する必要があります。時間単位のポリシーアイテムで 2 日間の保存が指定されている場合は、週単位のポリシーアイテムの保存期間として 2 日以上を指定します。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "retentionUnit": "DAYS",
  • "retentionValue": 5
}

応答サンプル

コンテンツタイプ
application/ 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
認可:
DigestAuthServiceAccounts
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=false

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのサーバーレスインスタンスの 1 つのスナップショットを復元

指定されたプロジェクトから 1 つのサーバーレスインスタンスの 1 つのスナップショットを復元します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

この API は、createServerlessInstance エンドポイントを使用して作成された Flex クラスター、またはサーバーレスインスタンスから移行された Flex クラスターでも使用できます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに createFlexBackupRestoreJob エンドポイントを使用してください。

フレックスバックアップリストアジョブを作成する
認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/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/ JSON
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/ 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
認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ 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
認可:
DigestAuthServiceAccounts
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=false

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのサーバーレスインスタンスの 1 つのスナップショットを返す

指定されたプロジェクトの 1 つのサーバーレスインスタンスの 1 つのスナップショットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

このエンドポイントは、createServerlessInstance API で作成された Flex クラスターや、サーバーレスインスタンスから移行された Flex クラスターでもご利用いただけます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに getFlexBackup エンドポイントをご使用ください。

getFlexBackup
認可:
DigestAuthServiceAccounts
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=false

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

応答

応答サンプル

コンテンツタイプ
application/ 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 以降での移行では、ソースクラスター上の時系列コレクションはすべてスキップされます。

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

1 つの移行が作成されます。

必須
オブジェクト （移行先）

移行の宛先を説明するドキュメント。

dropEnabled
必須
ブール値

移行を開始する前に、移行プロセスが宛先クラスターからすべてのコレクションを削除するかどうかを示すフラグ。

migrationHosts
の配列 string = 1 アイテム

この移行に使用された移行ホストのリスト。

オブジェクト (ShardingRequest)

レプリカセット ソースから MongoDB 6.0 以降のシャーディングされたクラスターの宛先に移行する場合に、宛先クラスターでシャーディングを構成するドキュメント。宛先クラスターでコレクションをシャーディングしない場合は、これを空のままにします。

必須
オブジェクト （移行元）

移行の移行元を説明するドキュメント。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "destination": {
    },
  • "dropEnabled": true,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "readyForCutover": true,
  • "status": "NEW"
}

1 つの移行リクエストを検証

提供された認証情報、使用可能なディスク容量、MongoDB のバージョンなどが移行リクエストの要件を満たしているかどうかを確認します。確認に合格すると、移行を続行できます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

1 つの移行が検証されます。

必須
オブジェクト （移行先）

移行の宛先を説明するドキュメント。

dropEnabled
必須
ブール値

移行を開始する前に、移行プロセスが宛先クラスターからすべてのコレクションを削除するかどうかを示すフラグ。

migrationHosts
の配列 string = 1 アイテム

この移行に使用された移行ホストのリスト。

オブジェクト (ShardingRequest)

レプリカセット ソースから MongoDB 6.0 以降のシャーディングされたクラスターの宛先に移行する場合に、宛先クラスターでシャーディングを構成するドキュメント。宛先クラスターでコレクションをシャーディングしない場合は、これを空のままにします。

必須
オブジェクト （移行元）

移行の移行元を説明するドキュメント。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "destination": {
    },
  • "dropEnabled": true,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "errorMessage": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

1 つの移行検証ジョブを返す

1 つの移行検証ジョブの状態を返します。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "errorMessage": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

1 つの移行ジョブを返す

1 つのクラスター移行ジョブの詳細を返します。各プッシュ ライブ移行ジョブは、1 つの移行ホストを使用します。このリソースを正常に呼び出すには、API キーに組織ノード ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "readyForCutover": true,
  • "status": "NEW"
}

移行したクラスターのカットオーバー

移行されたクラスターを MongoDB Atlas にカットオーバーします。カットオーバーが完了したことを確認します。カットオーバーが完了すると、MongoDB Atlas はライブ移行プロセスを完了し、ソースクラスターとの同期を停止します。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
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"
}

移行可能なすべてのプロジェクトを返す

指定された組織に移行できるすべてのプロジェクトを返します。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

1 つのトークンリンクを削除

1 つの組織リンクとそれに関連付けられた公開APIキーを削除します。MongoDB Atlas は、プッシュ ライブ移行にのみトークンリンクを使用します。ライブ移行（プッシュ）により、Cloud Manager または Ops Manager から MongoDB Atlas にデータを安全にプッシュできます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

1 つのトークンリンクを作成

リンクを完了するために必要なすべての情報を含む 1 つのトークンリンクを作成します。MongoDB Atlas は、プッシュ ライブ移行にのみトークンリンクを使用します。ライブ移行（プッシュ）により、Cloud Manager または Ops Manager から MongoDB Atlas にデータを安全にプッシュできます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

移行に関連付けられた IP アドレス アクセス リスト エントリ。

accessListIps
の配列 string

API キーに関連付けられた IP アドレス アクセス リスト エントリ。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "accessListIps": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "linkToken": "string"
}

クラウドプロバイダー アクセス

Atlas で AWS IAM ロールを返したり、追加、承認、削除したりします。

すべてのクラウドプロバイダーのアクセス ロールを返す

指定されたプロジェクトへのアクセス権を持つすべてのクラウドプロバイダー アクセス ロールを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "awsIamRoles": [
    ],
  • "azureServicePrincipals": [
    ]
}

1 つのクラウドプロバイダーのアクセス ロールを作成

指定されたクラウドプロバイダーに対して 1 つのアクセス ロールを作成します。一部の MongoDB Cloud 機能では、認証にこれらのクラウドプロバイダー アクセス ロールを使用します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

クラウドプロバイダーへのアクセスを設定する
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

指定されたクラウドプロバイダーの 1 つのロールを作成します。

providerName
必須
string

ロールのクラウドプロバイダーを識別する、人間が判読できるラベル。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "providerName": "AWS"
}

応答サンプル

コンテンツタイプ
application/ 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 キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
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 と、指定されたプロジェクトへのアクセス権を持つアクセス ロールを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ 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サービス アカウントにアクセスする場合は必要ありません。

クラウドプロバイダーへのアクセスを設定する
認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/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/ JSON
例
{
  • "providerName": "AWS",
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

応答サンプル

コンテンツタイプ
application/ 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"
}

クラスター停止時シミュレーション

クラスターの停止時シミュレーションを返したり、開始したり、終了したりします。

停止時シミュレーションを終了

クラスターの停止時シミュレーションを終了します。

クラスター停止時シミュレーション
認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2019-08-24T14:15:22Z",
  • "state": "START_REQUESTED"
}

1 つの停止時シミュレーションを返す

1 つのクラスターの 1 つの停止時シミュレーションを返します。

クラスター停止時シミュレーション
認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2019-08-24T14:15:22Z",
  • "state": "START_REQUESTED"
}

停止時シミュレーションを開始

クラスターの停止時シミュレーションを開始します。

クラスター停止時シミュレーション
認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/json

停止時シミュレーションについて説明します。

の配列 オブジェクト (AtlasClusterOutageSimulationOutageFilter) non-empty

クラスターの停止時シミュレーションのタイプを指定する設定のリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "outageFilters": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2019-08-24T14:15:22Z",
  • "state": "START_REQUESTED"
}

クラスター

データベース配置を返したり、追加、編集、削除したりします。クラスター構成の変更はコストに影響を与えます。このリソースには、プロジェクトID が必要です。

すべてのプロジェクトで承認されたすべてのクラスターを返す

アクセス可能なすべてのプロジェクトのすべてのクラスターの詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。このレスポンスには、マルチクラウド クラスターは含まれません。このリソースは、リクエスト元の API キーがどのようなクラスターレベルのロールを持っていても使用できます。

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

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのプロジェクトのすべてのクラスターを返す

アクセス可能な特定のプロジェクトのすべてのクラスターの詳細を返します。 クラスターには、同じデータセットを維持するホストのグループが含まれます。 このレスポンスには、マルチクラウド クラスターは含まれません。 マルチクラウド クラスターを返すには、「 すべての高度なクラスターを取得 」を使用します。 このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

このエンドポイントは、createCluster エンドポイントを使用して作成された Flex クラスターや、2026 年 1 月までに Flex クラスターに移行された旧 M2 / M5 クラスターでも使用できます。代わりに、Flex クラスターには listFlexClusters エンドポイントをご利用ください。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

バックアップを保持するクラスターを返すかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

クラスターを 1 つ作成

特定のプロジェクトに 1 つのクラスターを作成します。 クラスターには、同じデータセットを維持するホストのグループが含まれます。 このリソースは、マルチクラウド クラスターを作成しません。 マルチクラウドクラスターを作成するには、 「1 つの高度なクラスターを作成」 を使用します。 このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

M10+専有クラスターを配置すると、そのプロバイダーとリージョンに既存のVPCまたはVPCピアリング接続が存在しない場合、Atlasは選択したプロバイダーとリージョン用のVPCを作成します。Atlas は VPC に CIDR（Classless Inter-Domain Routing）ブロックを割り当てます。

M2 または M5 の instanceSize を使用すると、代わりに Flex クラスターが作成されることにご注意ください。M2または M5 の instanceSize のサポートは、2026 年 1 月に終了します。今後、このような構成には createFlexCluster API を使用することをお勧めします。

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

指定されたプロジェクト内の 1 つのクラスターに作成する詳細。

acceptDataRisksAndForceReplicaSetReconfig
string <date-time>

リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み（過半数がコミットされた書込みであっても）が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。

リージョン停止時のレプリカセットの再構成
オブジェクト (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"

カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。

カスタマー キー管理を使用した保管時の暗号化
globalClusterSelfManagedSharding
ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。

false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。

true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。

この設定は、クラスターが配置されると変更できません。

グローバルクラスターの作成
の配列 オブジェクト （コンポーネント ラベル）
非推奨

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。

クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めています。

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/ 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": [
    ],
  • "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/ 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"
}

すべてのクラウドプロバイダーのリージョンを返す

指定された階層の指定されたクラウドプロバイダーで利用可能なリージョンのリストを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

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

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

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

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

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

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

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

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

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

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

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

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

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

providers
の配列 string

取得対象のリージョンを持つクラウドプロバイダー。複数のプロバイダーを指定した場合、レスポンスではマルチクラウド クラスターをサポートする階層とリージョンのみが返されます。

tier
string

リージョンを取得するクラスター階層。

応答

応答サンプル

コンテンツタイプ
application/ 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をアップグレードする
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

指定されたプロジェクト内の共有階層クラスターのアップグレードの詳細。

acceptDataRisksAndForceReplicaSetReconfig
string <date-time>

リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み（過半数がコミットされた書込みであっても）が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。

リージョン停止時のレプリカセットの再構成
オブジェクト (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"

カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。

カスタマー キー管理を使用した保管時の暗号化
globalClusterSelfManagedSharding
ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。

false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。

true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。

この設定は、クラスターが配置されると変更できません。

グローバルクラスターの作成
の配列 オブジェクト （コンポーネント ラベル）
非推奨

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。

クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めています。

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/ 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": [
    ],
  • "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/ 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つの共有階層クラスターをサーバーレスインスタンスにアップグレード廃止予定

このエンドポイントは、新しいサーバーレスインスタンスの作成がサポートされなくなったため、2025 年 2 月に廃止されました。Flex クラスターをアップグレードするには、upgradeFlexCluster エンドポイントをご使用ください。

指定されたプロジェクトの共有階層クラスターをサーバーレスインスタンスにアップグレードします。このリソースを使用するには、リクエスト元の API キーにプロジェクト クラスター マネージャー ロールが必要です。

FlexClusterをアップグレードする
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/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/ JSON
{
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

応答サンプル

コンテンツタイプ
application/ 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 つのクラスターを削除します。 クラスターには、同じデータセットを維持するホストのグループが含まれます。 クラスターを削除するには、終了保護を無効にする必要があります。 このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

このエンドポイントは、createCluster エンドポイントを使用して作成された Flex クラスターや、2026 年 1 月までに Flex クラスターに移行された旧 M2 / M5 クラスターでも使用できます。Flex クラスターには、代わりに deleteFlexCluster エンドポイントを使用してください。

deleteFlexCluster
認可:
DigestAuthServiceAccounts
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=false

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

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

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

retainBackups
ブール値

削除された専有クラスターのバックアップ スナップショットを保持するかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
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 つのクラスターの詳細を返します。 クラスターには、同じデータセットを維持するホストのグループが含まれます。 このレスポンスには、マルチクラウド クラスターは含まれません。 マルチクラウド クラスターを返すには、 Get One Advanced Cluster を使用します。 このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

このエンドポイントは、createCluster エンドポイントを使用して作成された Flex クラスターや、2026 年 1 月までに Flex クラスターに移行された旧 M2 / M5 クラスターでも使用できます。Flex クラスターには、代わりに getFlexCluster エンドポイントをご利用ください。

getFlexCluster
認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ 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 つのクラスターの詳細を更新します。 クラスターには、同じデータセットを維持するホストのグループが含まれます。 このリソースは、マルチクラウド クラスターは更新しません。 マルチクラウドクラスターを更新するには、 「1 つの高度なクラスターを更新」 を使用します。 クラスターは一度に 1 段階のメジャー バージョンにのみアップグレードできます。 メジャー バージョンをスキップすることはできません。 各メジャー バージョンには、以前のバージョンとの下位互換性がない可能性がある機能がいくつか含まれています。 アプリケーションに影響する可能性のある変更については、 リリースノート を確認してください。 MongoDBのメジャー バージョンをアップグレードした後は、以前のバージョンにダウングレードできなくなります。

MongoDB バージョン 4.2 以降では、 レガシーバックアップ は非推奨となり、代わりに クラウドバックアップ が採用されるようになりました。 バージョン 4.2 以降にアップグレードすると、バックアップ システムがレガシーバックアップに設定されている場合、クラウドバックアップにアップグレードされます。 このアップグレード後も、既存のレガシーバックアップ スナップショットはすべて引き続き利用できますが、 保持ポリシーに従い、時間の経過とともに期限が切れます。 バックアップ ポリシーがデフォルトのスケジュールにリセットされます。 レガシーバックアップでカスタム バックアップ ポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。

このリソース を使用するには、リクエスト元のAPIキーにプロジェクト クラスター マネージャー ロールが必要です。 この機能は、M0 の無料クラスター、M2 と M5 の共有階層、Flex クラスターでは使用できません。

リージョンをまたがるクラスターの合計ノード数にはプロジェクトごとに特定の制約があります。 MongoDB Cloud では、1 つのプロジェクトで他のリージョンの合計ノード数を 40 に制限しています。 この合計には、相互に通信するGoogle Cloud Platformリージョン、無料クラスター、共有クラスターは含まれません。 2つのリージョン間の合計ノード数はこの制約を満たす必要があります。 たとえば、プロジェクトのクラスター ノードが 3 つのリージョンに分散している場合（リージョン A が 30 ノード、リージョン B が 10 ノード、リージョン C が 5 ノード）、リージョン C を除外する場合、リージョン C に追加できるノードは 5 つだけです。 、リージョン A + リージョン B = 40。 リージョン B を除外する場合、リージョン A + リージョン C = 35、< = 40 になります。 リージョン A を除外する場合、リージョン B + リージョン C = 15、< = 40 になります。 5 つのノードを追加してもリージョンの組み合わせはそれぞれ、プロジェクトごとの制約を満たしています。リージョン A + B = 40、リージョン A + C = 40、リージョン B + C = 20 。 プロジェクトで他のリージョンに 40 以上のノードにまたがるクラスターが 1 つ以上ある場合、プロジェクトにマルチリージョンクラスターを作成することはできません。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/json

指定されたプロジェクト内の 1 つのクラスターについて更新する詳細。

acceptDataRisksAndForceReplicaSetReconfig
string <date-time>

リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み（過半数がコミットされた書込みであっても）が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。

リージョン停止時のレプリカセットの再構成
オブジェクト (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"

カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。

カスタマー キー管理を使用した保管時の暗号化
globalClusterSelfManagedSharding
ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。

false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。

true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。

この設定は、クラスターが配置されると変更できません。

グローバルクラスターの作成
の配列 オブジェクト （コンポーネント ラベル）
非推奨

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。

クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めています。

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/ 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": [
    ],
  • "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/ 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 つの高度な構成オプションを返す

指定されたプロジェクト内の 1 つのクラスターの高度な構成の詳細を返します。 クラスターには、同じデータセット を維持するホストのグループが含まれます。 高度な設定の詳細には、読み取り保証/書込み保証 (write concern)、インデックス制限およびoplog制限、およびその他のデータベース設定が含まれます。 この機能は、M0 の無料クラスター、M2 と M5 の共有階層クラスター、フレキシブルなクラスター、サーバーレス クラスターでは使用できません。 このリソース を使用するには、リクエスト元のAPIキーにプロジェクトの読み取り専用ロールが必要です。

グローバルクラスター
認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "string",
  • "failIndexKeyTooLong": true,
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "tlsCipherConfigMode": "CUSTOM",
  • "transactionLifetimeLimitSeconds": 1
}

1 つのクラスターの高度な構成オプションを更新

指定されたプロジェクト内の 1 つのクラスターの高度な構成の詳細を更新します。 クラスターには、同じデータセット を維持するホストのグループが含まれます。 高度な設定の詳細には、読み取り保証/書込み保証 (write concern)、インデックス制限およびoplog制限、およびその他のデータベース設定が含まれます。 このリソース を使用するには、リクエスト元のAPIキーにプロジェクト クラスター マネージャー ロールが必要です。 この機能は、M0 の無料クラスター、M2 と M5 の共有階層クラスター、フレキシブルなクラスター、サーバーレス クラスターでは使用できません。

グローバルクラスター
認可:
DigestAuthServiceAccounts
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=false

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

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

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

リクエスト ボディ スキーマ: application/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 クラスター パラメータに対応します。
defaultReadConcern
string
デフォルト: "available"
列挙: "local" "available"

このクラスターに設定された読み取り操作に対して、MongoDB から要求される確認応答のデフォルト レベル。

MongoDB 4.4 クラスターのデフォルトは available です。MongoDB 5.0 以降のクラスターのデフォルトは local です。

このオプションは、グローバルのデフォルトの読み取り保証 (read concern) に相当します。
defaultWriteConcern
string

ドライバーによって何も指定されていない場合に、書込み (write) 操作に対して MongoDB が要求する確認応答のデフォルト レベル。

このオプションは、暗黙のデフォルトの書込み保証 (write concern) に相当します。
failIndexKeyTooLong
ブール値
非推奨
デフォルト: true

すべてのインデックスエントリが 1024 バイトを超えないドキュメントを挿入または更新できるかどうかを示すフラグ。これが false に設定されている場合、mongod はこの制限を超えるドキュメントを書込みますが、インデックスは作成しません。MongoDB 4.4 以降、このパラメータは削除されました。

このオプションは、`failIndexKeyTooLong` `mongod` 構成ファイル オプションに相当します。
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/ JSON
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "string",
  • "failIndexKeyTooLong": true,
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "tlsCipherConfigMode": "CUSTOM",
  • "transactionLifetimeLimitSeconds": 1
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "string",
  • "failIndexKeyTooLong": true,
  • "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 キーにプロジェクト クラスター マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
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 キーにプロジェクトの読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{}

サンプル データセット リクエストをクラスターにロード

MongoDB サンプル データセットを指定したクラスターにロードすることを要求します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

クラスターのサンプル データセット リクエストのステータスを確認

サンプル データセットを 1 つのクラスターにロードする進行状況を確認します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
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=false

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

カスタムデータベースロール

カスタム データベースユーザーの権限ロールの返却、追加、編集、削除を行います。カスタムロールを使用して、MongoDB Cloud の組み込みロールでは記述できないアクションのカスタムセットを指定できます。プロジェクトレベルで、プロジェクト内のすべてのクラスターに対してカスタムロールを定義します。このリソースは、MongoDB 権限アクションのサブセットをサポートします。カスタムロールのアクションのサブセットを作成できます。カスタムロールアクションの幅広いリストを作成するには、MongoDB クラウド ユーザー インターフェースを使用してください。カスタムロールには、すべてのプロジェクトのクラスターがサポートし、プロジェクトのクラスターが使用する各 MongoDB バージョンと互換性のあるアクションを含める必要があります。たとえば、プロジェクトに MongoDB 4.2 クラスターがある場合、MongoDB 4.4 で導入されたアクションを使用するカスタムロールを作成することはできません。

1 つのプロジェクトのすべてのカスタムロールを返す

指定されたプロジェクトのカスタムロールをすべて返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

1 つのカスタムロールを作成

指定されたプロジェクトに 1 つのカスタムロールを作成します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナー ロール、プロジェクトストリーム処理オーナーロール、またはプロジェクトデータベースアクセス管理者ロールが必要です。

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

指定されたプロジェクトに 1 つのカスタムロールを作成します。

の配列 オブジェクト （データベース権限アクション）

ロールが付与する個々の権限アクションのリスト。

の配列 オブジェクト （継承された役割） unique

このカスタムロールが継承する組み込みロールのリスト。

roleName
必須
string

リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

1 つのプロジェクトから 1 つのカスタムロールを削除

指定されたプロジェクトから 1 つのカスタムロールを削除します。 親ロールやアクションを持たない子ロールを 1 つ以上残すことになる場合、カスタムロールを削除することはできません。 また、ロールが割り当てられないデータベースユーザーを 1 人以上残すことになる場合も、カスタムロールを削除できません。 このリソースを使用するには、リクエストのAPIキーにプロジェクト オーナー ロール、プロジェクト Stream Processing オーナー ロール、またはプロジェクト データベース アクセス管理者ロールが必要です。

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

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

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

roleName
必須
string

リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
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 キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

roleName
必須
string

リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

1 つのプロジェクトの 1 つのカスタムロールを更新

指定されたプロジェクト内の 1 つのカスタムロールを更新します。 このリソースを使用するには、リクエストのAPIキーにプロジェクト オーナー ロール、プロジェクト Stream Processing オーナー ロール、またはプロジェクト データベース アクセス管理者ロールが必要です。

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

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

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

roleName
必須
string

リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。

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

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

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

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

リクエスト ボディ スキーマ: application/json

指定されたプロジェクト内の 1 つのカスタムロールを更新します。

の配列 オブジェクト （データベース権限アクション）

ロールが付与する個々の権限アクションのリスト。

の配列 オブジェクト （継承された役割） unique

このカスタムロールが継承する組み込みロールのリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

Data Federation

フェデレーティッドデータベースインスタンスの返却、追加、編集、削除を行います。このリソースには、プロジェクトIDが必要です。フェデレーティッドデータベースインスタンスの構成変更はコストに影響する可能性があります。

1 つのプロジェクトのすべてのフェデレーティッドデータベースインスタンスを返す

指定されたプロジェクト内のすべてのフェデレーティッドデータベースインスタンスの詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用以上のロールが必要です。

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

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

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

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

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

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

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

タイプ
string
デフォルト: "USER"
列挙: "USER" "ONLINE_ARCHIVE"

返却対象のフェデレーティッドデータベースインスタンスのタイプ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

1 つのプロジェクトに 1 つのフェデレーティッドデータベースインスタンスを作成

指定されたプロジェクトに 1 つのフェデレーティッドデータベースインスタンスを作成します。このリソースを使用するには、リクエスト元の API キーにプロジェクトオーナーまたはプロジェクト Charts 管理者ロールが必要です。

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

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

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

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

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

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

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

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

このリクエストで、リクエスト元 IAM ロールの S3 バケット読み取り可否を確認するかどうかを示すフラグ。AWS は、バケットに書き込む前に、ロールがバケット内のオブジェクトを一覧できるかどうかを確認します。一部の IAM ロールには書き込み権限のみが必要です。このフラグを使用すると、そのチェックをスキップできます。

リクエスト ボディ スキーマ: application/json

指定されたプロジェクトに 1 つのフェデレーティッドデータベースインスタンスを作成するための詳細。

オブジェクト （データフェデレーション クラウドプロバイダー）

このフェデレーティッドデータベースインスタンスがホストされているクラウドプロバイダー。

オブジェクト (DataLakeDataProcessRegion)

フェデレーティッドデータベースインスタンスがクライアント接続をルーティングするクラウドプロバイダーのリージョンに関する情報。

name
string

フェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

オブジェクト (DataLakeStorage)

各データ ストアの構成情報と MongoDB Cloud データベースへのマッピング。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

1 つのプロジェクトから 1 つのフェデレーティッドデータベースインスタンスを削除

指定されたプロジェクトから 1 つのフェデレーティッドデータベースインスタンスを削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクトオーナーまたはプロジェクト Charts 管理者ロールが必要です。

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

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

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

tenantName
必須
string

削除対象のフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

1 つのプロジェクトの 1 つのフェデレーティッドデータベースインスタンスを返す

指定されたプロジェクト内の 1 つのフェデレーティッドデータベースインスタンスの詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト Charts 管理者ロールが必要です。

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

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

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

tenantName
必須
string

返却対象のフェデレーティッド データベースを特定する、人間が判読可能なラベル。

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

1 つのプロジェクトの 1 つのフェデレーティッドデータベースインスタンスを更新

指定されたプロジェクト内の 1 つのフェデレーティッドデータベースインスタンスの詳細を更新します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナー以上のロールが必要です。

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

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

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

tenantName
必須
string

更新対象のフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

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

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

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

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

skipRoleValidation
必須
ブール値

このリクエストで、リクエスト元 IAM ロールの S3 バケット読み取り可否を確認するかどうかを示すフラグ。AWS は、バケットに書き込む前に、ロールがバケット内のオブジェクトを一覧できるかどうかを確認します。一部の IAM ロールには書き込み権限のみが必要です。このフラグを使用すると、そのチェックをスキップできます。

リクエスト ボディ スキーマ: application/json

指定されたプロジェクト内の更新対象フェデレーティッド データベースの詳細。

オブジェクト （データフェデレーション クラウドプロバイダー）

このフェデレーティッドデータベースインスタンスがホストされているクラウドプロバイダー。

オブジェクト (DataLakeDataProcessRegion)

フェデレーティッドデータベースインスタンスがクライアント接続をルーティングするクラウドプロバイダーのリージョンに関する情報。

name
string

フェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

オブジェクト (DataLakeStorage)

各データ ストアの構成情報と MongoDB Cloud データベースへのマッピング。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

1 つのフェデレーティッドデータベースインスタンスのすべてのクエリ制限を返す

指定されたプロジェクト内のフェデレーティッドデータベースインスタンスのクエリ制限を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

tenantName
必須
string

クエリ制限を取得する対象のフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

1 つのフェデレーティッドデータベースインスタンスの 1 つのクエリ制限を削除

1 つのフェデレーティッドデータベースインスタンスの 1 つのクエリ制限を削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

tenantName
必須
string

クエリ制限が適用されるフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

limitName
必須
string
列挙: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

このデータ フェデレーション インスタンスの制限を識別する、人間が判読可能なラベル。

制限名 説明 default
bytesProcessed.query 単一のデータフェデレーション クエリ中に処理されるバイト数の制限 該当なし
bytesProcessed.daily データフェデレーション インスタンスの現在日に処理されるバイト数の制限 該当なし
bytesProcessed.weekly データフェデレーション インスタンスの現在の週に処理されるバイト数の制限 該当なし
bytesProcessed.monthly データフェデレーション インスタンスの現在の月に処理されるバイト数の制限 該当なし
クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

1 つのプロジェクトの 1 つのフェデレーティッドデータベースインスタンスのクエリ制限を返す

指定されたプロジェクト内の指定されたフェデレーティッドデータベースインスタンスの 1 つのクエリ制限の詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

tenantName
必須
string

クエリ制限が適用されるフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

limitName
必須
string
列挙: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

このデータ フェデレーション インスタンスの制限を識別する、人間が判読可能なラベル。

制限名 説明 default
bytesProcessed.query 単一のデータフェデレーション クエリ中に処理されるバイト数の制限 該当なし
bytesProcessed.daily データフェデレーション インスタンスの現在日に処理されるバイト数の制限 該当なし
bytesProcessed.weekly データフェデレーション インスタンスの現在の週に処理されるバイト数の制限 該当なし
bytesProcessed.monthly データフェデレーション インスタンスの現在の月に処理されるバイト数の制限 該当なし
クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "maximumLimit": 0,
  • "name": "string",
  • "overrunPolicy": "BLOCK",
  • "tenantName": "string",
  • "value": 0
}

1 つのフェデレーティッドデータベースインスタンスの 1 つのクエリ制限を構成

1 つのフェデレーティッドデータベースインスタンスに対して 1 つのクエリ制限を作成または更新します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

tenantName
必須
string

クエリ制限が適用されるフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

limitName
必須
string
列挙: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

このデータ フェデレーション インスタンスの制限を識別する、人間が判読可能なラベル。

制限名 説明 default
bytesProcessed.query 単一のデータフェデレーション クエリ中に処理されるバイト数の制限 該当なし
bytesProcessed.daily データフェデレーション インスタンスの現在日に処理されるバイト数の制限 該当なし
bytesProcessed.weekly データフェデレーション インスタンスの現在の週に処理されるバイト数の制限 該当なし
bytesProcessed.monthly データフェデレーション インスタンスの現在の月に処理されるバイト数の制限 該当なし
クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

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

リクエスト ボディ スキーマ: application/json

1 つのフェデレーティッドデータベースインスタンスに対して 1 つのクエリ制限を作成または更新します。

overrunPolicy
string
列挙: "BLOCK" "BLOCK_AND_KILL"

Data Federation の制限にのみ使用されます。使用量の制限を超えた場合に実行するアクション。制限範囲が QUERY に設定されている場合、MongoDB Cloud は使用制限を超えるとクエリを停止するため、これは無視されます。

価値
必須
integer <int64>

制限を設定する量。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "overrunPolicy": "BLOCK",
  • "value": 0
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "maximumLimit": 0,
  • "name": "string",
  • "overrunPolicy": "BLOCK",
  • "tenantName": "string",
  • "value": 0
}

1 つのフェデレーティッドデータベースインスタンスのクエリ ログをダウンロード

指定されたフェデレーティッドデータベースインスタンスのクエリ ログをダウンロードします。 このリソースを使用するには、リクエスト元の API キーにプロジェクトオーナーまたはプロジェクトデータアクセス読み取り/書き込みのロールが必要です。 API は、JSON 応答スキーマを使用した直接呼び出しをサポートしていません。 "Accept: application/gzip" という形式の accept ヘッダーを使用して gzip レスポンススキーマをリクエストする必要があります。

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

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

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

tenantName
必須
string

クエリ ログをダウンロードする対象のフェデレーティッドデータベースインスタンスを識別する、人間が判読できるラベル。

クエリ パラメータ
endDate
integer <int64> 1199145600
例: endDate=1636481348

ダウンロードするログ メッセージの範囲の終了ポイントを指定するタイムスタンプ。MongoDB Cloud は、このタイムスタンプを UNIXエポックからの経過秒数で表現します。

startDate
integer <int64> 1199145600
例: startDate=1636466948

ダウンロードするログ メッセージの範囲の開始ポイントを指定するタイムスタンプ。MongoDB Cloud は、このタイムスタンプを UNIXエポックからの経過秒数で表現します。

応答

応答サンプル

コンテンツタイプ
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 つのプロジェクトのすべてのフェデレーティッドデータベースインスタンスとオンライン アーカイブ プライベートエンドポイントを返す

指定されたプロジェクト内のフェデレーティッドデータベースインスタンスとオンラインアーカイブのすべてのプライベートエンドポイントを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト Charts 管理者ロールが必要です。

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

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

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

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

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

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

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

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

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのプロジェクトの 1 つのフェデレーティッドデータベースインスタンスとオンライン アーカイブ プライベートエンドポイントを作成

フェデレーティッドデータベースインスタンスとオンラインアーカイブ用のプライベートエンドポイントを 1 つ指定のプロジェクトに追加します。エンドポイント ID がすでに存在し、関連するコメントが変更されていない場合、Atlas Data Federation はエンドポイント ID リストに変更を加えません。エンドポイント ID がすでに存在し、関連するコメントが変更された場合、Atlas Data Federation はエンドポイント ID リスト内のコメントの値のみをアップデートします。エンドポイント ID が存在しない場合、Atlas Data Federation は新しいエンドポイントをエンドポイント ID リスト内のエンドポイントのリストに追加します。各リージョンには、各リージョンのさまざまなエンドポイントに対応するサービス名が関連付けられています。

us-east-1 は com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4 です。

us-west-1 は com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb です。

eu-west-1 は com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e です。

eu-west-2 は com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9 です。

eu-central-1 は com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d です。

sa-east-1 は com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044 です。

ap-southeast-2 は com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e です。

ap-south-1 は com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d です。

このリソースを使用するには、リクエスト元の API キーにプロジェクトオーナーまたはプロジェクト Charts 管理者ロールが必要です。

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

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

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

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

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

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

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

リクエスト ボディ スキーマ: application/json

指定されたプロジェクトに追加するフェデレーティッドデータベースインスタンスとオンラインアーカイブのプライベートエンドポイント。

azureLinkId
string

Azureプライベートエンドポイント接続を識別するリンクID 。

comment
string

このプライベートエンドポイントに関連付ける、人間が判読可能な文字列。

customerEndpointDNSName
string

顧客の VPC エンドポイント DNS 名を識別するための人間が判読可能なラベル。定義されている場合は、リージョンの値も指定する必要があります。

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

Azureプライベートエンドポイントへの接続に使用されるIPアドレス。

endpointId
必須
string^vpce-[0-9a-f]{17}$

プライベート エンドポイントを識別するユニークな 22 文字の英数字文字列。

Atlas Data Lake は、AWS PrivateLink 機能を使用して Amazon Web Services のプライベートエンドポイントをサポートします。
errorsMessage
string

プライベートエンドポイントリクエストの承認の失敗を説明するエラーメッセージ。

プロバイダー
string
デフォルト: "AWS"
値: "AWS"

クラウド サービス プロバイダーを識別する、人間が判読可能なラベル。Atlas Data Lake は Amazon Web Services のみをサポートしています。

リージョン
string

顧客の VPC エンドポイントのリージョンを識別するための、人間が判読可能なラベル。定義されている場合は、customerEndpointDNSName の値も指定する必要があります。

状態
string
列挙: "PENDING" " OK" "FAILED" "DELEING"

プライベートエンドポイント接続リクエストのステータス。

タイプ
string
デフォルト: "DATA_LAKE"
値: "DATA_LAKE"

このプライベートエンドポイントに関連付けられているリソースの種類を識別する、人間が判読可能なラベル。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "azureLinkId": "string",
  • "comment": "string",
  • "customerEndpointDNSName": "string",
  • "customerEndpointIPAddress": "string",
  • "endpointId": "vpce-3bf78b0ddee411ba1",
  • "errorMessage": "string",
  • "provider": "AWS",
  • "region": "US_EAST_1",
  • "status": "PENDING",
  • "type": "DATA_LAKE"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのプロジェクトから 1 つのフェデレーティッドデータベースインスタンスとオンライン アーカイブ プライベートエンドポイントを削除

指定されたプロジェクト内のフェデレーティッドデータベースインスタンスとオンラインアーカイブのプライベートエンドポイントを 1 つ削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

endpointId
必須
string^vpce-[0-9a-f]{17}$

削除対象のプライベートエンドポイントを識別する、ユニークな 22 文字の英数字文字列。Atlas Data Federation は、AWS PrivateLink 機能を使用して AWS プライベートエンドポイントをサポートします。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

1 つのプロジェクトの 1 つのフェデレーティッドデータベースインスタンスとオンライン アーカイブ プライベートエンドポイントを返す

指定されたプロジェクト内のフェデレーティッドデータベースインスタンスまたはオンラインアーカイブの、指定されたプライベートエンドポイントを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト Charts 管理者ロールが必要です。

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

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

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

endpointId
必須
string^vpce-[0-9a-f]{17}$

返却されるプライベートエンドポイントを識別するユニークな 22 文字の英数字文字列。Atlas Data Federation は、AWS PrivateLink 機能を使用して AWS プライベートエンドポイントをサポートします。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "azureLinkId": "string",
  • "comment": "string",
  • "customerEndpointDNSName": "string",
  • "customerEndpointIPAddress": "string",
  • "endpointId": "vpce-3bf78b0ddee411ba1",
  • "errorMessage": "string",
  • "provider": "AWS",
  • "region": "US_EAST_1",
  • "status": "PENDING",
  • "type": "DATA_LAKE"
}

Data Lake パイプライン

Atlas Data Lake パイプラインおよび関連する実行を返却、編集、削除します。

Data Lake パイプラインは非推奨です。 詳しくは、 Data Lake 廃止ガイド を参照してください。

1 つのプロジェクトからすべての Data Lake パイプラインを返却 （非推奨）

Data Lake パイプラインの一覧を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

1 つの Data Lake パイプラインを作成 （非推奨）

1 つの Data Lake パイプラインを作成します。

Data Lake パイプラインは非推奨です。 詳しくは、 Data Lake 廃止ガイド を参照してください。
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

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

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

リクエスト ボディ スキーマ: application/json

1 つの Data Lake パイプラインを作成します。

オブジェクト （データセット保持ポリシー）

スケジュールされた Data Lake パイプラインのデータセット保持ポリシー。

name
string

この Data Lake パイプラインの名前。

オブジェクト （取り込み先）

Data Lake パイプラインの取り込み先。

オブジェクト （取り込み元）

Data Lake パイプラインの取り込み元。

の配列 オブジェクト （フィールド変換）

この Data Lake パイプラインで除外するフィールド。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "datasetRetentionPolicy": {
    },
  • "name": "string",
  • "sink": { },
  • "source": {
    },
  • "transformations": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

1 つの Data Lake パイプラインを削除 非推奨

1 つの Data Lake パイプラインを削除します。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

1 つの Data Lake パイプラインを返却 非推奨

指定されたプロジェクト内の 1 つの Data Lake パイプラインの詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

1 つの Data Lake パイプラインを更新 非推奨

1 つの Data Lake パイプラインを更新します。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

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

リクエスト ボディ スキーマ: application/json

1 つの Data Lake パイプラインを更新します。

オブジェクト （データセット保持ポリシー）

スケジュールされた Data Lake パイプラインのデータセット保持ポリシー。

name
string

この Data Lake パイプラインの名前。

オブジェクト （取り込み先）

Data Lake パイプラインの取り込み先。

オブジェクト （取り込み元）

Data Lake パイプラインの取り込み元。

の配列 オブジェクト （フィールド変換）

この Data Lake パイプラインで除外するフィールド。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "datasetRetentionPolicy": {
    },
  • "name": "string",
  • "sink": { },
  • "source": {
    },
  • "transformations": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

1 つの Data Lake パイプラインで利用可能な取り込みスケジュールを返却 （非推奨）

Data Lake パイプラインのソースとして使用できるバックアップ スケジュール ポリシーアイテムの一覧を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

1 つの Data Lake パイプラインの利用可能なバックアップ スナップショットを返却 （非推奨）

オンデマンドパイプラインの実行をトリガーするために使用できるバックアップ スナップショットの一覧を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

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

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

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

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

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

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

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

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

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

completedAfter
string <date-time>

MongoDB Cloud がスナップショットを作成した日時。指定すると、MongoDB Cloud はこの日時以降に作成された利用可能なバックアップ スナップショットのみを返します。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つの Data Lake パイプラインを一時停止 （非推奨）

指定されたプロジェクト内の Data Lake パイプラインの取り込みを一時停止します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

1 つの Data Lake パイプラインを再開 非推奨

指定されたプロジェクト内の Data Lake パイプラインの取り込みを再開します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

1 つのプロジェクトからすべての Data Lake パイプラインの実行を返す （非推奨）

過去の Data Lake パイプラインの実行一覧を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

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

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

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

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

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

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

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

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

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

createdBefore
string <date-time>

指定した場合、Atlas は、この日時より前に開始された Data Lake パイプラインの実行のみを返します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

パイプライン実行データセットを削除 （非推奨）

指定されたパイプラインの実行中に Atlas が生成したデータセットを削除します。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

Data Lake パイプラインの実行を識別するユニークな 24 桁の 16 進数の文字列。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

1 つの Data Lake パイプラインを実行 （非推奨）

指定されたプロジェクト内で実行された 1 つの Data Lake パイプラインの詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

Data Lake パイプラインの実行を識別するユニークな 24 桁の 16 進数の文字列。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "backupFrequencyType": "HOURLY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "phase": "SNAPSHOT",
  • "pipelineId": "32b6e34b3d91647abb20e7b8",
  • "scheduledDeletionDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "PENDING",
  • "stats": {
    }
}

オンデマンドのスナップショット取り込みをtriggerする 非推奨

指定されたスナップショットの Data Lake パイプラインの取り込みをトリガーします。

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

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

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

pipelineName
必須
string^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

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

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

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

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

リクエスト ボディ スキーマ: application/json

スナップショットの単一の取り込み実行をトリガーします。

オブジェクト （データセット保持ポリシー）

スケジュールされた Data Lake パイプラインのデータセット保持ポリシー。

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

スナップショットを識別するユニークな 24 桁の 16 進数の文字列。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "datasetRetentionPolicy": {
    },
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "backupFrequencyType": "HOURLY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "phase": "SNAPSHOT",
  • "pipelineId": "32b6e34b3d91647abb20e7b8",
  • "scheduledDeletionDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "PENDING",
  • "stats": {
    }
}

データベースユーザー

データベースユーザーを返却、追加、編集、削除します。

1 つのプロジェクトからすべてのデータベースユーザーを返す

指定されたプロジェクトに属するすべてのデータベースユーザーを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

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

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

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

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

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1
例: pageNum=1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのプロジェクトに 1 人のデータベースユーザーを作成

指定されたプロジェクトに 1 人のデータベースユーザーを作成します。 このMongoDB Cloud は、 プロジェクトごとに最大 100 のデータベースユーザーをサポートします。 100プロジェクトで を超えるデータベースユーザーが必要な場合は、 サポート にお問い合わせください。このリソースを使用するには、リクエストのAPIキーにプロジェクト オーナー ロール、プロジェクト Charts 管理者ロール、プロジェクト Stream Processing オーナー ロール、またはプロジェクト データベース アクセス管理者ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

リクエスト ボディ スキーマ: application/json

指定されたプロジェクトに 1 人のデータベースユーザーを作成します。

awsIAMType
string
デフォルト: "NONE"
列挙: "NONE" "USER" "ROLE"

新しいデータベースユーザーが、ユーザーに関連付けられた AWS（Amazon Web Services）の IAM（Identity and Access Management、ID とアクセス管理）認証情報で認証されるか、またはユーザーのロールで認証されるを示す、人間が判読可能なラベル。

databaseName
必須
string
デフォルト: 「管理者」
列挙: 「管理者」 "$external"

データベースユーザーが認証するデータベース。 データベースユーザーは、MongoDB にログインするためにユーザー名と認証データベースの両方を提供する必要があります。 ユーザーがAmazon Web Services IAM、x.509、 LDAP 、または OIDC Workload で認証される場合、この値は $external になります。 ユーザーが SCRAM-SHA または OIDC ワークフォース で認証される場合、この値はadminになります。

deleteAfterDate
string <date-time>

MongoDB Cloud がユーザーを削除する日時。このパラメーターは、その値を ISO 8601 タイムスタンプ形式で UTC で表し、タイム ゾーンの指定を含めることができます。API（Application Programming Interface、アプリケーション プログラミング インターフェース）要求を行ってから 1 週間以内の未来の日付を指定する必要があります。

説明
string <= 100 文字

このデータベースユーザーの説明。

グループ ID
必須
string

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

の配列 オブジェクト （コンポーネント ラベル）

MongoDB データベース ユーザーをタグ付けおよび分類するためのキーと値のペアが格納されたリスト。定義したラベルはコンソールに表示されません。

ldapAuthType
string
デフォルト: "NONE"
列挙: "NONE" "GROUP" "USER"

データベースが LDAP（Lightweight Directory Access Protocol、ライトウェイト ディレクトリ アクセス プロトコル）のホスト上でこのデータベースユーザーを認証するために使用する LDAP レコードの一部。

oidcAuthType
string
デフォルト: "NONE"
列挙: "NONE" "IDP_GROUP" "USER"

新しいデータベースユーザーまたはグループが OIDC フェデレーション認証で認証されるかどうかを示す、人間が判読可能なラベル。フェデレーション認証ユーザーを作成するには、このフィールドに USER の値を指定します。フェデレーション認証グループを作成するには、このフィールドに IDP_GROUP の値を指定します。

パスワード
string >= 8 文字

databaseName で指定されたデータベースに対してこのデータベースユーザーを認証する文字列。SCRAM-SHA で認証するには、このパラメーターを指定する必要があります。このパラメーターは、この応答には含まれません。

SCRAM-SHA
の配列 オブジェクト （データベースユーザーのロール）

1 つのロールと適用される 1 つのデータベースの組み合わせを提供するリスト。

の配列 オブジェクト （データベースユーザーのスコープ）

このデータベース ユーザーがアクセスできるクラスター、MongoDB Atlas Data Lake、MongoDB Atlas Streams インスタンスが格納されたリスト。省略した場合、MongoDB Cloud はデータベースユーザーに、プロジェクト内のすべてのクラスター、MongoDB Atlas Data Lakes、MongoDB Atlas Streams インスタンスへのアクセスを許可します。

username
必須
string <= 1024文字

MongoDB に認証するユーザーを表す、人間が判読可能なラベル。このラベルの形式は、認証方法によって異なります。

認証方法 必要なパラメーター パラメーターの値 username のフォーマット
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType USER ARN
x.509 x509Type CUSTOMER RFC 2253 識別名
x.509 x509Type MANAGED RFC 2253 識別名
LDAP ldapAuthType USER RFC 2253 識別名
LDAP ldapAuthType GROUP RFC 2253 識別名
OIDC WORKFORCE oidcAuthType IDP_GROUP Atlas OIDC IdP ID（フェデレーション設定で確認可能）、その後に「/」、その後に IdP グループ名が続きます
OIDC Workload oidcAuthType USER Atlas OIDC IdP ID（フェデレーション設定で確認可能）、その後に「/」が続き、その後に IdP ユーザー名が続きます
SCRAM-SHA awsIAMType, x509Type, ldapAuthType, oidcAuthType なし 英数字の文字列
x509Type
string
デフォルト: "NONE"
列挙: "NONE" "CUSTOMER" "MANAGED"

MongoDB Cloud がデータベースユーザーの認証に使用する X.509 方式。

  • アプリケーション管理 X.509 の場合は、MANAGED を指定します。
  • 自己管理型 X.509 の場合は、CUSTOMER を指定します。

CUSTOMER メソッドで作成されたユーザーには、ユーザー名パラメーターに CN（Common Name、共通名）が必要です。$external データベースに外部認証ユーザーを作成する必要があります。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例

AWS IAM 認証

{
  • "awsIAMType": "USER",
  • "databaseName": "$external",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

1 つのプロジェクトから 1 人のデータベースユーザーを削除

指定されたプロジェクトから 1 人のデータベースユーザーを削除します。このリソースを使用するには、リクエスト元のAPIキーにプロジェクト オーナー ロール、プロジェクトストリーム処理オーナーロール、またはプロジェクトデータベースアクセス管理者ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

databaseName
必須
string

データベースユーザーが認証するデータベース。 データベースユーザーは、MongoDB にログインするためにユーザー名と認証データベースの両方を提供する必要があります。 ユーザーがAmazon Web Services IAM、x.509、 LDAP 、または OIDC Workload で認証される場合、この値は $external になります。 ユーザーが SCRAM-SHA または OIDC ワークフォース で認証される場合、この値はadminになります。

username
必須
string
例: SCRAM-SHA: dylan または AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName

MongoDB に認証するユーザーを表す、人間が判読可能なラベル。このラベルの形式は、認証方法によって異なります。

認証方法 必要なパラメーター パラメーターの値 username のフォーマット
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType USER ARN
x.509 x509Type CUSTOMER RFC 2253 識別名
x.509 x509Type MANAGED RFC 2253 識別名
LDAP ldapAuthType USER RFC 2253 識別名
LDAP ldapAuthType GROUP RFC 2253 識別名
OIDC WORKFORCE oidcAuthType IDP_GROUP Atlas OIDC IdP ID（フェデレーション設定で確認可能）、その後に「/」、その後に IdP グループ名が続きます
OIDC Workload oidcAuthType USER Atlas OIDC IdP ID（フェデレーション設定で確認可能）、その後に「/」が続き、その後に IdP ユーザー名が続きます
SCRAM-SHA awsIAMType, x509Type, ldapAuthType, oidcAuthType なし 英数字の文字列
クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

1 つのプロジェクトから 1 人のデータベースユーザーを返す

指定されたプロジェクトに属する 1 人のデータベースユーザーを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

databaseName
必須
string

データベースユーザーが認証するデータベース。 データベースユーザーは、MongoDB にログインするためにユーザー名と認証データベースの両方を提供する必要があります。 ユーザーがAmazon Web Services IAM、x.509、 LDAP 、または OIDC Workload で認証される場合、この値は $external になります。 ユーザーが SCRAM-SHA または OIDC ワークフォース で認証される場合、この値はadminになります。

username
必須
string
例: SCRAM-SHA: dylan または AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName

MongoDB に認証するユーザーを表す、人間が判読可能なラベル。このラベルの形式は、認証方法によって異なります。

認証方法 必要なパラメーター パラメーターの値 username のフォーマット
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType USER ARN
x.509 x509Type CUSTOMER RFC 2253 識別名
x.509 x509Type MANAGED RFC 2253 識別名
LDAP ldapAuthType USER RFC 2253 識別名
LDAP ldapAuthType GROUP RFC 2253 識別名
OIDC WORKFORCE oidcAuthType IDP_GROUP Atlas OIDC IdP ID（フェデレーション設定で確認可能）、その後に「/」、その後に IdP グループ名が続きます
OIDC Workload oidcAuthType USER Atlas OIDC IdP ID（フェデレーション設定で確認可能）、その後に「/」が続き、その後に IdP ユーザー名が続きます
SCRAM-SHA awsIAMType, x509Type, ldapAuthType, oidcAuthType なし 英数字の文字列
クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

1 つのプロジェクトの 1 人のデータベース ユーザーを更新

指定されたプロジェクトに属する 1 人のデータベースユーザーを更新します。このリソースを使用するには、リクエスト元の API キーが Project Owner ロール、Project Charts Admin ロール、Project Stream Processing Owner ロール、または Project Database Access Admin ロールを持っている必要があります。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

databaseName
必須
string

データベースユーザーが認証するデータベース。 データベースユーザーは、MongoDB にログインするためにユーザー名と認証データベースの両方を提供する必要があります。 ユーザーがAmazon Web Services IAM、x.509、 LDAP 、または OIDC Workload で認証される場合、この値は $external になります。 ユーザーが SCRAM-SHA または OIDC ワークフォース で認証される場合、この値はadminになります。

username
必須
string
例: SCRAM-SHA: dylan または AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName

MongoDB に認証するユーザーを表す、人間が判読可能なラベル。このラベルの形式は、認証方法によって異なります。

認証方法 必要なパラメーター パラメーターの値 username のフォーマット
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType USER ARN
x.509 x509Type CUSTOMER RFC 2253 識別名
x.509 x509Type MANAGED RFC 2253 識別名
LDAP ldapAuthType USER RFC 2253 識別名
LDAP ldapAuthType GROUP RFC 2253 識別名
OIDC WORKFORCE oidcAuthType IDP_GROUP Atlas OIDC IdP ID（フェデレーション設定で確認可能）、その後に「/」、その後に IdP グループ名が続きます
OIDC Workload oidcAuthType USER Atlas OIDC IdP ID（フェデレーション設定で確認可能）、その後に「/」が続き、その後に IdP ユーザー名が続きます
SCRAM-SHA awsIAMType, x509Type, ldapAuthType, oidcAuthType なし 英数字の文字列
クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

リクエスト ボディ スキーマ: application/json

指定されたプロジェクトに属する 1 人のデータベースユーザーを更新します。

awsIAMType
string
デフォルト: "NONE"
列挙: "NONE" "USER" "ROLE"

新しいデータベースユーザーが、ユーザーに関連付けられた AWS（Amazon Web Services）の IAM（Identity and Access Management、ID とアクセス管理）認証情報で認証されるか、またはユーザーのロールで認証されるを示す、人間が判読可能なラベル。

databaseName
必須
string
デフォルト: 「管理者」
列挙: 「管理者」 "$external"

データベースユーザーが認証するデータベース。 データベースユーザーは、MongoDB にログインするためにユーザー名と認証データベースの両方を提供する必要があります。 ユーザーがAmazon Web Services IAM、x.509、 LDAP 、または OIDC Workload で認証される場合、この値は $external になります。 ユーザーが SCRAM-SHA または OIDC ワークフォース で認証される場合、この値はadminになります。

deleteAfterDate
string <date-time>

MongoDB Cloud がユーザーを削除する日時。このパラメーターは、その値を ISO 8601 タイムスタンプ形式で UTC で表し、タイム ゾーンの指定を含めることができます。API（Application Programming Interface、アプリケーション プログラミング インターフェース）要求を行ってから 1 週間以内の未来の日付を指定する必要があります。

説明
string <= 100 文字

このデータベースユーザーの説明。

グループ ID
必須
string

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

の配列 オブジェクト （コンポーネント ラベル）

MongoDB データベース ユーザーをタグ付けおよび分類するためのキーと値のペアが格納されたリスト。定義したラベルはコンソールに表示されません。

ldapAuthType
string
デフォルト: "NONE"
列挙: "NONE" "GROUP" "USER"

データベースが LDAP（Lightweight Directory Access Protocol、ライトウェイト ディレクトリ アクセス プロトコル）のホスト上でこのデータベースユーザーを認証するために使用する LDAP レコードの一部。

oidcAuthType
string
デフォルト: "NONE"
列挙: "NONE" "IDP_GROUP" "USER"

新しいデータベースユーザーまたはグループが OIDC フェデレーション認証で認証されるかどうかを示す、人間が判読可能なラベル。フェデレーション認証ユーザーを作成するには、このフィールドに USER の値を指定します。フェデレーション認証グループを作成するには、このフィールドに IDP_GROUP の値を指定します。

パスワード
string >= 8 文字

databaseName で指定されたデータベースに対してこのデータベースユーザーを認証する文字列。SCRAM-SHA で認証するには、このパラメーターを指定する必要があります。このパラメーターは、この応答には含まれません。

SCRAM-SHA
の配列 オブジェクト （データベースユーザーのロール）

1 つのロールと適用される 1 つのデータベースの組み合わせを提供するリスト。

の配列 オブジェクト （データベースユーザーのスコープ）

このデータベース ユーザーがアクセスできるクラスター、MongoDB Atlas Data Lake、MongoDB Atlas Streams インスタンスが格納されたリスト。省略した場合、MongoDB Cloud はデータベースユーザーに、プロジェクト内のすべてのクラスター、MongoDB Atlas Data Lakes、MongoDB Atlas Streams インスタンスへのアクセスを許可します。

username
必須
string <= 1024文字

MongoDB に認証するユーザーを表す、人間が判読可能なラベル。このラベルの形式は、認証方法によって異なります。

認証方法 必要なパラメーター パラメーターの値 username のフォーマット
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType USER ARN
x.509 x509Type CUSTOMER RFC 2253 識別名
x.509 x509Type MANAGED RFC 2253 識別名
LDAP ldapAuthType USER RFC 2253 識別名
LDAP ldapAuthType GROUP RFC 2253 識別名
OIDC WORKFORCE oidcAuthType IDP_GROUP Atlas OIDC IdP ID（フェデレーション設定で確認可能）、その後に「/」、その後に IdP グループ名が続きます
OIDC Workload oidcAuthType USER Atlas OIDC IdP ID（フェデレーション設定で確認可能）、その後に「/」が続き、その後に IdP ユーザー名が続きます
SCRAM-SHA awsIAMType, x509Type, ldapAuthType, oidcAuthType なし 英数字の文字列
x509Type
string
デフォルト: "NONE"
列挙: "NONE" "CUSTOMER" "MANAGED"

MongoDB Cloud がデータベースユーザーの認証に使用する X.509 方式。

  • アプリケーション管理 X.509 の場合は、MANAGED を指定します。
  • 自己管理型 X.509 の場合は、CUSTOMER を指定します。

CUSTOMER メソッドで作成されたユーザーには、ユーザー名パラメーターに CN（Common Name、共通名）が必要です。$external データベースに外部認証ユーザーを作成する必要があります。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "groupId": "string",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "oidcAuthType": "NONE",
  • "password": "stringst",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

カスタマー キー管理を使用した保管時の暗号化

カスタマーキー管理の構成を使用して、保管時の暗号化を返却、編集します。MongoDB Cloud は、独自のキー管理を使用するかどうかに関係なく、すべてのストレージを暗号化します。

1 つのプロジェクトのカスタマー マネージド キーを使用している保管時の暗号化の 1 つの構成を返す

クラウドプロバイダーを通じて管理するキーを使用して、保管時の暗号化の構成を返します。MongoDB Cloud は、独自のキー管理を使用しない場合でも、すべてのストレージを暗号化します。このリソースでは、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

M10 以上に制限: MongoDB クラウドでは、この機能は M10 以上の専有クラスター階層に制限されています。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

1 つのプロジェクトのカスタマー マネージド キーを使用している保管時の暗号化の構成を更新

クラウドプロバイダーを通じて管理するキーを使用して、保管時の暗号化の構成を更新します。MongoDB Cloud は、独自のキー管理を使用しない場合でも、すべてのストレージを暗号化します。 このリソースでは、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。この機能は、M0 無料クラスター、M2、M5、サーバーレス クラスターでは使用できません。

MongoDB Cloud プロジェクトでカスタマー キー管理プロバイダーを使った保管時の暗号化を少なくとも 1 つ設定すると、プロジェクトオーナーは暗号化が必要な MongoDB Cloud クラスターごとにカスタマーキー管理を使った保管時の暗号化を有効にできます。カスタマー キー管理プロバイダーを使用した保管時の暗号化は、クラスター クラウド サービス プロバイダーと一致する必要はありません。MongoDB Cloud は、ユーザーが管理する暗号化キーを自動的にローテーションしません。キー ローテーションのベストプラクティスについては、カスタマー キー管理プロバイダーのドキュメントとガイダンスを利用して、ご希望の保管時の暗号化を行ってください。MongoDB Cloud プロジェクトでキー管理を使って、カスタマー キー管理を使った保管時の暗号化を設定すると、MongoDB Cloud は自動的に 90 日間のキー ローテーション アラートを作成します。MongoDB Cloud は、独自のキー管理を使用するかどうかに関係なく、すべてのストレージを暗号化します。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

リクエスト ボディ スキーマ: application/json

必要なパラメーターは、カスタマー キー管理を使用して保管時の暗号化を有効にしているかどうかによって異なります。

CMK（Customer Key Management、カスタマー キー管理）を使用して保管時の暗号化を有効にした場合、Atlas には目的の暗号化プロバイダーの全パラメーターが必要です。

  • AWS KMS（Key Management Service）を使うには、MongoDB Cloud に awsKms オブジェクトのすべてのフィールドが必要です。
  • Azure Key Vault を使うには、MongoDB Cloud に azureKeyVault オブジェクトのすべてのフィールドが必要です。
  • Google Cloud KMS（Key Management Service）を使うには、MongoDB Cloud に googleCloudKms オブジェクトのすべてのフィールドを必要です。

カスタマー キー管理を使用して保管時の暗号化を有効にした場合、管理者は awsKms、azureKeyVault、または googleCloudKms オブジェクトの変更されたフィールドのみを渡して、このエンドポイントへの構成を更新できます。

オブジェクト (AWSKMSConfiguration)

AWS（Amazon Web Services）KMS 設定の詳細と、指定されたプロジェクトの保管時の暗号化の設定セット。

Amazon Web Services Key Management Service
オブジェクト (AzureKeyVault)

AKV（Azure Key Vault）を使用した保管時の暗号化の設定を定義する詳細。

Azure Key Vault
オブジェクト (GoogleCloudKMS)

Google Cloud KMS（Key Management Service）を使用した保管時の暗号化の設定を定義する詳細。

Google Cloud Key Management Service

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

イベント

イベントを返します。このコレクションは現在も改訂中であり、変更される可能性があります。

1 つのプロジェクトからすべてのイベントを返す

指定されたプロジェクトの全イベントを返します。 イベントは、データベース、課金、セキュリティのアクティビティやステータスの変更に関する重要な情報を提供します。 このリソース を使用するには、リクエスト元のAPIキーにプロジェクトの読み取り専用ロールが必要です。

このリソースは現在も改訂中であり、変更される可能性があります。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true
例: includeCount=true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100
例: itemsPerPage=100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1
例: pageNum=1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

clusterNames
の配列 string

クラスターを識別する人間が判読できるラベル。

の配列 アラート監査タイプ(オブジェクト)またはアラート監査タイプ（オブジェクト）またはAPI ユーザー イベント タイプ（オブジェクト）またはサービス アカウント イベント タイプ（オブジェクト）または App Services イベント タイプ（オブジェクト）または自動インデックス作成イベント タイプ（オブジェクト）またはオートメーション構成イベント タイプ（オブジェクト）またはAWS ピア VPC 監査タイプ（オブジェクト）またはAzure ピア ネットワーク監査タイプ（オブジェクト）または課金イベント タイプ（オブジェクト）またはクラスター接続監査タイプ（オブジェクト）またはクラスター イベント タイプ（オブジェクト）またはCPS バックアップ イベント タイプ（オブジェクト）または Data Explorer アクセス イベント タイプ（オブジェクト）または Data Explorer イベント タイプ（オブジェクト）またはCPS バックアップ コンプライアンス ポリシー イベント タイプ（オブジェクト）またはディスク バックアップ イベント タイプ（オブジェクト）または暗号化イベント タイプ（オブジェクト）またはエクスポート バケット監査タイプ（オブジェクト）またはFTS インデックス監査タイプ（オブジェクト）またはGCP ピア VPC 監査タイプ（オブジェクト）またはグループ監査タイプ（オブジェクト）またはグループ イベント タイプ（オブジェクト）またはグループ統合イベント タイプ（オブジェクト）またはホスト イベント タイプ（オブジェクト）またはホスト メトリック イベント タイプ（オブジェクト）またはインデックス ビルド監査タイプ（オブジェクト）または NDS 監査タイプ（オブジェクト）または NDS DB チェック監査タイプ（オブジェクト）または NDS データ検証監査タイプ（オブジェクト）または NDS オートスケーリング監査タイプ（オブジェクト）または NDS メンテナンスウィンドウ監査タイプ（オブジェクト）または NDS サーバーレス オートスケーリング監査タイプ（オブジェクト）または NDS サーバーレス インスタンス監査タイプ（オブジェクト）または NDS オートスケーリング監査タイプ（オブジェクト）またはNDS テナント エンドポイント サービス配置監査タイプ（オブジェクト）または NDS x509 ユーザー認証イベント タイプ（オブジェクト）または Online Archive イベント タイプ（オブジェクト）またはプライベート リンク監査タイプ（オブジェクト）またはプロアクティブ操作イベント タイプ（オブジェクト）またはレプリカセット イベント タイプ（オブジェクト）または Search Deployment Audit Types (object) または Serverless Deployment Audit Types (object) または Serverless Event Types (object) または Flex Metric Event Types (object) または Setup Serverless Audit Types (object) または Streams Event Types (object) または Stream Processor Event Types (object) または Support Case Event Types (object) または Support Event Types (object) または Team Event Types (object) または Tenant Backup Event Types (object) または User Event Types (object) または Version Audit Types (object) または Resource Event Types (object) または Access Event Types (object) または Charts Api Call Audit Types (object) (EventTypeForNdsGroup)

現時点で記録されたインシデントのカテゴリ。

IMPORTANT: イベントタイプの値の完全なリストは、頻繁に変更されます。

の配列 アラート監査タイプ(オブジェクト)またはアラート監査タイプ（オブジェクト）またはAPI ユーザー イベント タイプ（オブジェクト）またはサービス アカウント イベント タイプ（オブジェクト）または App Services イベント タイプ（オブジェクト）または自動インデックス作成イベント タイプ（オブジェクト）またはオートメーション構成イベント タイプ（オブジェクト）またはAWS ピア VPC 監査タイプ（オブジェクト）またはAzure ピア ネットワーク監査タイプ（オブジェクト）または課金イベント タイプ（オブジェクト）またはクラスター接続監査タイプ（オブジェクト）またはクラスター イベント タイプ（オブジェクト）またはCPS バックアップ イベント タイプ（オブジェクト）または Data Explorer アクセス イベント タイプ（オブジェクト）または Data Explorer イベント タイプ（オブジェクト）またはCPS バックアップ コンプライアンス ポリシー イベント タイプ（オブジェクト）またはディスク バックアップ イベント タイプ（オブジェクト）または暗号化イベント タイプ（オブジェクト）またはエクスポート バケット監査タイプ（オブジェクト）またはFTS インデックス監査タイプ（オブジェクト）またはGCP ピア VPC 監査タイプ（オブジェクト）またはグループ監査タイプ（オブジェクト）またはグループ イベント タイプ（オブジェクト）またはグループ統合イベント タイプ（オブジェクト）またはホスト イベント タイプ（オブジェクト）またはホスト メトリック イベント タイプ（オブジェクト）またはインデックス ビルド監査タイプ（オブジェクト）または NDS 監査タイプ（オブジェクト）または NDS DB チェック監査タイプ（オブジェクト）または NDS データ検証監査タイプ（オブジェクト）または NDS オートスケーリング監査タイプ（オブジェクト）または NDS メンテナンスウィンドウ監査タイプ（オブジェクト）または NDS サーバーレス オートスケーリング監査タイプ（オブジェクト）または NDS サーバーレス インスタンス監査タイプ（オブジェクト）または NDS オートスケーリング監査タイプ（オブジェクト）またはNDS テナント エンドポイント サービス配置監査タイプ（オブジェクト）または NDS x509 ユーザー認証イベント タイプ（オブジェクト）または Online Archive イベント タイプ（オブジェクト）またはプライベート リンク監査タイプ（オブジェクト）またはプロアクティブ操作イベント タイプ（オブジェクト）またはレプリカセット イベント タイプ（オブジェクト）または Search Deployment Audit Types (object) または Serverless Deployment Audit Types (object) または Serverless Event Types (object) または Flex Metric Event Types (object) または Setup Serverless Audit Types (object) または Streams Event Types (object) または Stream Processor Event Types (object) または Support Case Event Types (object) または Support Event Types (object) または Team Event Types (object) または Tenant Backup Event Types (object) または User Event Types (object) または Version Audit Types (object) または Resource Event Types (object) または Access Event Types (object) または Charts Api Call Audit Types (object) (EventTypeForNdsGroup)

クエリ結果から除外するイベントのカテゴリ（CLUSTER_CREATED など）

IMPORTANT: イベントタイプ名は頻繁に変更されます。イベントタイプの全リストをチェックして、イベントタイプが正しく指定されていることを確認してください。

includeRaw
ブール値
デフォルト: false

未加工のドキュメントを出力に含めるかどうかを示すフラグ。生のドキュメントには、イベントに関する追加のメタ情報が格納されています。

最大日付
string <date-time>

MongoDB Cloud がイベントを返すことを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式を使用します。

ISO 8601
minDate
string <date-time>

MongoDB Cloud がイベントを返すことを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式を使用します。

ISO 8601

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのプロジェクトから 1 つのイベントを返す

指定されたプロジェクトの 1 つのイベントを返します。イベントは、データベース、課金、セキュリティのアクティビティやステータスの変更に関する重要な情報を提供します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

このリソースは現在も改訂中であり、変更される可能性があります。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

eventId
必須
string^([a-f0-9]{24})$

返却対象のイベントを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのイベントを取得するには、/events エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

includeRaw
ブール値
デフォルト: false

未加工のドキュメントを出力に含めるかどうかを示すフラグ。生のドキュメントには、イベントに関する追加のメタ情報が格納されています。

応答

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "apiKeyId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "AUTO_INDEXING_ENABLED",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "isGlobalAdmin": false,
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "publicKey": "user@example.com",
  • "raw": {
    },
  • "remoteAddress": "216.172.40.186",
  • "userId": "32b6e34b3d91647abb20e7b8",
  • "username": "test.user@mongodb.com"
}

1 つの組織からすべてのイベントを返す

指定された組織の全イベントを返します。イベントは、データベース、課金、セキュリティのアクティビティやステータスの変更に関する重要な情報を提供します。このリソースを使用するには、リクエスト元のAPIキーに組織メンバーロールが必要です。

このリソースは現在も改訂中であり、変更される可能性があります。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

includeCount
ブール値
デフォルト: true
例: includeCount=true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100
例: itemsPerPage=100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1
例: pageNum=1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

の配列 アラート監査タイプ（オブジェクト）、またはアラート監査タイプ（オブジェクト）、または API ユーザー イベント タイプ（オブジェクト）、またはサービスアカウント イベントタイプ（オブジェクト）、または請求イベントタイプ（オブジェクト）、フェデレーション設定イベントタイプ（オブジェクト）、グループ監査タイプ（オブジェクト） ）、または M値移行監査タイプ（オブジェクト）、または NDS 監査タイプ（オブジェクト）、または組織イベント タイプ（オブジェクト）、またはパートナー イベント タイプ（オブジェクト）、またはサポート イベント タイプ（オブジェクト）、チーム イベント タイプ（オブジェクト）、またはユーザー イベント タイプ（オブジェクト） ）または リソース イベントタイプ （オブジェクト）、または Atlas リソース ポリシー監査タイプ （オブジェクト） (EventTypeForOrg)

現時点で記録されたインシデントのカテゴリ。

IMPORTANT: イベントタイプの値の完全なリストは、頻繁に変更されます。

includeRaw
ブール値
デフォルト: false

未加工のドキュメントを出力に含めるかどうかを示すフラグ。生のドキュメントには、イベントに関する追加のメタ情報が格納されています。

最大日付
string <date-time>

MongoDB Cloud がイベントを返すことを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式を使用します。

minDate
string <date-time>

MongoDB Cloud がイベントを返すことを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式を使用します。

ISO 8601

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つの組織から 1 つのイベントを返す

指定された組織の 1 つのイベントを返します。イベントは、データベース、課金、セキュリティのアクティビティやステータスの変更に関する重要な情報を提供します。このリソースを使用するには、リクエスト元のAPIキーに組織メンバーロールが必要です。

このリソースは現在も改訂中であり、変更される可能性があります。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

eventId
必須
string^([a-f0-9]{24})$

返却対象のイベントを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのイベントを取得するには、/events エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

includeRaw
ブール値
デフォルト: false

未加工のドキュメントを出力に含めるかどうかを示すフラグ。生のドキュメントには、イベントに関する追加のメタ情報が格納されています。

応答

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "apiKeyId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "FEDERATION_SETTINGS_CREATED",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "isGlobalAdmin": false,
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "publicKey": "user@example.com",
  • "raw": {
    },
  • "remoteAddress": "216.172.40.186",
  • "userId": "32b6e34b3d91647abb20e7b8",
  • "username": "test.user@mongodb.com"
}

フェデレーティッド認証

ロール マッピングや接続された組織の構成などのフェデレーション関連の機能の返却、追加、編集、削除を行います。

1 つのフェデレーション設定インスタンスを削除

フェデレーション設定インスタンスと、IdP やドメインを含むすべての関連データを削除します。このリソースを使用するには、リクエスト元の API キーが、最後に接続された組織の組織オーナーロールを持っている必要があります。注: フェデレーション内に接続されている組織が複数ある場合、このリソースへのリクエストは失敗します。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

応答

応答サンプル

コンテンツタイプ
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 つのフェデレーションからすべての接続された組織構成を返す

指定されたフェデレーション内の接続された組織の構成をすべて返します。このリソースを使用するには、リクエスト元の API キーに、接続されている組織のいずれかの組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100
例: itemsPerPage=100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1
例: pageNum=1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのフェデレーションに接続された 1 つの組織構成を削除

指定されたフェデレーションから、接続された組織構成を 1 つ削除します。このリソースを使用するには、リクエスト元の API キーに組織オーナー ロールが必要です。注: フェデレーション内に接続されている組織が 1 つだけ存在する場合、この要求は失敗します。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

削除対象の接続済み組織の構成を識別するユニークな 24 桁の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

1 つのフェデレーションに接続された 1 つの組織構成を返す

指定されたフェデレーションから指定された接続済み組織の構成を返します。このリソースを使用するには、リクエスト元の API キーが接続済み組織のオーナー ロールを持っている必要があります。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

返却対象の接続済み組織の構成を識別するユニークな 24 桁の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

1 つのフェデレーションに接続された 1 つの組織構成を更新

指定されたフェデレーションから、接続された組織構成を 1 つ更新します。このリソースを使用するには、リクエスト元の API キーに組織オーナー ロールが必要です。

注: 組織構成に IdP が関連付けられていない場合、このリソースを使用してロール マッピングを更新したり、承認ロールの付与を書き込みしたりすることはできません。

注: domainRestrictionEnabled フィールドは、リクエストで提供されなければ、デフォルトで false に設定されます。

注: identityProviderId フィールドが提供されない場合、組織と IdP は切断されます。

注: 現在接続されているデータアクセス IdP が dataAccessIdentityProviderIds フィールドに含まれていない場合は、接続が解除されます。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

更新対象の接続済み組織の構成を識別するユニークな 24 桁の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

リクエスト ボディ スキーマ: application/json

更新対象の接続済み組織の構成。

dataAccessIdentityProviderIds
の配列 string unique

この組織内のデータアクセスに使用できる IdP を表すユニークな ID のコレクション。

domainAllowList
の配列 string unique

メールアドレスに基づいて組織に参加できるユーザーを制限する承認済みドメイン。

domainRestrictionEnabled
必須
ブール値

この接続済み組織に対してドメイン制限が有効になっているかどうかを示す値。

identityProviderId
string^([a-f0-9]{20})$

この接続された組織構成が関連付けられている UI アクセス ID プロバイダーを識別する、レガシーの 20 桁の 16 進数文字列。この ID は、フェデレーティッド マネジメント コンソールの [ID プロバイダー] タブ内で、構成された ID プロバイダーの IdP ID 行の情報アイコンをクリックすると確認できます。

postAuthRoleGrants
の配列 string unique
アイテム列挙: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_BILLING_READ_ONLY" "ORG_READ_ONLY"

認証後にこの組織内のユーザーに付与される Atlas ロール。ロールは、MongoDB Cloud が特定の MongoDB Cloud ユーザーに付与する権限のコレクションを識別する、人間が判読可能なラベルです。これらのロールは、組織に固有のロールです。

の配列 オブジェクト （フェデレーション認証ロール マッピング） unique

この組織で設定されているロール マッピング。

の配列 オブジェクト （フェデレーティッド ユーザー）

許可リストのどのドメインとも一致しないメール アドレスを持つユーザーのリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "string",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

1 つの組織からすべてのロール マッピングを返す

指定されたフェデレーション内の指定された組織から、すべてのロールマッピングを返します。このリソースを使用するには、リクエスト元の API キーに組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つの組織に 1 つのロール マッピングを追加

指定されたフェデレーション内の指定された組織に 1 つのロール マッピングを追加します。このリソースを使用するには、リクエスト元の API キーに組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

リクエスト ボディ スキーマ: application/json

作成するロール マッピング。

externalGroupName
必須
string [ 1 .. 200 ] 文字

このロール・マッピングが適用される IdP グループを識別する、人間に判読可能なユニークなラベル。

の配列 オブジェクト (RoleAssignment) unique

Atlas のロールと、各ロールに関連付けられたグループおよび組織のユニークな識別子。配列には、組織ロールとそれに対応する orgId を持つ要素が少なくとも 1 つ含まれている必要があります。配列の各要素には、orgId または groupId の値を設定できますが、両方を設定することはできません。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "externalGroupName": "string",
  • "roleAssignments": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

1 つの組織から 1 つのロール マッピングを削除

指定された組織内の 1 つのロール マッピングを、指定されたフェデレーションから削除します。このリソースを使用するには、リクエスト元の API キーに組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

id
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

削除対象のロール マッピングを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

応答サンプル

コンテンツタイプ
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 キーに組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

id
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

返却対象のロール マッピングを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

1 つの組織の 1 つのロール マッピングを更新

指定されたフェデレーション内の指定された組織内の 1 つのロール マッピングを更新します。このリソースを使用するには、リクエスト元の API キーに組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

id
必須
string^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

更新対象のロール マッピングを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

リクエスト ボディ スキーマ: application/json

更新対象のロール マッピング。

externalGroupName
必須
string [ 1 .. 200 ] 文字

このロール・マッピングが適用される IdP グループを識別する、人間に判読可能なユニークなラベル。

の配列 オブジェクト (RoleAssignment) unique

Atlas のロールと、各ロールに関連付けられたグループおよび組織のユニークな識別子。配列には、組織ロールとそれに対応する orgId を持つ要素が少なくとも 1 つ含まれている必要があります。配列の各要素には、orgId または groupId の値を設定できますが、両方を設定することはできません。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "externalGroupName": "string",
  • "roleAssignments": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

1 つのフェデレーション内のすべての IdP を返す

指定されたフェデレーション内の指定されたプロトコルとタイプを持つすべての IdP を返します。プロトコルが指定されていない場合は、SAML ID プロバイダーのみが返されます。idpType が指定されていない場合は、WORKFORCE ID プロバイダーのみが返されます。このリソースを使用するには、リクエスト元の API キーが、接続されている組織のいずれかの組織オーナーロールを持っている必要があります。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100
例: itemsPerPage=100

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1
例: pageNum=1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

プロトコル
の配列 string
アイテム列挙: "SAML" "OIDC"

ターゲット IdP のプロトコル。

idpType
の配列 string
アイテム列挙: 「労働力」 「ワークロード」

ターゲット IdP の種類。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つの SAML IdP を返す

指定されたフェデレーションから 1 つの SAML ID プロバイダーを返します。 このリソースを使用するには、リクエスト元の API キーが、接続されている組織のいずれかの組織オーナーロールを持っている必要があります。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

identityProviderId
必須
string^([a-f0-9]{20})$
例: c2777a9eca931f29fc2f

IdP を識別するレガシーの 20 桁の 16 進数のstring 。 このIDは、フェデレーティッド マネジメント コンソールの [ID プロバイダー] タブ内で、構成された ID プロバイダーの IdP ID行の情報アイコンをクリックすると確認できます。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "acsUrl": "string",
  • "associatedDomains": [
    ],
  • "associatedOrgs": [
    ],
  • "audienceUri": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "idpType": "WORKFORCE",
  • "issuerUri": "string",
  • "oktaIdpId": "string",
  • "pemFileInfo": {
    },
  • "protocol": "SAML",
  • "requestBinding": "HTTP-POST",
  • "responseSignatureAlgorithm": "SHA-1",
  • "slug": "string",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "string",
  • "status": "ACTIVE",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

1 つの IdP のメタデータを返す

指定されたフェデレーション内の 1 つの IdP のメタデータを返します。このリソースを使用するには、リクエスト元の API キーに、接続されている組織のいずれかの組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

identityProviderId
必須
string^([a-f0-9]{20})$
例: c2777a9eca931f29fc2f

IdP を識別するレガシーの 20 桁の 16 進数のstring 。 このIDは、フェデレーティッド マネジメント コンソールの [ID プロバイダー] タブ内で、構成された ID プロバイダーの IdP ID行の情報アイコンをクリックすると確認できます。

応答

応答サンプル

コンテンツタイプ
application/ JSON
"string"

1 つの組織の 1 つのフェデレーション設定を返す

指定された組織のフェデレーション設定に関する情報を返します。このリソースを使用するには、リクエスト元の API キーが接続済み組織のオーナー ロールを持っている必要があります。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "federatedDomains": [
    ],
  • "hasRoleMappings": true,
  • "id": "32b6e34b3d91647abb20e7b8",
  • "identityProviderId": "c2777a9eca931f29fc2f",
  • "identityProviderStatus": "ACTIVE"
}

グローバルクラスター

グローバルクラスターで管理されている名前空間とカスタム ゾーン マッピングを返却、追加、削除します。グローバルクラスター内の各コレクションは、管理対象の名前空間に関連付けられています。グローバルクラスターの管理対象名前空間を作成すると、MongoDB Cloud はその名前空間の空のコレクションを作成します。管理対象の名前空間を作成しても、コレクションにデータは入力されません。同様に、管理対象の名前空間を削除しても、関連付けられているコレクションは削除されません。MongoDB Cloud は、必要なロケーション フィールドとカスタム シャードキーを使用して、空のコレクションをシャーディングします。たとえば、カスタム シャードキーが city の場合、複合シャードキーは location, city になります。各グローバルクラスターは、1 つ以上のグローバル書き込みゾーンにも関連付けられます。ユーザーがグローバルクラスターを作成すると、MongoDB Cloud は各ロケーション コードを最も近い地理的ゾーンに自動的にマッピングします。カスタム ゾーン マッピングを使用すると、管理者はこれらの自動マッピングを変更できます。たとえば、ロケーション コードを地理的に離れたゾーンにマッピングする必要があるユースケースもあります。管理者は、グローバルクラスターを作成または変更するときに、以下の API と [Global Cluster Configuration（グローバルクラスター設定）] ペインを使用してカスタム ゾーン マッピングを管理できます。

すべてのグローバルクラスター データを返す

指定されたグローバルクラスターで管理されているすべての名前空間とカスタム ゾーン マッピングを返します。 管理された名前空間は、データベース名、ドット区切り、およびコレクション名を使用してコレクションを識別します。 カスタム ゾーン マッピングは、ISO 3166-2 ロケーション コードをグローバルクラスター内のゾーンに一致させます。 このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

グローバルクラスター
認可:
DigestAuthServiceAccounts
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=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

1 つのグローバルクラスターからすべてのカスタム ゾーン マッピングを削除

指定されたグローバルクラスターのすべてのカスタム ゾーン マッピングを削除します。カスタム ゾーン マッピングは、1 つの ISO 3166-2 ロケーション コードをグローバルクラスター内のゾーンに一致させます。カスタム ゾーン マッピングを削除すると、デフォルトのマッピングが復元されます。デフォルトでは、MongoDB Cloud は各ロケーション コードを最も近い地理的ゾーンにマッピングします。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

グローバルクラスター
認可:
DigestAuthServiceAccounts
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=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

1 つのグローバルクラスターにカスタム ゾーン マッピングを追加

指定されたグローバルクラスターに 1 つ以上のカスタム ゾーン マッピングを追加します。 カスタム ゾーン マッピングは、1 つの ISO 3166-2 ロケーション コードをグローバルクラスター内のゾーンに一致させます。 デフォルトでは、MongoDB Cloud は各ロケーション コードを最も近い地理的ゾーンにマッピングします。 このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

グローバルクラスター
認可:
DigestAuthServiceAccounts
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=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

リクエスト ボディ スキーマ: application/json

指定されたグローバルクラスターに追加するカスタム ゾーン マッピング。