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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 キーに Project Monitoring の管理者ロールが必要です。

データベース アクセス履歴
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 バックアップ イベント タイプ（オブジェクト）または Full Text Searchインデックス監査タイプ（オブジェクト）またはグループ イベント タイプ（オブジェクト）または NDS 監査タイプ（オブジェクト）または NDS メンテナンスウィンドウ監査タイプ（オブジェクト）または Atlas Online Archive イベント タイプ（オブジェクト）またはユーザー イベント タイプ（オブジェクト）またはリソース イベント タイプ（オブジェクト）またはストリーム プロセッサ イベント タイプ（オブジェクト）または 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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必須
string = 24文字 ^([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 バックアップ イベント タイプ（オブジェクト）または Full Text Searchインデックス監査タイプ（オブジェクト）またはグループ イベント タイプ（オブジェクト）または NDS 監査タイプ（オブジェクト）または NDS メンテナンスウィンドウ監査タイプ（オブジェクト）または Atlas Online Archive イベント タイプ（オブジェクト）またはユーザー イベント タイプ（オブジェクト）またはリソース イベント タイプ（オブジェクト）またはストリーム プロセッサ イベント タイプ（オブジェクト）または 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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

alertId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必須
string = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

alertId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

alertId
必須
string = 24文字 ^([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 年後に設定します。

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

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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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

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

タイプ
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",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

indexId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

indexId
必須
string = 24文字 ^([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",
  • "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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

indexId
必須
string = 24文字 ^([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

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

タイプ
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",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 つのスナップショット エクスポート バケットを作成

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

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 S 3バケットと IAM ロールを指定します。

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

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

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

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

iamRoleId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

exportBucketId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

exportBucketId
必須
string = 24文字 ^([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 = 24文字 ^([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,
  • "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 = 24文字 ^([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 = 24文字 ^([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,
  • "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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$

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

snapshotId
必須
string = 24文字 ^([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"
}

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

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

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

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

エクスポート ジョブを識別する一意の24桁の 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"
}

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

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

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$

スナップショットを識別するユニークな 24 桁の 16 進数の文字列。

targetClusterName
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

復元ジョブがスナップショットを復元するターゲット クラスターを識別する、人間が判読できるラベル。リソースは、"deliveryType": "automated" の場合にこのパラメータを返します。automated と pointInTime の復元タイプでは必須です。

targetGroupId
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

restoreJobId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

restoreJobId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

snapshotId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

snapshotId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

snapshotId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

snapshotId
必須
string = 24文字 ^([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 つのクラウドバックアップ スナップショットの有効期限を変更します。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

snapshotId
必須
string = 24文字 ^([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 キーにプロジェクト オーナーのロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 キーにプロジェクト オーナーのロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$

スナップショットを識別するユニークな 24 桁の 16 進数の文字列。

targetClusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

復元ジョブがスナップショットを復元するターゲット クラスターを識別する、人間が判読できるラベル。リソースは、"deliveryType": "automated" の場合にこのパラメータを返します。

targetGroupId
必須
string = 24文字 ^([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 キーにプロジェクト オーナーのロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

サーバーレスインスタンスを識別する、人間が判読できるラベル。

restoreJobId
必須
string = 24文字 ^([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 キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

サーバーレスインスタンスを識別する、人間が判読できるラベル。

snapshotId
必須
string = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

validationId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

liveMigrationId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

liveMigrationId
必須
string = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

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

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

roleId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

roleId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

roleId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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": "2022-01-01T00:00:00Z",
  • "state": "START_REQUESTED"
}

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

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

クラスター停止時シミュレーション
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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": "2022-01-01T00:00:00Z",
  • "state": "START_REQUESTED"
}

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

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

クラスター停止時シミュレーション
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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": "2022-01-01T00:00:00Z",
  • "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 キーにプロジェクトの読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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）ブロックを割り当てます。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 を現在の日付に設定してください。

リージョン停止時のレプリカセットの再構成
オブジェクト （自動クラスター スケーリング設定）

クラスターを増やすことができるインスタンス サイズの範囲。

クラスターの自動スケーリング
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 [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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",
  • "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",
  • "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 = 24文字 ^([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 つの共有階層クラスターのアップグレード

指定されたプロジェクト内の共有階層クラスターをアップグレードします。このリソースを使用するには、リクエスト元の API キーにプロジェクト クラスター マネージャー ロールが必要です。各プロジェクトは最大 25 クラスターをサポートします。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 を現在の日付に設定してください。

リージョン停止時のレプリカセットの再構成
オブジェクト （自動クラスター スケーリング設定）

クラスターを増やすことができるインスタンス サイズの範囲。

クラスターの自動スケーリング
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 [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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",
  • "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",
  • "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つの共有クラスターをサーバーレスインスタンスにアップグレードする

指定されたプロジェクトの共有階層クラスターをサーバーレスインスタンスにアップグレードします。このリソースを使用するには、リクエスト元の API キーにプロジェクト クラスター マネージャー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 キーにプロジェクト オーナーのロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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",
  • "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共有階層クラスターでは使用できません。

リージョンをまたがるクラスターの合計ノード数にはプロジェクトごとに特定の制約があります。 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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 を現在の日付に設定してください。

リージョン停止時のレプリカセットの再構成
オブジェクト （自動クラスター スケーリング設定）

クラスターを増やすことができるインスタンス サイズの範囲。

クラスターの自動スケーリング
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 [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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",
  • "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",
  • "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 つのクラスターの高度な構成の詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。高度な設定の詳細には、読み取り保証/書込み保証、インデックス制限および oplog 制限、およびその他のデータベース設定が含まれます。この機能は、M0 無料クラスター、M2 および M5 の共有階層クラスター、またはサーバーレス クラスターでは使用できません。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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,
  • "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,
  • "transactionLifetimeLimitSeconds": 1
}

1 つのクラスターの高度な構成オプションを更新

指定されたプロジェクト内の 1 つのクラスターの高度な構成の詳細を更新します。クラスターには、同じデータセットを維持するホストのグループが含まれます。高度な設定の詳細には、読み取り保証/書込み保証、インデックス制限および oplog 制限、およびその他のデータベース設定が含まれます。このリソースを使用するには、リクエスト元の API キーにプロジェクト クラスター マネージャー ロールが必要です。この機能は、M0 無料クラスター、M2 および M5 の共有階層クラスター、またはサーバーレス クラスターでは使用できません。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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` 構成ファイル オプションに相当します。
デフォルト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` オプションに相当します。
transactionLifetimeLimitSeconds
integer <int64> >= 1

マルチドキュメントトランザクションの有効期間（単位は秒）。Atlas は、この制限を超えるトランザクションは期限切れと見なし、定期的なクリーンアップ プロセスによって中断します。

このオプションは、`transactionLifetimeLimitSeconds` `mongod` 構成ファイル オプションに相当します。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "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,
  • "transactionLifetimeLimitSeconds": 1
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "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,
  • "transactionLifetimeLimitSeconds": 1
}

1 つのクラスターのフェイルオーバーのテスト

指定されたプロジェクト内の指定されたクラスターのフェイルオーバー テストを開始します。クラスターには、同じデータセットを維持するホストのグループが含まれます。フェイルオーバー テストは、MongoDB Cloud がクラスターのプライマリ ノードの障害をどのように取り扱うかを確認します。テスト中、MongoDB Cloud はプライマリ ノードをシャットダウンし、新しいプライマリを選択します。このリソースを使用するには、リクエスト元の API キーにプロジェクト クラスター マネージャー ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

name
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

sampleDatasetId
必須
string = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 キーに Project Atlas の管理者ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 = 24文字 ^([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 キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([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

指定されたプロジェクトに追加するフェデレーティッドデータベースインスタンスとオンラインアーカイブのプライベートエンドポイント。

azureConnectionName
string

Azureプライベートエンドポイント接続を識別する接続名。

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 = 22文字 ^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
{
  • "azureConnectionName": "string",
  • "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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

endpointId
必須
string = 22文字 ^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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

endpointId
必須
string = 22文字 ^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
{
  • "azureConnectionName": "string",
  • "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 = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{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>
例: completedAfter=2022-01-01T00:00:00Z

MongoDB Cloud がスナップショットを作成した日時。指定すると、MongoDB Cloud はこの日時以降に作成された利用可能なバックアップ スナップショットのみを返します。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

応答

応答サンプル

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

1 つの Data Lake パイプラインを一時停止 （非推奨）

指定されたプロジェクト内の Data Lake パイプラインの取り込みを一時停止します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{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>
例: createdBefore=2022-01-01T00:00:00Z

指定した場合、Atlas は、この日時より前に開始された Data Lake パイプラインの実行のみを返します。

応答

応答サンプル

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

パイプライン実行データセットを削除 （非推奨）

指定されたパイプラインの実行中に Atlas が生成したデータセットを削除します。

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

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

pipelineRunId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{1,64}$

Data Lake パイプラインを識別する、人間が判読可能なラベル。

pipelineRunId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必須
string [ 1 .. 64 ] 文字 ^[^/\\ "$]{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 = 24文字 ^([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 = 24文字 ^([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 管理者ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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文字 ^([a-f0-9]{24})$

プロジェクトを識別するユニークな 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 = 24文字 ^([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 = 24文字 ^([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 キーにプロジェクトオーナーまたはプロジェクト Charts 管理者ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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文字 ^([a-f0-9]{24})$

プロジェクトを識別するユニークな 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": "32b6e34b3d91647abb20e7b8",
  • "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 = 24文字 ^([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 = 24文字 ^([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 つのプロジェクトからすべてのイベントを返す

指定されたプロジェクトの 1 つのイベントを返します。イベントは、データベース、課金、セキュリティのアクティビティやステータスの変更に関する重要な情報を提供します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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[ items [ 1 .. 64 ] characters ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ ]

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

の配列 アラート監査タイプ（オブジェクト）、またはアラート監査タイプ（オブジェクト）、またはAPIユーザー イベント タイプ（オブジェクト）、またはサービスアカウント イベントタイプ（オブジェクト）、または App Services イベントタイプ（オブジェクト）、またはオートインデックス作成イベントタイプ（オブジェクト）、またはオートメーション構成イベントタイプ（オブジェクト）またはAmazon Web ServicesピアVPC監査タイプ（オブジェクト）またはAzureピア ネットワーク監査タイプ（オブジェクト）または請求イベント タイプ（オブジェクト）またはクラスター接続監査タイプ（オブジェクト）またはクラスター イベントタイプ（オブジェクト）または Cps バックアップ イベントタイプ（オブジェクト）または Data Explorer にアクセス可能なイベント タイプ（オブジェクト）または CPS バックアップ コンプライアンス ポリシー イベント タイプ（オブジェクト）またはディスクバックアップ イベントタイプ（オブジェクト）または暗号化イベントタイプ（オブジェクト）またはエクスポート バケット監査タイプ（オブジェクト）または FTS インデックス監査タイプ（オブジェクト）またはGCPピアVPC監査タイプ（オブジェクト）またはグループ監査タイプ（オブジェクト）またはグループ イベント タイプ（オブジェクト）またはグループ統合イベント タイプ（オブジェクト）またはホスト イベント タイプ（オブジェクト）またはホスト メトリクス イベント タイプ（オブジェクト）、またはインデックス構築監査タイプ（オブジェクト）または NDS 監査タイプ（オブジェクト）または N DSDB チェック監査タイプ（オブジェクト）または NDS データ検証監査タイプ（オブジェクト）または NDS オートスケーリング監査タイプ（オブジェクト）または NDS メンテナンスウィンドウ監査タイプ（オブジェクト）または NDS サーバーレス オートスケーリング監査タイプ（オブジェクト）または NDS サーバーレス インスタンス監査タイプ（オブジェクト）または NDS オートスケーリング監査タイプ（オブジェクト）または NDS テナント エンドポイント サービス配置監査タイプ（オブジェクト）または NDS x509 ユーザー認証イベント タイプ（オブジェクト）またはオンライン アーカイブ イベント タイプ（オブジェクト）またはプライベート リンク監査タイプ（オブジェクト）またはプロアクティブ操作イベント タイプ（オブジェクト）または ReplicaSet イベント タイプ（オブジェクト）または検索配置監査タイプ（オブジェクト）またはサーバーレス配置監査タイプ（オブジェクト）またはサーバーレス イベント タイプ（オブジェクト）またはセットアップ サーバーレス監査タイプ（オブジェクト）、またはストリーム イベント タイプ（オブジェクト）、ストリーム プロセッサ イベント タイプ（オブジェクト）、サポート ケース イベント タイプ（オブジェクト）、サポート イベント タイプ（オブジェクト）、チーム イベント タイプ（オブジェクト）、テナント バックアップ イベント タイプ（オブジェクト）、ユーザー イベント タイプ（オブジェクト） ）またはバージョン監査タイプ（オブジェクト）または リソース イベントタイプ（オブジェクト） (EventTypeForNdsGroup)

現時点で記録されたインシデントのカテゴリ。

IMPORTANT: イベントタイプの値の完全なリストは、頻繁に変更されます。

の配列 アラート監査タイプ（オブジェクト）、またはアラート監査タイプ（オブジェクト）、またはAPIユーザー イベント タイプ（オブジェクト）、またはサービスアカウント イベントタイプ（オブジェクト）、または App Services イベントタイプ（オブジェクト）、またはオートインデックス作成イベントタイプ（オブジェクト）、またはオートメーション構成イベントタイプ（オブジェクト）またはAmazon Web ServicesピアVPC監査タイプ（オブジェクト）またはAzureピア ネットワーク監査タイプ（オブジェクト）または請求イベント タイプ（オブジェクト）またはクラスター接続監査タイプ（オブジェクト）またはクラスター イベントタイプ（オブジェクト）または Cps バックアップ イベントタイプ（オブジェクト）または Data Explorer にアクセス可能なイベント タイプ（オブジェクト）または CPS バックアップ コンプライアンス ポリシー イベント タイプ（オブジェクト）またはディスクバックアップ イベントタイプ（オブジェクト）または暗号化イベントタイプ（オブジェクト）またはエクスポート バケット監査タイプ（オブジェクト）または FTS インデックス監査タイプ（オブジェクト）またはGCPピアVPC監査タイプ（オブジェクト）またはグループ監査タイプ（オブジェクト）またはグループ イベント タイプ（オブジェクト）またはグループ統合イベント タイプ（オブジェクト）またはホスト イベント タイプ（オブジェクト）またはホスト メトリクス イベント タイプ（オブジェクト）、またはインデックス構築監査タイプ（オブジェクト）または NDS 監査タイプ（オブジェクト）または N DSDB チェック監査タイプ（オブジェクト）または NDS データ検証監査タイプ（オブジェクト）または NDS オートスケーリング監査タイプ（オブジェクト）または NDS メンテナンスウィンドウ監査タイプ（オブジェクト）または NDS サーバーレス オートスケーリング監査タイプ（オブジェクト）または NDS サーバーレス インスタンス監査タイプ（オブジェクト）または NDS オートスケーリング監査タイプ（オブジェクト）または NDS テナント エンドポイント サービス配置監査タイプ（オブジェクト）または NDS x509 ユーザー認証イベント タイプ（オブジェクト）またはオンライン アーカイブ イベント タイプ（オブジェクト）またはプライベート リンク監査タイプ（オブジェクト）またはプロアクティブ操作イベント タイプ（オブジェクト）または ReplicaSet イベント タイプ（オブジェクト）または検索配置監査タイプ（オブジェクト）またはサーバーレス配置監査タイプ（オブジェクト）またはサーバーレス イベント タイプ（オブジェクト）またはセットアップ サーバーレス監査タイプ（オブジェクト）、またはストリーム イベント タイプ（オブジェクト）、ストリーム プロセッサ イベント タイプ（オブジェクト）、サポート ケース イベント タイプ（オブジェクト）、サポート イベント タイプ（オブジェクト）、チーム イベント タイプ（オブジェクト）、テナント バックアップ イベント タイプ（オブジェクト）、ユーザー イベント タイプ（オブジェクト） ）またはバージョン監査タイプ（オブジェクト）または リソース イベントタイプ（オブジェクト） (EventTypeForNdsGroup)

クエリ結果から除外するイベントのカテゴリ（CLUSTER_CREATED など）

IMPORTANT: イベントタイプ名は頻繁に変更されます。イベントタイプの全リストをチェックして、イベントタイプが正しく指定されていることを確認してください。

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

未加工のドキュメントを出力に含めるかどうかを示すフラグ。生のドキュメントには、イベントに関する追加のメタ情報が格納されています。

最大日付
string <date-time>

MongoDB Cloud がイベントの返送を停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式を使用します。

minDate
string <date-time>

MongoDB Cloud がイベントの返送を開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式を使用します。

応答

応答サンプル

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

1 つのプロジェクトから 1 つのイベントを返す

指定されたプロジェクトの 1 つのイベントを返します。イベントは、データベース、課金、セキュリティのアクティビティやステータスの変更に関する重要な情報を提供します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

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

eventId
必須
string = 24文字 ^([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": "test.user@mongodb.com",
  • "raw": {
    },
  • "remoteAddress": "216.172.40.186",
  • "userId": "32b6e34b3d91647abb20e7b8",
  • "username": "test.user@mongodb.com"
}

1 つの組織からすべてのイベントを返す

指定された組織の全イベントを返します。イベントは、データベース、課金、セキュリティのアクティビティやステータスの変更に関する重要な情報を提供します。このリソースを使用するには、リクエスト元のAPIキーに組織メンバーロールが必要です。

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

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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>
例: minDate=2021-11-17T23:15:00.06Z

MongoDB Cloud がイベントの返送を開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式を使用します。

応答

応答サンプル

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

1 つの組織から 1 つのイベントを返す

指定された組織の 1 つのイベントを返します。イベントは、データベース、課金、セキュリティのアクティビティやステータスの変更に関する重要な情報を提供します。このリソースを使用するには、リクエスト元のAPIキーに組織メンバーロールが必要です。

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

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

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

eventId
必須
string = 24文字 ^([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": "test.user@mongodb.com",
  • "raw": {
    },
  • "remoteAddress": "216.172.40.186",
  • "userId": "32b6e34b3d91647abb20e7b8",
  • "username": "test.user@mongodb.com"
}

フェデレーティッド認証

ロール マッピングや接続された組織の構成などのフェデレーション関連の機能の返却、追加、編集、削除を行います。

1 つのフェデレーション設定インスタンスを削除

フェデレーション設定インスタンスと、IdP やドメインを含むすべての関連データを削除します。このリソースを使用するには、リクエスト元の API キーが、最後に接続された組織の組織オーナーロールを持っている必要があります。注: フェデレーション内に接続されている組織が複数ある場合、このリソースへのリクエストは失敗します。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

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

返却対象の接続済み組織の構成を識別するユニークな 24 桁の 16 進数文字列。

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

1 つのフェデレーションに接続された 1 つの組織構成を更新

指定されたフェデレーションから、接続された組織構成を 1 つ更新します。このリソースを使用するには、リクエスト元の API キーに組織オーナー ロールが必要です。

注: 組織構成に IdP が関連付けられていない場合、このリソースを使用してロール マッピングを更新したり、承認ロールの付与を書き込みしたりすることはできません。

注: domainRestrictionEnabled フィールドは、リクエストで提供されなければ、デフォルトで false に設定されます。

注: identityProviderId フィールドが提供されない場合、組織と IdP は切断されます。

注: 現在接続されているデータアクセス IdP が dataAccessIdentityProviderIds フィールドに含まれていない場合は、接続が解除されます。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

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

更新対象の接続済み組織の構成を識別するユニークな 24 桁の 16 進数文字列。

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

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

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

更新対象の接続済み組織の構成。

dataAccessIdentityProviderIds
の配列 string unique [ items = 24 文字 ^([a-f0-9]{24})$ ]

この組織内のデータアクセスに使用できる IdP を表すユニークな ID のコレクション。

domainAllowList
の配列 string unique

メールアドレスに基づいて組織に参加できるユーザーを制限する承認済みドメイン。

domainRestrictionEnabled
必須
ブール値

この接続済み組織に対してドメイン制限が有効になっているかどうかを示す値。

identityProviderId
string = 20 文字 ^([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": "stringstringstringst",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

1 つの組織からすべてのロール マッピングを返す

指定されたフェデレーション内の指定された組織から、すべてのロールマッピングを返します。このリソースを使用するには、リクエスト元の API キーに組織オーナー ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
federationSettingsId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

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

削除対象のロール マッピングを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

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

返却対象のロール マッピングを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

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

更新対象のロール マッピングを識別するユニークな 24 桁の 16 進数文字列。

orgId
必須
string = 24文字 ^([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 = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

identityProviderId
必須
string = 20 文字 ^([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": "stringstringstringst",
  • "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 = 24文字 ^([a-f0-9]{24})$
例: 55fa922fb343282757d9554e

フェデレーションを識別するユニークな 24 桁の 16 進数文字列。

identityProviderId
必須
string = 20 文字 ^([a-f0-9]{20})$
例: c2777a9eca931f29fc2f

IdP を識別するレガシーの 20 桁の 16 進数のstring 。 このIDは、フェデレーティッド マネジメント コンソールの [ID プロバイダー] タブ内で、構成された ID プロバイダーの IdP ID行の情報アイコンをクリックすると確認できます。

応答

応答サンプル

コンテンツタイプ
application/ JSON
"string"

1 つの組織の 1 つのフェデレーション設定を返す

指定された組織のフェデレーション設定に関する情報を返します。このリソースを使用するには、リクエスト元の API キーが接続済み組織のオーナー ロールを持っている必要があります。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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

指定されたグローバルクラスターに追加するカスタム ゾーン マッピング。

の配列 オブジェクト （グローバルクラスター ゾーン）

ゾーンを地理的リージョンにマッピングするための、カンマ区切りのキーと値のペアが格納されたリスト。これらのペアは、ISO 3166-1a2 ロケーション コードと、可能な場合は ISO 3166-2 下位分類コードを、人間が判読可能な目的のカスタム ゾーンのラベルにマッピングします。MongoDB Cloud は、デフォルトで ISO 3166-1a2 コードを最も近い地理的ゾーンにマッピングします。デフォルトのマッピングを変更するには、このパラメーターを含めます。

カスタム ゾーンが存在しない場合は、このパラメーターは空のオブジェクトを返します。

応答

リクエスト サンプル

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

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

1 つのグローバルクラスターから 1 つの管理対象名前空間を削除

指定されたグローバルクラスター内の 1 つの管理対象名前空間を削除します。管理された名前空間は、データベース名、ドット区切り、およびコレクション名を使用してコレクションを識別します。管理対象の名前空間を削除しても、関連付けられているコレクションやデータは削除されません。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

このグローバルクラスターを識別する、人間が判読できるラベル。

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

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

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

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

db
string

コレクションが保存されたデータベースを識別する、人間が判読可能なラベル。

コレクション
string

管理対象の名前空間に関連付けられているコレクションを識別する、人間が判読可能なラベル。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

1 つのグローバルクラスターに 1 つの管理対象名前空間を作成

指定されたグローバルクラスター内に管理対象名前空間を 1 つ作成します。管理された名前空間は、データベース名、ドット区切り、およびコレクション名を使用してコレクションを識別します。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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

指定されたグローバルクラスター内に作成する管理対象名前空間。

コレクション
必須
string

このグローバルクラスターで管理するコレクションの、人間が判読可能なラベル。

db
必須
string

このグローバルクラスターで管理する、人間が判読可能なデータベースのラベル。

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

指定されたコレクションのカスタム シャードキーが誰かがハッシュしたかどうかを示すフラグ。 この値をfalseに設定すると、MongoDB Cloud は範囲シャーディングを使用します。

ハッシュされたシャードキー
isShardKeyUnique
ブール値
デフォルト: false

誰かがカスタム シャードキーをハッシュしたかどうかを示すフラグ。 このパラメータがfalseを返す場合、このクラスターは範囲シャーディングを使用します。

numInitialChunks
integer <int64> <= 8192

空の コレクションをハッシュされたシャードキーでシャーディングするときに最初に作成するチャンクの最小数。

グローバルクラスターシャーディング
presplitHashedZones
ブール値
デフォルト: false

MongoDB Cloud が、空のコレクションや存在しないコレクションの初期チャンクを作成して配布するかどうかを示すフラグ。MongoDB Cloud は、コレクションに定義されたゾーンとゾーン範囲に基づいてデータを配布します。

ハッシュされたシャードキー

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "collection": "string",
  • "db": "string",
  • "isCustomShardKeyHashed": false,
  • "isShardKeyUnique": false,
  • "numInitialChunks": 8192,
  • "presplitHashedZones": false
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

1 つのグローバルクラスターからすべてのカスタム ゾーン マッピングを削除

指定されたグローバルクラスターのすべてのカスタム ゾーン マッピングを削除します。カスタム ゾーン マッピングは、1 つの ISO 3166-2 ロケーション コードをグローバルクラスター内のゾーンに一致させます。カスタム ゾーン マッピングを削除すると、デフォルトのマッピングが復元されます。デフォルトでは、MongoDB Cloud は各ロケーション コードを最も近い地理的ゾーンにマッピングします。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つの管理対象名前空間を削除します。管理された名前空間は、データベース名、ドット区切り、およびコレクション名を使用してコレクションを識別します。管理対象の名前空間を削除しても、関連付けられているコレクションやデータは削除されません。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。

グローバルクラスター
認可:
DigestAuthServiceAccounts
path パラメータ
clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

グループ ID
必須
string = 24文字 ^([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 形式にするかどうかを示すフラグ。

db
string

コレクションが保存されたデータベースを識別する、人間が判読可能なラベル。

コレクション
string

管理対象の名前空間に関連付けられているコレクションを識別する、人間が判読可能なラベル。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

請求書

請求書を返します。

1 つの組織のすべての請求書を返す

指定された組織に MongoDB が発行したすべての請求書を返します。このリストには、請求書のステータスに関係なく、すべての請求書が含まれます。このリソースを使用するには、リクエスト元の API キーに組織請求閲覧者、組織請求管理者、または組織オーナーのロールが必要です。組織をまたいだ設定をしている場合、組織請求管理者または組織オーナーのロールがあれば、リンクされた請求書を表示できます。請求書の合計支払額を計算するには、各請求書の合計支払額を合計します。請求書に含まれる各支払いの未払い金額の合計として計算できます。支払いの未払い金額を計算するには、totalBilledCents * unitPrice + salesTax - startingBalanceCents という式を使用します。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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 形式にするかどうかを示すフラグ。

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

linkedInvoices フィールドにリンクされた請求書を返すかどうかを示すフラグ。

statusNames
の配列 string unique
アイテム列挙: "PENDING" "CLOSED" "FORG際" "FAILED" "PAID" "無料" "REPAID" "INvoiced"

検索する請求書のステータス。 省略すると、すべてのステータスの請求書が返されます。

fromDate
string <date>
例: fromDate= 2023 - 01 - 01

fromDate が 以上の請求書を取得します。 省略した場合、返される請求書は最も近い startDate に戻りGo 。

toDate
string <date>
例: toDate= 2023 - 01 - 01

endDate が toDate 以下の請求書を取得します。 省略した場合、返される請求書は最新のGoよりも超過します。

sortBy
string
デフォルト: "END_DATE"
列挙: "START_DATE" "END_DATE"

返された請求書を並べ替えるために使用されるフィールド。 結果の順序を制御するには、orderBy パラメーターと組み合わせて使用します。

並び替え基準：
string
デフォルト: "desc"
列挙: "desc" "asc"
例: OrderBy=desc

返された請求書を並べ替えるために使用されるフィールド。 結果の順序を制御するには、 sortBy パラメーターと組み合わせて使用します。

応答

応答サンプル

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

1 つの組織のすべての保留中の請求書を返す

指定された組織の現在の請求サイクルで料金が発生しているすべての請求書を返します。このリソースを使用するには、リクエスト元の API キーに組織請求閲覧者、組織請求管理者、または組織オーナーのロールが必要です。組織をまたいだ設定をしている場合、組織請求管理者または組織オーナーのロールがあれば、リンクされた請求書を表示できます。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つの組織の請求書を返す

指定された組織に MongoDB が発行した請求書を 1 つ返します。 一意な 24 桁の 16 進数stringによって請求書が識別されます。 この請求書は JSON 形式または CSV 形式で受信できます。 このリソースを使用するには、リクエスト元の API キーに組織請求閲覧者、組織請求管理者、または組織オーナーのロールが必要です。 組織をまたいだ設定をしている場合、組織請求管理者または組織オーナーのロールがあれば、リンクされた請求書をクエリできます。 請求書の未払い金額の合計を計算するには、請求書に含まれる各支払いの未払い金額の総額を合計します。 支払いの未払い金額を計算するには、 totalBilledCents * unitPrice + salesTax - startingBalanceCentsという式を使用します。

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

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

invoiceId
必須
string = 24文字 ^([a-f0-9]{24})$

指定された組織に提出された請求書を識別するユニークな 24 桁の 16 進数文字列。料金は通常翌日に書き込みされます。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
{
  • "amountBilledCents": 0,
  • "amountPaidCents": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "creditsCents": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lineItems": [
    ],
  • "linkedInvoices": [
    ],
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "payments": [
    ],
  • "refunds": [
    ],
  • "salesTaxCents": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "startingBalanceCents": 0,
  • "statusName": "PENDING",
  • "subtotalCents": 0,
  • "updated": "2019-08-24T14:15:22Z"
}

1 つの組織の請求書をCSVで返す

指定された組織に MongoDB が発行した請求書を 1 つ CSV 形式で返します。ユニークな 24 桁の 16 進数文字列によって請求書が識別されます。このリソースを使用するには、リクエスト元の API キーに少なくとも組織請求閲覧者、組織請求管理者、または組織オーナーの役割が必要です。組織をまたいだ設定をしている場合、組織請求管理者または組織オーナーのロールがあれば、リンクされた請求書をクエリできます。請求書の未払い金額の合計を計算するには、請求書に含まれる各支払いの未払い金額の総額を合計します。支払いの未払い金額を計算するには、totalBilledCents * unitPrice + salesTax - startingBalanceCents という式を使用します。

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

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

invoiceId
必須
string[0-9a-f]+

指定された組織に提出された請求書を識別するユニークな 24 桁の 16 進数文字列。料金は通常翌日に書き込みされます。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
text/ CSV
請求書番号,666acb8787ba43606905dcae,
請求期間,「6月1 、 2024 - 7月1 、 2024 ",
組織名,2をテスト,
組織ID,666acb8787ba43606905dcac,

日付,使用日,説明,注意,組織名,組織ID,プロジェクト,プロジェクトID,SKU,リージョン,クラスター,レプリカセット,Config Server,アプリケーション,単位,単価,数量,割引率,金額

LDAP 構成

LDAP 設定を返却、編集、検証、削除します。LDAP 設定は、MongoDB Cloud がユーザーの認証と承認のために TLS 経由で LDAP サーバーに接続するための設定を定義します。LDAP サーバーは、インターネットから見えるか、VPC ピアリングを使用して MongoDB Cloud クラスターに接続されている必要があります。また、LDAP サーバーは TLS を使用する必要があります。これらのエンドポイントを使用するには、MongoDB Cloud 管理者ユーザー権限が必要です。また、LDAPS を使用してユーザーの認証と承認を設定するには、クラスターで MongoDB 3.6 以降を実行している必要があります。LDAPS を設定したグループは、MongoDB 3.6 以前のバージョンを使用してクラスターを作成することはできません。

現在の LDAP または X.509 構成を返す

指定されたプロジェクトの現在の LDAP 設定を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

LDAP または X.509 構成を編集

指定されたプロジェクトの LDAP 設定を編集します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

この設定を更新すると、データベースのローリング再起動がトリガーされます。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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

指定されたプロジェクトの LDAP 設定を更新します。

オブジェクト （データベースユーザー TLS 証明書設定）

データベースユーザーの TLS 証明書を構成するための設定。

オブジェクト （LDAP セキュリティ設定）

指定されたプロジェクトに適用される、TLS（Transport Layer Security）経由の LDAP（Lightweight Directory Access Protocol）設定の詳細。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "customerX509": {
    },
  • "ldap": {
    }
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

現在の LDAP ユーザーから DN へのマッピングの削除

指定されたプロジェクトの LDAP 設定から、userToDNMapping ドキュメントでキャプチャされた現在の LDAP 識別名マッピングを削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

1 つのプロジェクトの LDAP 構成を確認

指定されたプロジェクトの LDAP 設定を検証します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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

指定された検証対象プロジェクトの LDAP 設定。

authzQueryTemplate
string
デフォルト: "{USER}?memberOf?base"

認証された MongoDB ユーザーに関連付けられた LDAP（Lightweight Directory Access Protocol）グループを返す LDAP クエリを作成するためにMongoDB Cloud が適用する、LDAPクエリ テンプレート。MongoDB Cloud はこのパラメーターをユーザー認証にのみ使用します。

認証されたユーザー名を置き換えるには、URL（Uniform Resource Locator）の {USER} プレースホルダーを使用します。クエリは、ホスト名で指定されたホストに関連しています。このクエリの形式は RFC 4515 と RFC 4516 に従います。

bindPassword
必須
string

MongoDB Cloud が bindUsername を認証する際に使うパスワード。

bindUsername
必須
string^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:...

MongoDB Cloud が LDAP ホストへの接続に使用する LDAP（Lightweight Directory Access Protocol）ユーザーの完全な DN（Distinguished Name、識別名）。LDAP 識別名の形式は RFC 2253 に従う必要があります。

RFC 2253
caCertificate
string

MongoDB Cloud が LDAP（Lightweight Directory Access Protocol）ホストの ID を確認するために使用する CA（Certificate Authority、認証局）証明書。MongoDB Cloudは自己署名証明書を許可しています。割り当てられた値を削除するには、"caCertificate": "" のように空の文字列を渡します。

Hostname
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:)...

LDAP（Lightweight Directory Access Protocol）ホストのホスト名または IP（Internet Protocol）アドレスを識別する、人間が判読可能なラベル。このホストは、インターネットにアクセスできるか、クラスターへの VPC（Virtual Private Cloud、仮想プライベートクラウド）ピアリング接続が必要です。

ポート
必須
integer <int32>
デフォルト: 636

LDAP（Lightweight Directory Access Protocol）ホストがクライアント接続をリッスンする IANA ポート。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "authzQueryTemplate": "{USER}?memberOf?base",
  • "bindPassword": "string",
  • "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
  • "caCertificate": "string",
  • "hostname": "string",
  • "port": 636
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "request": {
    },
  • "requestId": "32b6e34b3d91647abb20e7b8",
  • "status": "FAIL",
  • "validations": [
    ]
}

1 つの LDAP 構成リクエストの確認のステータスを返す

指定されたプロジェクトの 1 つの LDAP 設定を確認する 1 つの要求のステータスを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

requestId
必須
string = 24文字 ^([a-f0-9]{24})$

LDAP 設定を検証するためのリクエストを識別するユニークな文字列。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "request": {
    },
  • "requestId": "32b6e34b3d91647abb20e7b8",
  • "status": "FAIL",
  • "validations": [
    ]
}

レガシーバックアップ

レガシーバックアップ スナップショット、復元ジョブ、スケジュール、チェックポイントを管理します。

すべてのレガシーバックアップ チェックポイントを返却（非推奨）

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

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つ返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

checkpointId
必須
string = 24文字 ^([a-f0-9]{24})$

チェックポイントを識別するユニークな 24 桁の 16 進数文字列。

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "completed": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "parts": [
    ],
  • "restorable": true,
  • "started": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"
}

すべてのレガシーバックアップ復元ジョブを返却（非推奨）

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

2020 年 3 月 23 日以降、すべての新しいクラスターが使用できるのはクラウドバックアップのみです。4.2 にアップグレードすると、バックアップ システムが現在レガシーバックアップに設定されている場合、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップ スナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップ ポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタム バックアップ ポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。BATCH-ID クエリ パラメーターを使用すると、指定されたバッチ内のすべての復元ジョブを検索できます。シャーディングされたクラスターの復元ジョブを作成する場合、MongoDB Cloud はシャードごとに個別のジョブを作成し、さらにコンフィギュレーションサーバー用に別のジョブを作成します。これらの各ジョブはバッチの一部です。ただし、バッチにはレプリカセットの復元ジョブを含めることはできません。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 形式にするかどうかを示すフラグ。

batchId
string = 24文字 ^([a-f0-9]{24})$

返却対象の復元ジョブのバッチを識別するユニークな 24 桁の 16 進数文字列。ISO 8601の日付と時刻形式のタイムスタンプ（UTC）で、シャーディングされたクラスターの復元ジョブを作成する場合、アプリケーションはシャードごとに個別のジョブを作成し、さらにコンフィギュレーション ホスト用に別のジョブを作成します。これらの各ジョブは 1 つのバッチを構成します。レプリカセットの復元ジョブをバッチの一部にすることはできません。

応答

応答サンプル

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

レガシーバックアップ復元ジョブを 1 つ作成する(非推奨)

指定されたプロジェクト内の 1 つのクラスターのレガシーバックアップを 1 件復元します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。2020 年 3 月 23 日以降、すべての新しいクラスターが使用できるのはクラウドバックアップのみです。4.2 にアップグレードすると、バックアップ システムが現在レガシーバックアップに設定されている場合、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップ スナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップ ポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタム バックアップ ポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。このエンドポイントは、シャーディングされたクラスターのチェックポイント復元ジョブの作成、またはクエリ可能なバックアップスナップショットの復元ジョブの作成をサポートしていません。リクエスト本文にdelivery.methodNameまたはAUTOMATED_RESTOREを指定して自動復元ジョブを作成すると、MongoDB Cloud により、復元前にターゲット クラスター上の既存のデータがすべて削除されます。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つのクラスターに復元するレガシー バックアップ。

checkpointId
string = 24文字 ^([a-f0-9]{24})$

シャーディングされたクラスターのチェックポイントを識別する、ユニークな 24 桁の 16 進数文字列。チェックポイントは、データを復元する点を表します。このパラメーターは "delivery.methodName" : "AUTOMATED_RESTORE" の場合に適用されます。このパラメーターはシャーディングされたクラスターでのみ使用してください。

  • checkpointId を設定した場合、oplogInc、oplogTs、snapshotId、pointInTimeUTCMillis は設定できません。
  • このパラメータを指定すると、このエンドポイントは、このチェックポイントまでのすべてのデータを、delivery オブジェクトで指定したデータベースに復元します。
必須
オブジェクト （スナップショット配信メタデータの復元）

復元されたスナップショットデータの配信方法を示す方法と詳細。

oplogInc
integer <int32> >= 1

特定の秒内の操作を表す 32 ビットの増分序数。oplogTs と組み合わせると、MongoDB Cloud がデータをリストアする時点を表します。このパラメータは、 "delivery.methodName" : "AUTOMATED_RESTORE"の場合に適用されます。

  • oplogInc を設定する場合は、 oplogTs を設定する必要があります。このとき、checkpointId 、 snapshotId 、または pointInTimeUTCMillis を設定することはできません。
  • このパラメータを指定すると、このエンドポイントは、Oplog のタイムスタンプで指定された時刻までのすべてのデータを、delivery オブジェクトで指定したデータベースに復元します。
oplogTs
string^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9...

このスナップショットを復元する日時。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。これは Oplog タイムスタンプの最初の部分を表します。oplogInc と組み合わせると、データを復元する最後のデータベース操作を表します。このパラメータは、 "delivery.methodName" : "AUTOMATED_RESTORE" 場合に適用されます。レプリカセットの local.oplog.rs に対してクエリを実行し、目的のタイムスタンプを見つけます。

  • oplogTs を設定する場合は、oplogInc を設定する必要があります。このとき、checkpointId 、 snapshotId 、または pointInTimeUTCMillis を設定することはできません。
  • このパラメータを指定すると、このエンドポイントは、Oplog のタイムスタンプで指定された時刻までのすべてのデータを、delivery オブジェクトで指定したデータベースに復元します。
pointInTimeUTCMillis
integer <int64> >= 1199145600000

このスナップショットを復元するタイムスタンプ。このパラメーターは、UNIXエポックからの経過ミリ秒で値を表します。このタイムスタンプは、現在の時刻から 24 時間以内である必要があります。このパラメータは、"delivery.methodName" : "AUTOMATED_RESTORE"の場合に適用されます。

  • このパラメータを指定すると、このエンドポイントはその時点までのすべてのデータを、delivery オブジェクトで指定したデータベースに復元します。
  • pointInTimeUTCMillis を設定した場合、oplogInc、oplogTs、snapshotId、checkpointId は設定できません。
snapshotId
string = 24文字 ^([a-f0-9]{24})$

復元するスナップショットを識別するユニークな 24 桁の 16 進数文字列。snapshotId を設定した場合、oplogInc、oplogTs、pointInTimeUTCMillis、checkpointId は設定できません。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "checkpointId": "32b6e34b3d91647abb20e7b8",
  • "delivery": {
    },
  • "oplogInc": 1,
  • "oplogTs": "string",
  • "pointInTimeUTCMillis": 1199145600000,
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

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

1 つのレガシー バックアップ復元ジョブを返却（非推奨）

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

2020 年 3 月 23 日以降、すべての新しいクラスターが使用できるのはクラウドバックアップのみです。4.2 にアップグレードすると、バックアップ システムが現在レガシーバックアップに設定されている場合、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップ スナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップ ポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタム バックアップ ポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

返却対象のスナップショットを持つクラスターを識別する、人間が判読可能なラベル。

jobId
必須
string = 24文字 ^([a-f0-9]{24})$

復元ジョブを識別するユニークな 24 桁の 16 進数文字列。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "batchId": "32b6e34b3d91647abb20e7b8",
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "delivery": {
    },
  • "encryptionEnabled": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hashes": [],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "statusName": "IN_PROGRESS",
  • "timestamp": {
    }
}

1 つのスナップショット スケジュールを返却（非推奨）

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

2020 年 3 月 23 日以降、すべての新しいクラスターが使用できるのはクラウドバックアップのみです。4.2 にアップグレードすると、バックアップ システムが現在レガシーバックアップに設定されている場合、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップ スナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップ ポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタム バックアップ ポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

1 つのクラスターのスナップショット スケジュールを更新（非推奨）

指定されたプロジェクト内の 1 つのクラスターのスナップショット スケジュールを更新します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

2020 年 3 月 23 日以降、すべての新しいクラスターが使用できるのはクラウドバックアップのみです。4.2 にアップグレードすると、バックアップ システムが現在レガシーバックアップに設定されている場合、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップ スナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップ ポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタム バックアップ ポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つのクラスターのスナップショット スケジュールを更新します。

clusterCheckpointIntervalMin
必須
integer <int32>
列挙: 15 30 60

連続するクラスター チェックポイント間の時間量を分単位で表します。このパラメーターはシャーディングされたクラスターにのみ適用されます。この数値により、シャーディングされたクラスターの継続的なクラウド バックアップの粒度が決まります。

clusterId
必須
string = 24文字 ^([a-f0-9]{24})$

返却対象のスナップショットを持つクラスターを識別するユニークな 24 桁の 16 進数文字列。

dailySnapshotRetentionDays
必須
integer <int32>
列挙: 0 3 4 5 6 7 15 30 60 90 120 180 360

日次スナップショットを保持する時間。MongoDB Cloud では、この値は日数で表されます。日次スナップショットの保持を無効にするには、この値を 0 に設定します。

monthlySnapshotRetentionMonths
必須
integer <int32>
列挙: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 18 24 36

MongoDB Cloud が月次スナップショットを保持する必要がある月数。月次スナップショットの保持を無効にするには、この値を 0 に設定します。

pointInTimeWindowHours
必須
integer <int32>

MongoDB Cloud が継続的なクラウド バックアップ スナップショットを作成できる、現在の時刻より前の時間数。

snapshotIntervalHours
必須
integer <int32>
列挙: 6 8 12 24

次のスナップショットを取得するまでに経過する必要がある時間数。

snapshotRetentionDays
必須
integer <int32>
列挙: 2 3 4 5

MongoDB Cloud が最新のスナップショットを保持する必要がある日数。

weeklySnapshotRetentionWeeks
必須
integer <int32>
列挙: 0 1 2 3 4 5 6 7 8 12 16 20 24 52

MongoDB Cloud が週次スナップショットを保持する必要がある週数。週次スナップショットの保持を無効にするには、この値を 0 に設定します。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

すべてのレガシーバックアップ スナップショットを返却（非推奨）

指定されたプロジェクト内の 1 つのクラスターのレガシーバックアップ スナップショットをすべて返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。2020 年 3 月 23 日以降、すべての新しいクラスターが使用できるのはクラウドバックアップのみです。4.2 にアップグレードすると、バックアップ システムが現在レガシーバックアップに設定されている場合、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップ スナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップ ポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタム バックアップ ポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 形式にするかどうかを示すフラグ。

completed
string
デフォルト: "true"
列挙: "all" "true" "false"

完了したスナップショットのみ、不完全なスナップショット、またはすべてのスナップショットのいずれを返すかを指定する、人間が判読可能なラベル。デフォルトでは、MongoDB Cloud は完了したスナップショットのみを返します。

応答

応答サンプル

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

1 つのレガシーバックアップ スナップショットを削除（非推奨）

指定されたプロジェクト内の 1 つのクラスターのレガシーバックアップ スナップショットを 1 つ削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。2020 年 3 月 23 日以降、すべての新しいクラスターが使用できるのはクラウドバックアップのみです。4.2 にアップグレードすると、バックアップ システムが現在レガシーバックアップに設定されている場合、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップ スナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップ ポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタム バックアップ ポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

snapshotId
必須
string = 24文字 ^([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 キーにプロジェクトの読み取り専用ロールが必要です。2020 年 3 月 23 日以降、すべての新しいクラスターが使用できるのはクラウドバックアップのみです。4.2 にアップグレードすると、バックアップ システムが現在レガシーバックアップに設定されている場合、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップ スナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップ ポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタム バックアップ ポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

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

目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "complete": true,
  • "created": {
    },
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "incremental": true,
  • "lastOplogAppliedTimestamp": {
    },
  • "links": [],
  • "parts": [
    ]
}

レガシーバックアップ スナップショットの有効期限を変更（非推奨）

指定されたプロジェクト内の 1 つのクラスターの 1 つのレガシーバックアップ スナップショットの有効期限を変更します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。2020 年 3 月 23 日以降、すべての新しいクラスターが使用できるのはクラウドバックアップのみです。4.2 にアップグレードすると、バックアップ システムが現在レガシーバックアップに設定されている場合、クラウドバックアップにアップグレードされます。このアップグレード後も、既存のレガシーバックアップ スナップショットはすべて引き続き利用できますが、保持ポリシーに従い、時間の経過とともに期限が切れます。バックアップ ポリシーがデフォルトのスケジュールにリセットされます。レガシーバックアップでカスタム バックアップ ポリシーを設定していた場合は、クラウドバックアップに関するドキュメントに記載されている手順に従ってポリシーを再作成する必要があります。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

snapshotId
必須
string = 24文字 ^([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 つのレガシーバックアップ スナップショットの有効期限を変更します。

doNotDelete
ブール値

このスナップショットを削除できるかどうかを示すフラグ。同じリクエスト内で "doNotDelete" : true を設定して有効期限のタイムスタンプを設定することはできません。

expires
string <date-time>

MongoDB Cloud がスナップショットを削除する日時。"doNotDelete" : true の場合、MongoDB Cloud はこのパラメーターに設定された値をすべて削除します。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "complete": true,
  • "created": {
    },
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "incremental": true,
  • "lastOplogAppliedTimestamp": {
    },
  • "links": [],
  • "parts": [
    ]
}

メンテナンスウィンドウ

メンテナンスウィンドウを返却、編集、削除します。MongoDB Cloud が実行するメンテナンス手順では、レプリカセットごとに、メンテナンスウィンドウ中に少なくとも 1 回のレプリカセット選挙が必要です。スケジュールされたプロジェクトのメンテナンス イベントは最大 2 回まで延期できます。延期されたメンテナンス イベントは、事前にスケジュールされた日時からちょうど 1 週間後の、希望するメンテナンスウィンドウ中に発生します。

1 つのプロジェクトの 1 つのメンテナンスウィンドウをリセット

指定されたプロジェクトのメンテナンスウィンドウをリセットします。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。セキュリティパッチのような至急の整備アクティビティは、選択したウィンドウを待つことはできません。MongoDB Cloud は必要に応じてこれらのメンテナンス アクティビティを開始します。クラスターのメンテナンスをスケジュールした後は、現在のメンテナンス作業が完了するまでメンテナンスウィンドウを変更できません。MongoDB Cloud が実行するメンテナンス手順では、レプリカセットごとに、メンテナンスウィンドウ中に少なくとも 1 回のレプリカセット選挙が必要です。メンテナンスは常に可能な限り予定時刻に近い時間に開始されますが、進行中のクラスターアップデートや予期しないシステム問題により、開始時間が遅れる可能性があります。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

クエリ パラメータ
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 つのメンテナンスウィンドウを返す

指定されたプロジェクトのメンテナンスウィンドウを返します。MongoDB Cloud は必要に応じてこれらのメンテナンス アクティビティを開始します。現在のメンテナンス作業が完了するまで、メンテナンスウィンドウを変更することはできません。MongoDB Cloud が実行するメンテナンス手順では、レプリカセットごとに、メンテナンスウィンドウ中に少なくとも 1 回のレプリカセット選挙が必要です。メンテナンスは常に可能な限り予定時刻に近い時間に開始されますが、進行中のクラスターアップデートや予期しないシステム問題により、開始時間が遅れる可能性があります。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
{
  • "autoDeferOnceEnabled": true,
  • "dayOfWeek": 1,
  • "hourOfDay": 23,
  • "numberOfDeferrals": 0,
  • "startASAP": true
}

1 つのプロジェクトのメンテナンスウィンドウを更新

指定されたプロジェクトのメンテナンスウィンドウを更新します。セキュリティパッチのような至急の整備アクティビティは、選択したウィンドウを待つことはできません。MongoDB Cloud は必要に応じてこれらのメンテナンス アクティビティを開始します。クラスターのメンテナンスをスケジュールした後は、現在のメンテナンス作業が完了するまでメンテナンスウィンドウを変更できません。MongoDB Cloud が実行するメンテナンス手順では、レプリカセットごとに、メンテナンスウィンドウ中に少なくとも 1 回のレプリカセット選挙が必要です。メンテナンスは常に可能な限り予定時刻に近い時間に開始されますが、進行中のクラスターアップデートや予期しないシステム問題により、開始時間が遅れる可能性があります。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

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

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

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

指定されたプロジェクトのメンテナンスウィンドウを更新します。

autoDeferOnceEnabled
ブール値

MongoDB クラウドがすべてのメンテナンスウィンドウを有効にしてから 1 週間延期するかどうかを示すフラグ。

dayOfWeek
必須
integer <int32> [ 1 .. 7 ]

メンテナンスウィンドが開始される曜日を表す 1 から始まる整数。

値 Day of Week
1 Sunday
2 Monday
3 Tuesday
4 Wednesday
5 Thursday
6 Friday
7 Saturday
hourOfDay
integer <int32> [ 0 .. 23 ]

メンテナンス ウィンドウが開始される時刻を 24 時間制で表す 0 から始まる整数。真夜中には 0、正午には 12 を使用します。

startASAP
ブール値

MongoDB Cloud がこのリクエストを受信するとすぐにメンテナンスウィンドウを開始するかどうかを示すフラグ。プロジェクトのメンテナンスウィンドウをすぐに開始するには、MongoDB Cloud でメンテナンスがスケジュールされており、メンテナンスウィンドウが設定されている必要があります。MongoDB Cloud のメンテナンスが完了すると、このフラグは false にリセットされます。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "autoDeferOnceEnabled": true,
  • "dayOfWeek": 1,
  • "hourOfDay": 23,
  • "startASAP": 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 つのプロジェクトのメンテナンスの自動延期を切り替える

指定されたプロジェクトのメンテナンスウィンドウの自動延期を切り替えます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

クエリ パラメータ
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 つのメンテナンスウィンドウを延期

指定されたプロジェクトのメンテナンスウィンドウを延期します。セキュリティパッチのような至急の整備アクティビティは、選択したウィンドウを待つことはできません。MongoDB Cloud は必要に応じてこれらのメンテナンス アクティビティを開始します。クラスターのメンテナンスをスケジュールした後は、現在のメンテナンス作業が完了するまでメンテナンスウィンドウを変更できません。MongoDB Cloud が実行するメンテナンス手順では、レプリカセットごとに、メンテナンスウィンドウ中に少なくとも 1 回のレプリカセット選挙が必要です。メンテナンスは常に可能な限り予定時刻に近い時間に開始されますが、進行中のクラスターアップデートや予期しないシステム問題により、開始時間が遅れる可能性があります。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

クエリ パラメータ
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"
}

MongoDB Cloud ユーザー

MongoDB Cloud ユーザーを返却、追加、編集します。

1 人のMongoDB クラウド ユーザーを作成

MongoDB Cloud ユーザー アカウントを 1 つ作成します。MongoDB Cloud ユーザー アカウントは、MongoDB Cloud アプリケーションへのアクセスのみを許可します。データベースへのアクセスを許可するには、データベースユーザーを作成します。MongoDB Cloud は、指定されたユーザーにプロジェクトへの参加を招待するメールを送信します。招待されたユーザーは、招待を承諾するまでプロジェクトにアクセスできません。招待は 30 日後に期限切れになります。

MongoDB Cloud は、MongoDB Cloud ユーザーメンバーシップをチームあたり最大 250 人の MongoDB Cloud ユーザーに制限しています。MongoDB Cloud は、MongoDB Cloud ユーザーメンバーシップをプロジェクトあたり 500 人、組織あたり 500 人の MongoDB Cloud ユーザーに制限しており、これには組織内のすべてのプロジェクトの合計メンバーシップが含まれます。MongoDB Cloud では、操作がこれらの制限を超えるとエラーが発生します。たとえば、組織に 5 つのプロジェクトがあり、各プロジェクトに 100 人の MongoDB Cloud ユーザーがいて、各 MongoDB Cloud ユーザーが 1 つのプロジェクトにのみ属している場合、この組織に MongoDB Cloud ユーザーを追加することはできません。追加するには、まず既存の MongoDB Cloud ユーザーを組織から削除する必要があります。

このリソースは、リクエスト元の API キーがどのようなロールを持っていても使用できます。

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

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

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

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

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

作成する MongoDB Cloud ユーザー アカウント。

国
必須
string^([A-Z]{2})$

MongoDB クラウドユーザーの地理的位置を示すアルファベット 2 文字。このパラメーターは ISO 3166-1a2 コード形式を使用します。

名
必須
string

MongoDB Cloud ユーザーの名。

姓
必須
string

MongoDB Cloud ユーザーの姓。

mobileNumber
必須
string(?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1...

MongoDB Cloud ユーザーの携帯電話番号。

パスワード
必須
string >= 8 文字

MongoDB Cloud にログインするためにユーザー名に適用されるパスワード。MongoDB Cloud は、新しい MongoDB Cloud ユーザーの作成に応答する場合以外では、このパラメーターを返しません。MongoDB Cloud コンソールから設定したパスワードを更新できるのは MongoDB Cloud ユーザーだけです。

の配列 オブジェクト （ロールの割り当て）

MongoDB Cloud ユーザーのロールと、そのロールが適用される対応する組織またはプロジェクトを表示するオブジェクトのリスト。ロールは 1 つの組織または 1 つのプロジェクトに適用できますが、両方に適用することはできません。

username
必須
string <email>

MongoDB Cloud ユーザーのユーザー名を表すメール アドレス。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "country": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "username": "user@example.com"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailAddress": "user@example.com",
  • "firstName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastAuth": "2019-08-24T14:15:22Z",
  • "lastName": "string",
  • "links": [],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

ユーザー名を使用して 1 人の MongoDB クラウド ユーザーを返す

指定されたユーザー名を持つ 1 つの MongoDB Cloud ユーザー アカウントの詳細を返します。このエンドポイントを使用して API キーに関する情報を返すことはできません。API キーに関する情報を返すには、1 つの組織を返す API キー エンドポイントを使用します。このリソースは、リクエスト元の API キーがどのようなロールを持っていても使用できます。

認可:
DigestAuthServiceAccounts
path パラメータ
userName
必須
string^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%...

MongoDB Cloud ユーザー アカウントのメール アドレス。ユーザーを作成した後に、このアドレスを変更することはできません。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailAddress": "user@example.com",
  • "firstName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastAuth": "2019-08-24T14:15:22Z",
  • "lastName": "string",
  • "links": [],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

ID を使用して 1 人の MongoDB クラウド ユーザーを返す

指定されたユーザーのユニークな識別子を持つ 1 つの MongoDB Cloud ユーザー アカウントの詳細を返します。このエンドポイントを使用して API キーに関する情報を返すことはできません。API キーに関する情報を返すには、1 つの組織を返す API キー エンドポイントを使用します。自分のユーザー アカウントはいつでも検索できます。MongoDB Cloud 組織またはプロジェクトのオーナーであれば、その組織またはプロジェクトのメンバーシップを持つ全ユーザーのユーザー プロファイルも検索できます。このリソースは、リクエスト元の API キーがどのようなロールを持っていても使用できます。

認可:
DigestAuthServiceAccounts
path パラメータ
userId
必須
string = 24文字 ^([a-f0-9]{24})$

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailAddress": "user@example.com",
  • "firstName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastAuth": "2019-08-24T14:15:22Z",
  • "lastName": "string",
  • "links": [],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

モニタリングとログ

データベース配置のモニタリングとロギングのデータを返します。

1 つのプロジェクトの 1 つのクラスター ホストのログをダウンロード

指定されたプロジェクトの指定されたホストのログメッセージの範囲を含む圧縮（.gz）ログファイルを返します。 MongoDBは 5 分ごとにクラスターバックエンドインフラストラクチャからのプロセス ログと監査するログを更新します。ログは長さが約 5 分のチャンクで保存されますが、この期間は異なる場合があります。ログファイルのAPIをポーリングする場合は、連続するポーリングに重複するログが含まれる可能性があっても、5 分ごとにポーリングすることをお勧めします。この機能は、 M0無料クラスター、 M2 、 M5 、サーバーレス クラスターでは使用できません。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトデータの読み取り専用以上のロールが必要です。 APIは、 JSON 応答スキーマを使用した直接呼び出しをサポートしていません。形式の accept ヘッダーを使用して gzip レスポンススキーマをリクエストする必要があります。"Accept: アプリケーション/vnd.atlas.YYYY-MM-DD+gzip" となります。

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

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

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

hostName
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:)...

ダウンロード対象のログファイルを保存するホストを識別する、人間が判読可能なラベル。

logName
必須
string
列挙: "mongodb" "mongos" "mongodb-audit-log" "mongos-audit-log"

返却対象のログファイルを識別する、人間が判読できるラベル。監査ログを返すには、指定されたプロジェクトのデータベース監査を有効にします。

データベース監査の設定
クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

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

endDate
integer <int64> >= 1199145600

検索するログメッセージの範囲の終了点の日時を、UNIX エポックからの経過秒数で指定します。この値は、開始日からデフォルトで 24 時間後に設定されます。開始日も指定されていない場合、値はデフォルトでリクエストの時刻になります。

startDate
integer <int64> >= 1199145600

取得するログメッセージの範囲の開始点の日時を、UNIX エポックからの経過秒数で指定します。この値は、デフォルトでは終了日の 24 時間前に設定されます。終了日も指定されていない場合、値はデフォルトでリクエストの時刻の 24 時間前になります。

応答

応答サンプル

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

1 つのプロセスのすべての Atlas Search メトリクス タイプを返す

指定されたプロジェクト内の 1 つのプロセスで使用可能なすべての Atlas Search メトリクス タイプを返します。Atlas Search メトリクス タイプを参照するには、プロジェクト読み取り専用以上のロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: my.host.name.com:27017

MongoDB プロセスを提供するホスト名と IANA ポートの組み合わせ。ホストは MongoDB プロセス（mongod あるいは mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 あるいは IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hardwareMetrics": [
    ],
  • "indexMetrics": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "statusMetrics": [
    ]
}

1 つの名前空間のすべての Atlas Search インデックス メトリクスを返す

指定されたプロセス内の 1 つの名前空間について、指定された時間範囲内の Atlas Search インデックス メトリクスを返します。

認可:
DigestAuthServiceAccounts
path パラメータ
processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: my.host.name.com:27017

MongoDB プロセスを提供するホスト名と IANA ポートの組み合わせ。ホストは MongoDB プロセス（mongod あるいは mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 あるいは IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

databaseName
必須
string
例: mydb

データベースを識別する、人間が判読可能なラベル。

コレクション名
必須
string
例: mycoll

コレクションを識別する、人間が判読可能なラベル。

グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

クエリ パラメータ
粒度
必須
string
例: granularity=PT1M

Atlas がメトリクスをレポートする間隔を指定する期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。

period
string
例: period=PT10H

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

始める
string <date-time>

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

end
string <date-time>

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

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

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

メトリクス
必須
の配列 string <= 10 アイテム unique
アイテム列挙: "INDEX_SIZE_ON_DISK" "NUMBER_OF_DELETES" "NUMBER_OF_ERROR_QUERIES" "NUMBER_OF_GETMORE_COMMANDS" "NUMBER_OF_INDEX_FIELDS" "NUMBER_OF_INSERTS" "NUMBER_OF_SUCCESS_QUERIES" "NUMBER_OF_UPDATES" "REPLICATION_LAG" "TOTAL_NUMBER_OF_QUERIES"

関連付けられたデータ系列について MongoDB Atlas がレポートする測定値を格納したリスト。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "indexIds": [
    ],
  • "indexStatsMeasurements": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

1 つの指定された名前空間の 1 つのインデックスの Atlas Search メトリクスを返す

指定されたプロセス上の 1 つの名前空間とインデックス名について、指定された時間範囲内の Atlas Search メトリクス データ系列を返します。Atlas Search メトリクス タイプを参照するには、プロジェクト読み取り専用以上のロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: my.host.name.com:27017

MongoDB プロセスを提供するホスト名と IANA ポートの組み合わせ。ホストは MongoDB プロセス（mongod あるいは mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 あるいは IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

indexName
必須
string
例: myindex

インデックスを識別する、人間が判読可能なラベル。

databaseName
必須
string
例: mydb

データベースを識別する、人間が判読可能なラベル。

コレクション名
必須
string
例: mycoll

コレクションを識別する、人間が判読可能なラベル。

グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

クエリ パラメータ
粒度
必須
string
例: granularity=PT1M

Atlas がメトリクスをレポートする間隔を指定する期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。

period
string
例: period=PT10H

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

始める
string <date-time>

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

end
string <date-time>

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

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

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

メトリクス
必須
の配列 string <= 10 アイテム unique
アイテム列挙: "INDEX_SIZE_ON_DISK" "NUMBER_OF_DELETES" "NUMBER_OF_ERROR_QUERIES" "NUMBER_OF_GETMORE_COMMANDS" "NUMBER_OF_INDEX_FIELDS" "NUMBER_OF_INSERTS" "NUMBER_OF_SUCCESS_QUERIES" "NUMBER_OF_UPDATES" "REPLICATION_LAG" "TOTAL_NUMBER_OF_QUERIES"

関連付けられたデータ系列について MongoDB Atlas がレポートする測定値を格納したリスト。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "indexIds": [
    ],
  • "indexStatsMeasurements": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

Atlas Search ハードウェアとステータス メトリクスを返す

指定されたプロジェクトの 1 つのプロセスについて、指定された時間範囲内の Atlas Search ハードウェアとステータスのデータ系列を返します。Atlas Search メトリクス タイプを参照するには、プロジェクト読み取り専用以上のロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: my.host.name.com:27017

MongoDB プロセスを提供するホスト名と IANA ポートの組み合わせ。ホストは MongoDB プロセス（mongod あるいは mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 あるいは IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

クエリ パラメータ
粒度
必須
string
例: granularity=PT1M

Atlas がメトリクスをレポートする間隔を指定する期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。

period
string
例: period=PT10H

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

始める
string <date-time>

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

end
string <date-time>

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

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

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

メトリクス
必須
の配列 string <= 10 アイテム unique
アイテム列挙: "FTS_DISK_USAGE" "FTS_PROCESS_CPU_KERNEL" "FTS_PROCESS_CPU_USER" "FTS_PROCESS_NORMALIZED_CPU_KERNEL" "FTS_PROCESS_NORMALIZED_CPU_USER" "FTS_PROCESS_RESIDENT_MEMORY" "FTS_PROCESS_SHARED_MEMORY" "FTS_PROCESS_VIRTUAL_MEMORY" "JVM_CURRENT_MEMORY" "JVM_MAX_MEMORY" "PAGE_FAULTS"

関連付けられたデータ系列について MongoDB Atlas でレポートするメトリクスを格納したリスト。このパラメーターを設定しない場合、このリソースは関連するデータシリーズのハードウェアとステータスのメトリクスをすべて返します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hardwareMeasurements": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z",
  • "statusMeasurements": [
    ]
}

1 つのプロジェクトのすべての MongoDB プロセスを返す

指定されたプロジェクトの全プロセスの詳細を返します。MongoDB プロセスは mongod または mongos のいずれかになります。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
}

ID を使用して 1 つの MongoDB プロセスを返す

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

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

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

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

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: mongodb.example.com:27017

MongoDB プロセスを提供するホスト名と IANA（Internet Assigned Numbers Authority、インターネット番号割当機関）ポートの組み合わせ。ホストは、MongoDB プロセス（mongod または mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 または IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "created": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostname": "string",
  • "id": "string",
  • "lastPing": "2019-08-24T14:15:22Z",
  • "links": [],
  • "port": 0,
  • "replicaSetName": "string",
  • "shardName": "string",
  • "typeName": "REPLICA_PRIMARY",
  • "userAlias": "string",
  • "version": "string"
}

1 つの MongoDB プロセスの利用可能なデータベースを返す

指定されたプロジェクトの指定されたホストで実行中のデータベースの一覧を返します。M0 無料クラスター、M2、M5、およびサーバーレス クラスターには、運用上の制限があります。MongoDB Cloud プロセスは mongod である必要があります。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: mongodb.example.com:27017

MongoDB プロセスを提供するホスト名と IANA（Internet Assigned Numbers Authority、インターネット番号割当機関）ポートの組み合わせ。ホストは、MongoDB プロセス（mongod）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 または IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

クエリ パラメータ
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
{}

MongoDB プロセスの 1 つのデータベースを返す

指定されたプロジェクトの指定されたホスト上で実行中の1つのデータベースを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

databaseName
必須
string

指定された MongoDB プロセスが提供するデータベースを識別する、人間が判読可能なラベル。

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: mongodb.example.com:27017

MongoDB プロセスを提供するホスト名と IANA（Internet Assigned Numbers Authority、インターネット番号割当機関）ポートの組み合わせ。ホストは、MongoDB プロセス（mongod または mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 または IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

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

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

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

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

応答

応答サンプル

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

1 つの MongoDB プロセスの 1 つのデータベースに関する測定値を返す

指定されたプロジェクトの指定されたホストの 1 つのデータベースの測定値を返します。MongoDB dbStats コマンド出力に基づいて、データベースのディスク上のストレージ容量を返します。いくつかのメトリクス系列を計算するために、Atlas は隣接する 2 つの点間のレートを使用します。これらのメトリクス系列では、Atlas はクエリの時間範囲を指定して最初のデータ点のレートを計算できないため、最初のデータ点は NULL 値になります。Atlas は 20 分ごとにデータベース メトリクスを検索しますが、データベースのパフォーマンスを最適化するために必要に応じて頻度を減らします。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

databaseName
必須
string

指定された MongoDB プロセスが提供するデータベースを識別する、人間が判読可能なラベル。

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: mongodb.example.com:27017

MongoDB プロセスを提供するホスト名と IANA（Internet Assigned Numbers Authority、インターネット番号割当機関）ポートの組み合わせ。ホストは、MongoDB プロセス（mongod または mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 または IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

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

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

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

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

m
の配列 string [ 1 .. 10 ] アイテム unique
アイテム列挙: "DATABASE_AVERAGE_OBJECT_SIZE" "DATABASE_COLLECTION_COUNT" "DATABASE_DATA_SIZE" "DATABASE_STORAGE_SIZE" "DATABASE_INDEX_SIZE" "DATABASE_INDEX_COUNT" "DATABASE_EXTENT_COUNT" "DATABASE_OBJECT_COUNT" "DATABASE_VIEW_COUNT"

この MongoDB プロセスに要求する 1 つ以上の測定タイプ。省略すると、リソースはすべての測定値を返します。m に複数の値を指定するには、値ごとに m パラメーターを繰り返します。指定されたホストに適用する測定値を指定します。無効な測定値を指定した場合、MongoDB Cloud はエラーを返します。

粒度
必須
string
例: granularity=PT1M

Atlas がメトリクスをレポートする間隔を指定する期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。

period
string
例: period=PT10H

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

始める
string <date-time>

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

end
string <date-time>

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "partitionName": "string",
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

1 つの MongoDB プロセスで利用可能なディスクを返す

指定されたプロジェクトの指定されたホストの、ディスクまたはパーティションのリストを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: mongodb.example.com:27017

MongoDB プロセスを提供するホスト名と IANA（Internet Assigned Numbers Authority、インターネット番号割当機関）ポートの組み合わせ。ホストは、MongoDB プロセス（mongod または mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 または IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

クエリ パラメータ
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 つのディスクの測定値を返す

指定されたプロジェクトの指定されたホストの、1 つのディスクまたはパーティションの測定詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
partitionName
必須
string

測定が適用されるディスクまたはパーティションの、人間が判読可能なラベル。

グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: mongodb.example.com:27017

MongoDB プロセスを提供するホスト名と IANA（Internet Assigned Numbers Authority、インターネット番号割当機関）ポートの組み合わせ。ホストは、MongoDB プロセス（mongod または mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 または IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

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

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

応答

応答サンプル

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

1 つの MongoDB プロセスの 1 つのディスクに関する測定値を返す

指定されたプロジェクトの指定されたホストの、1 つのディスクまたはパーティションの測定値を返します。戻り値は、次のいずれかになります。

  • MongoDB プロセスに使用されるディスク パーティションの I/O 操作のスループット
  • パーティションがリクエストを発行して処理した時間の割合
  • MongoDB プロセスに使用されるディスク パーティションの操作タイプごとのレイテンシ
  • MongoDBプロセスに使用されたディスク パーティション上の空きディスク領域と使用済みディスク領域の量

このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

partitionName
必須
string

測定が適用されるディスクまたはパーティションの、人間が判読可能なラベル。

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: mongodb.example.com:27017

MongoDB プロセスを提供するホスト名と IANA（Internet Assigned Numbers Authority、インターネット番号割当機関）ポートの組み合わせ。ホストは、MongoDB プロセス（mongod または mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 または IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

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

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

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

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

m
の配列 string [ 1 .. 10 ] アイテム unique
アイテム列挙: "DISK_PARTITION_IOPS_READ" "MAX_DISK_PARTITION_IOPS_READ" "DISK_PARTITION_IOPS_WRITE" "MAX_DISK_PARTITION_IOPS_WRITE" "DISK_PARTITION_IOPS_TOTAL" "MAX_DISK_PARTITION_IOPS_TOTAL" "DISK_PARTITION_LATENCY_READ" "MAX_DISK_PARTITION_LATENCY_READ" "DISK_PARTITION_LATENCY_WRITE" "MAX_DISK_PARTITION_LATENCY_WRITE" "DISK_PARTITION_SPACE_FREE" "MAX_DISK_PARTITION_SPACE_FREE" "DISK_PARTITION_SPACE_USED" "MAX_DISK_PARTITION_SPACE_USED" "DISK_PARTITION_SPACE_PERCENT_FREE" "MAX_DISK_PARTITION_SPACE_PERCENT_FREE" "DISK_PARTITION_SPACE_PERCENT_USED" "MAX_DISK_PARTITION_SPACE_PERCENT_USED" "DISK_PARTITION_THROU含まれる_READ" "DISK_PARTITION_THROU含まれる_WRITE" "DISK_QUEUE_DEPTH"

この MongoDB プロセスに要求する 1 つ以上の測定タイプ。省略すると、リソースはすべての測定値を返します。m に複数の値を指定するには、値ごとに m パラメーターを繰り返します。指定されたホストに適用する測定値を指定します。無効な測定値を指定した場合、MongoDB Cloud はエラーを返します。

period
string
例: period=PT10H

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

粒度
必須
string
例: granularity=PT1M

Atlas がメトリクスをレポートする間隔を指定する期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。

始める
string <date-time>

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

end
string <date-time>

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "partitionName": "string",
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

1 つの MongoDB プロセスに関する測定値を返す

指定されたプロジェクトの指定されたホストの、プロセスごとのディスク、パーティション、またはホストの測定値を返します。戻り値は、次のいずれかになります。

  • MongoDB プロセスに使用されるディスク パーティションの I/O 操作のスループット
  • パーティションがリクエストを発行して処理した時間の割合
  • MongoDB プロセスに使用されるディスク パーティションの操作タイプごとのレイテンシ
  • MongoDBプロセスに使用されたディスク パーティション上の空きディスク領域と使用済みディスク領域の量
  • CPU 使用率や I/O 操作回数などのホストの測定値

このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
例: mongodb.example.com:27017

MongoDB プロセスを提供するホスト名と IANA（Internet Assigned Numbers Authority、インターネット番号割当機関）ポートの組み合わせ。ホストは、MongoDB プロセス（mongod または mongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 または IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

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

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

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

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

m
の配列 string [ 1 .. 10 ] アイテム unique
アイテム列挙: "ASSERT_MSG" "ASSERT_REGULAR" "ASSERT_USER" "ASSERT_WARNING" "BACKGROUND_FLUSH_AVG" "CACHE_BYTES_READ_INTO" "CACHE_BYTES_WRITTEN_FROM" "CACHE_DIRTY_BYTES" "CACHE_USED_BYTES" "CACHE_FILL_RATIO" "DIRTY_FILL_RATIO" "COMPUTED_MEMORY" "CONNECTIONS" "CURSORS_TOTAL_OPEN" "CURSORS_TOTAL_TIMED_OUT" "DB_DATA_SIZE_TOTAL" "DB_STORAGE_TOTAL" "DOCUMENT_METRICS_DELETED" "DOCUMENT_METRICS_INSERTED" "DOCUMENT_METRICS_RETURNED" "DOCUMENT_METRICS_UPDATED" "EXTRA_INFO_PAGE_FAULTS" "FTS_DISK_UTILIZATION" "FTS_MEMORY_MAPPED" "FTS_MEMORY_RESIDENT" "FTS_MEMORY_VIRTUAL" "FTS_PROCESS_CPU_KERNEL" "FTS_PROCESS_CPU_USER" "FTS_PROCESS_NORMALIZED_CPU_KERNEL" "FTS_PROCESS_NORMALIZED_CPU_USER" "GLOBAL_ACCESSES_NOT_IN_MEMORY" "GLOBAL_LOCK_CURRENT_QUEUE_READERS" "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" "INDEX_COUNTERS_BTREE_ACCESSES" "INDEX_COUNTERS_BTREE_HITS" "INDEX_COUNTERS_BTREE_MISS_RATIO" "INDEX_COUNTERS_BTREE_MISSES" "JOURNALING_COMMITS_IN_WRITE_LOCK" "JOURNALING_MB" "JOURNALING_WRITE_DATA_FILES_MB" "MAX_PROCESS_CPU_CHILDREN_KERNEL" "MAX_PROCESS_CPU_CHILDREN_USER" "MAX_PROCESS_CPU_KERNEL" "MAX_PROCESS_CPU_USER" "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL" "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER" "MAX_PROCESS_NORMALIZED_CPU_KERNEL" "MAX_PROCESS_NORMALIZED_CPU_USER" "MAX_SWAP_USAGE_FREE" "MAX_SWAP_USAGE_USED " "MAX_SYSTEM_CPU_GUEST" "MAX_SYSTEM_CPU_IOWAIT" "MAX_SYSTEM_CPU_IRQ" "MAX_SYSTEM_CPU_KERNEL" "MAX_SYSTEM_CPU_SOFTIRQ" "MAX_SYSTEM_CPU_STEAL" "MAX_SYSTEM_CPU_USER" "MAX_SYSTEM_MEMORY_AVAILABLE" "MAX_SYSTEM_MEMORY_FREE" "MAX_SYSTEM_MEMORY_USED" "MAX_SYSTEM_NETWORK_IN" "MAX_SYSTEM_NETWORK_OUT" "MAX_SYSTEM_NORMALIZED_CPU_GUEST" "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT" "MAX_SYSTEM_NORMALIZED_CPU_IRQ" "MAX_SYSTEM_NORMALIZED_CPU_KERNEL" "MAX_SYSTEM_NORMALIZED_CPU_NICE" "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ" "MAX_SYSTEM_NORMALIZED_CPU_STEAL" "MAX_SYSTEM_NORMALIZED_CPU_USER" "MEMORY_MAPPED" "MEMORY_RESIDENT" "MEMORY_VIRTUAL" "NETWORK_BYTES_IN" "NETWORK_BYTES_OUT" "NETWORK_NUM_REQUESTS" "OP_EXECUTION_TIME_COMMANDS" "OP_EXECUTION_TIME_READS" "OP_EXECUTION_TIME_WRITES" "OPCOUNTER_CMD" "OPCOUNTER_DELETE" "OPCOUNTER_TTL_DELETED" "OPCOUNTER_GETMORE" "OPCOUNTER_INSERT" "OPCOUNTER_QUERY" "OPCOUNTER_REPL_CMD" "OPCOUNTER_REPL_DELETE" "OPCOUNTER_REPL_INSERT" "OPCOUNTER_REPL_UPDATE" "OPCOUNTER_UPDATE" "OPERATIONS_SCAN_AND_ORDER" "OPERATIONS_QUERIES_KILLED" "OPLOG_MASTER_LAG_TIME_DIFF" "OPLOG_MASTER_TIME" "OPLOG_RATE_GB_PER_HOUR" "OPLOG_SLAVE_LAG_MASTER_TIME" "OPLOG_REPLICATION_LAG" "PROCESS_CPU_CHILDREN_KERNEL" "PROCESS_CPU_CHILDREN_USER" "PROCESS_CPU_KERNEL" "PROCESS_CPU_USER" "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL" "PROCESS_NORMALIZED_CPU_CHILDREN_USER" "PROCESS_NORMALIZED_CPU_KERNEL" "PROCESS_NORMALIZED_CPU_USER" "QUERY_EXECUTOR_SCANNED" "QUERY_EXECUTOR_SCANNED_OBJECTS" "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" "QUERY_TARGETING_SCANNED_PER_RETURNED" "RESTARTS_IN_LAST_HOUR" "SWAP_USAGE_FREE" "SWAP_USAGE_USED" "SYSTEM_CPU_GUEST" "SYSTEM_CPU_IOWAIT" "SYSTEM_CPU_IRQ" "SYSTEM_CPU_KERNEL" "SYSTEM_CPU_NICE" "SYSTEM_CPU_SOFTIRQ" "SYSTEM_CPU_STEAL" "SYSTEM_CPU_USER" "SYSTEM_MEMORY_AVAILABLE" "SYSTEM_MEMORY_FREE" "SYSTEM_MEMORY_USED" "SYSTEM_NETWORK_IN" "SYSTEM_NETWORK_OUT" "SYSTEM_NORMALIZED_CPU_GUEST" "SYSTEM_NORMALIZED_CPU_IOWAIT" "SYSTEM_NORMALIZED_CPU_IRQ" "SYSTEM_NORMALIZED_CPU_KERNEL" "SYSTEM_NORMALIZED_CPU_NICE" "SYSTEM_NORMALIZED_CPU_SOFTIRQ" "SYSTEM_NORMALIZED_CPU_STEAL" "SYSTEM_NORMALIZED_CPU_USER" "TICKETS_AVAILABLE_READS" "TICKETS_AVAILABLE_WRITE" "OPERATION_THRAtTLING_REJECTED_OPERATIONS"

この MongoDB プロセスに要求する 1 つ以上の測定タイプ。省略すると、リソースはすべての測定値を返します。m に複数の値を指定するには、値ごとに m パラメーターを繰り返します。指定されたホストに適用する測定値を指定します。無効な測定値を指定した場合、MongoDB Cloud はエラーを返します。

period
string
例: period=PT10H

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

粒度
必須
string
例: granularity=PT1M

Atlas がメトリクスをレポートする間隔を指定する期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。

始める
string <date-time>

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

end
string <date-time>

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "partitionName": "string",
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

1 つのプロジェクトの 1 つのクラスター ホストのログをダウンロード

指定されたプロジェクトの指定されたホストのログメッセージの範囲を含む圧縮（.gz）ログファイルを返します。 MongoDBは 5 分ごとにクラスターバックエンドインフラストラクチャからのプロセス ログと監査するログを更新します。ログは長さが約 5 分のチャンクで保存されますが、この期間は異なる場合があります。ログファイルのAPIをポーリングする場合は、連続するポーリングに重複するログが含まれる可能性があっても、5 分ごとにポーリングすることをお勧めします。この機能は、 M0無料クラスター、 M2 、 M5 、サーバーレス クラスターでは使用できません。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトデータの読み取り専用以上のロールが必要です。 APIは、 JSON 応答スキーマを使用した直接呼び出しをサポートしていません。形式の accept ヘッダーを使用して gzip レスポンススキーマをリクエストする必要があります。"Accept: アプリケーション/vnd.atlas.YYYY-MM-DD+gzip" となります。

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

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

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

hostName
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:)...

ダウンロード対象のログファイルを保存するホストを識別する、人間が判読可能なラベル。

logName
必須
string
列挙: "mongodb" "mongos" "mongodb-audit-log" "mongos-audit-log"

返却対象のログファイルを識別する、人間が判読できるラベル。監査ログを返すには、指定されたプロジェクトのデータベース監査を有効にします。

データベース監査の設定
クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

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

endDate
integer <int64> >= 1199145600

検索するログメッセージの範囲の終了点の日時を、UNIX エポックからの経過秒数で指定します。この値は、開始日からデフォルトで 24 時間後に設定されます。開始日も指定されていない場合、値はデフォルトでリクエストの時刻になります。

startDate
integer <int64> >= 1199145600

取得するログメッセージの範囲の開始点の日時を、UNIX エポックからの経過秒数で指定します。この値は、デフォルトでは終了日の 24 時間前に設定されます。終了日も指定されていない場合、値はデフォルトでリクエストの時刻の 24 時間前になります。

応答

応答サンプル

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

マルチクラウドクラスター

マルチクラウド クラスターを返したり、追加、編集、削除したりします。 クラスター構成の変更はコストに影響を与えます。

リージョンをまたがるクラスターの合計ノード数にはプロジェクトごとに特定の制約があります。 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 つ以上ある場合、プロジェクトにマルチリージョンクラスターを作成することはできません。 各プロジェクトは最大 25 のデータベース配置をサポートします。

MongoDB Cloud プロジェクトに特定の MongoDB バージョンで導入されたアクションを使用する カスタムロール が含まれている場合、当該バージョンより前の MongoDB バージョンを使用するクラスターを作成する前にそのロールを削除する必要があります。 2020 年 7 月以降に作成された MongoDB Cloud クラスターは、デフォルトで TLS バージョン 1.2 を使用します。 ユーザーがクラスターを作成すると、MongoDB Cloud ではクラスターを配置するクラウドプロバイダーのプロジェクトにネットワーク コンテナが作成されます（未作成の場合）。

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

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

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 つのクラスターを作成します。 クラスターには、同じデータセットを維持するホストのグループが含まれます。 このリソースは、マルチクラウド クラスターを作成できます。 各プロジェクトは最大 25 のデータベース配置をサポートします。 このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。 この機能はサーバーレス クラスターでは利用できません。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 を現在の日付に設定してください。

リージョン停止時のレプリカセットの再構成
backupEnabled
ブール値
デフォルト: false

クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されている場合、クラスターはバックアップを実行できます。NVMe クラスターの場合、この値を true に設定する必要があります。バックアップは、専有クラスターにはクラウドバックアップを使用し、テナント クラスターには共有クラスター バックアップを使用します。false に設定されている場合は、クラスターはバックアップを使用しません。

オブジェクト （MongoDB Connector for Business Intelligence の設定）

このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。

MongoDB Connector for Business Intelligence
clusterType
string
列挙: "REPLICASET" "SHARDED" "GEOSHARDED"

クラスターを構成するノードの構成。

configServerManagementMode
string
デフォルト: "ATLAS_MANAGED"
列挙: "ATLAS_MANAGED" "FIXED_TO_DEDICATED"

シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。

ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。

FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。

MongoDB シャーディングされたクラスターのコンフィギュレーション サーバー
diskSizeGB
数値 <double> [ 10 .. 4096 ]

インスタンス データ ボリュームのストレージ容量（ギガバイト単位）。 この数を増やすと、容量が追加されます。

この値は、M 0 /M 2 /M 5クラスターでは構成できません。

MongoDB Cloud では、replicationSpecs を設定する場合にこのパラメータが必要です。

最小（ 10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。

ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。

ディスク ストレージの最大値は、選択したクラスターの最大 RAM の50倍を超えることはできません。 より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

diskWarmingMode
string
デフォルト: "FULLY_WARMED"
列挙: "FULLY_WARMED" "VISIBLE_EARLIER"

ディスク ウォーミング モードの選択。

セカンダリ ディスク ウォーミングの影響軽減
encryptionAtRestProvider
string
列挙: "NONE" "AWS" "AZURE" "GCP"

カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマー キー管理を有効にするには、クラスター eplicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize の設定は、M10 以上、かつ "backupEnabled" : false または完全に省略する必要があります。

カスタマー キー管理を使用した保管時の暗号化
globalClusterSelfManagedSharding
ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。

false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。

true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。

この設定は、クラスターが配置されると変更できません。

グローバルクラスターの作成
の配列 オブジェクト （コンポーネント ラベル）
非推奨

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。

クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めています。

mongoDBMajorVersion
string

クラスターの MongoDB メジャー バージョン。

作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。

更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。

Atlas で利用可能な MongoDB のバージョン
name
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

paused
ブール値

クラスターが一時停止しているかどうかを示すフラグ。

pitEnabled
ブール値

クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。

継続的なクラウドバックアップ
replicaSetScalingStratey
string
デフォルト: "WORKLOAD_Type"
列挙: "SEQENTIAL" "WORKLOAD_Type" "NOde_type"

クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。

デフォルトでは、Atlas は WORKLOAD_Type の下でスケーリングされます。 このモードでは、Atlas は分析ノードを運用ノードと並行して拡張できます。

SEQUENTIAL として構成すると、Atlas はすべてのノードを順番にスケーリングします。 このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。

Node_type として構成すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。 このモードは、頻繁にクラスター階層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。 これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響を与える可能性があります。

レプリカセットのスケーリングモードの変更
の配列 オブジェクト （レプリケーションの仕様）

クラスター リージョンを構成する設定のリスト。グローバルクラスターの場合、配列内の各オブジェクトは、クラスター ノードが配置されるゾーンを表します。非グローバルのシャーディングされたクラスターとレプリカセットの場合、この配列にはクラスター ノードの配置場所を表す 1 つのオブジェクトが含まれます。

rootCertType
string
デフォルト: "ISRGROOTX1"
値: "ISRGROOTX1"

MongoDB Cloud クラスターが使用するルート認証局。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

マルチクラウド クラスター

{
  • "clusterType": "REPLICASET",
  • "links": [ ],
  • "name": "multiCloud",
  • "replicationSpecs": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "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": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

1 つのプロジェクトから 1 つのクラスタを削除

指定したプロジェクトからクラスターを 1 つ削除します。クラスターを削除するには、終了保護を無効にする必要があります。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。この機能はサーバーレス クラスターでは利用できません。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つのクラスターの詳細を返します。 クラスターには、同じデータセットを維持するホストのグループが含まれます。 このレスポンスには、マルチクラウド クラスターが含まれます。 このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。 この機能はサーバーレス クラスターでは利用できません。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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",
  • "backupEnabled": false,
  • "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": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

1 つのプロジェクトからの 1 つのクラスターを変更

指定されたプロジェクト内の 1 つのクラスターの詳細を更新します。 クラスターには、同じデータセットを維持するホストのグループが含まれます。 このリソースは、マルチクラウド クラスターを更新できます。 クラスターの終了保護を更新するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。 その他のすべての更新では、リクエスト元の API キーにプロジェクト クラスター マネージャー ロールが必要です。 一時停止中のクラスター（ paused : true ）は変更できません。 paused : falseを設定するには、このエンドポイントを呼び出す必要があります。 このエンドポイントがpaused : falseの応答を返したら、クラスターに加える変更を使用して再度呼び出すことができます。 この機能はサーバーレス クラスターでは利用できません。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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
string <date-time>

リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み（過半数がコミットされた書込みであっても）が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。

リージョン停止時のレプリカセットの再構成
backupEnabled
ブール値
デフォルト: false

クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されている場合、クラスターはバックアップを実行できます。NVMe クラスターの場合、この値を true に設定する必要があります。バックアップは、専有クラスターにはクラウドバックアップを使用し、テナント クラスターには共有クラスター バックアップを使用します。false に設定されている場合は、クラスターはバックアップを使用しません。

オブジェクト （MongoDB Connector for Business Intelligence の設定）

このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。

MongoDB Connector for Business Intelligence
clusterType
string
列挙: "REPLICASET" "SHARDED" "GEOSHARDED"

クラスターを構成するノードの構成。

configServerManagementMode
string
デフォルト: "ATLAS_MANAGED"
列挙: "ATLAS_MANAGED" "FIXED_TO_DEDICATED"

シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。

ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。

FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。

MongoDB シャーディングされたクラスターのコンフィギュレーション サーバー
diskSizeGB
数値 <double> [ 10 .. 4096 ]

インスタンス データ ボリュームのストレージ容量（ギガバイト単位）。 この数を増やすと、容量が追加されます。

この値は、M 0 /M 2 /M 5クラスターでは構成できません。

MongoDB Cloud では、replicationSpecs を設定する場合にこのパラメータが必要です。

最小（ 10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。

ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。

ディスク ストレージの最大値は、選択したクラスターの最大 RAM の50倍を超えることはできません。 より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

diskWarmingMode
string
デフォルト: "FULLY_WARMED"
列挙: "FULLY_WARMED" "VISIBLE_EARLIER"

ディスク ウォーミング モードの選択。

セカンダリ ディスク ウォーミングの影響軽減
encryptionAtRestProvider
string
列挙: "NONE" "AWS" "AZURE" "GCP"

カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマー キー管理を有効にするには、クラスター eplicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize の設定は、M10 以上、かつ "backupEnabled" : false または完全に省略する必要があります。

カスタマー キー管理を使用した保管時の暗号化
globalClusterSelfManagedSharding
ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。

false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。

true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。

この設定は、クラスターが配置されると変更できません。

グローバルクラスターの作成
の配列 オブジェクト （コンポーネント ラベル）
非推奨

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。

クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めています。

mongoDBMajorVersion
string

クラスターの MongoDB メジャー バージョン。

作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。

更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。

Atlas で利用可能な MongoDB のバージョン
name
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

paused
ブール値

クラスターが一時停止しているかどうかを示すフラグ。

pitEnabled
ブール値

クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。

継続的なクラウドバックアップ
replicaSetScalingStratey
string
デフォルト: "WORKLOAD_Type"
列挙: "SEQENTIAL" "WORKLOAD_Type" "NOde_type"

クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。

デフォルトでは、Atlas は WORKLOAD_Type の下でスケーリングされます。 このモードでは、Atlas は分析ノードを運用ノードと並行して拡張できます。

SEQUENTIAL として構成すると、Atlas はすべてのノードを順番にスケーリングします。 このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。

Node_type として構成すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。 このモードは、頻繁にクラスター階層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。 これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響を与える可能性があります。

レプリカセットのスケーリングモードの変更
の配列 オブジェクト （レプリケーションの仕様）

クラスター リージョンを構成する設定のリスト。グローバルクラスターの場合、配列内の各オブジェクトは、クラスター ノードが配置されるゾーンを表します。非グローバルのシャーディングされたクラスターとレプリカセットの場合、この配列にはクラスター ノードの配置場所を表す 1 つのオブジェクトが含まれます。

rootCertType
string
デフォルト: "ISRGROOTX1"
値: "ISRGROOTX1"

MongoDB Cloud クラスターが使用するルート認証局。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",
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "mongoDBMajorVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "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": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

1 つのクラスターのフェイルオーバーのテスト

指定されたプロジェクト内の指定されたクラスターのフェイルオーバー テストを開始します。クラスターには、同じデータセットを維持するホストのグループが含まれます。フェイルオーバー テストは、MongoDB Cloud がクラスターのプライマリ ノードの障害をどのように取り扱うかを確認します。テスト中、MongoDB Cloud はプライマリ ノードをシャットダウンし、新しいプライマリを選択します。このリソースを使用するには、リクエスト元の API キーにプロジェクト クラスター マネージャー ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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"
}

ネットワークピアリング

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

1 つのクラウドプロバイダーの 1 つのプロジェクトでのすべてのネットワーク ピアリング コンテナを返す

指定されたクラウドプロバイダーの指定されたプロジェクト内の、すべてのネットワーク ピアリング コンテナに関する詳細を返します。クラウドプロバイダーを指定しない場合、MongoDB Cloud は AWS（Amazon Web Services）のプロジェクト内のすべてのネットワーク ピアリング コンテナに関する詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 形式にするかどうかを示すフラグ。

providerName
必須
string
デフォルト: "AWS"
列挙: "AWS" "AZURE" "GCP"

必要なネットワーク ピアリング コンテナを提供するクラウド サービス プロバイダー。

応答

応答サンプル

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

1 つの新しいネットワーク ピアリング コンテナを作成

指定されたプロジェクト内に新しいネットワーク ピアリング コンテナを 1 つ作成します。MongoDB Cloud は、ネットワーク ピアリング コンテナにネットワーク ピアリング接続を配置できます。GCP ではプロジェクトごとに 1 つのコンテナを持つことができます。AWS と Azure は、クラウドプロバイダーのリージョンごとに 1 つのコンテナを持つことができます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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

要求されたネットワーク ピアリング コンテナを提供するクラウド サービス プロバイダー。

atlasCidrBlock
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a...

MongoDB Cloud がプロジェクト内のネットワーク ピアリング コンテナに使用する CIDR（Classless Inter-Domain Routing）表記で表される IP アドレス。MongoDB Cloud は、このクラウドプロバイダーに配置されたすべてのプロジェクトのクラスターに、この範囲の IP アドレスを割り当てます。このプロジェクトに M10 以上のクラスターまたはネットワークピアリング接続が存在する場合、MongoDB Cloud はこの値をロックします。

これらの CIDR ブロックは、RFC 1918 に従って予約された範囲内に収まる必要があります。AWS と Azure ではさらに、ブロックが /24 から /21 の範囲に制限されます。

ターゲット プロジェクトに次のアイテムが含まれている場合、CIDR ブロックは変更できません。

  • 任意の M10 以上のクラスター
  • その他の VPC ピアリング接続

新しいプロジェクトを作成し、ネットワークピアリング接続を作成して、そのプロジェクトに必要な MongoDB Cloud ネットワーク ピアリング コンテナ CIDR ブロックを設定することもできます。MongoDB Cloud では、CIDR ブロックとプロジェクトに選択されたリージョンに基づいて、ネットワークピアリング接続あたりの MongoDB ノードの数が制限されます。

例: 3 つのアベイラビリティーゾーンと /24 の MongoDB CIDR ネットワーク ピアリング コンテナ ブロックの制限をサポートする AWS（Amazon Web Services）リージョンのプロジェクトは、27 個の 3 ノードレプリカセットに相当します。

regionName
必須
string
列挙: "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "CA_CENTRAL_1" "EU_NORTH_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "EU_CENTRAL_2" "SA_EAST_1" "AP_EAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_SOUTHEAST_4" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "AP_SOUTHEAST_1" "AP_SOUTH_1" "AP_SOUTH_2" "CN_NORTH_1" "CN_NORTHWEST_1" "ME_CENTRAL_1" "ME_SOUTH_1" "AF_SOUTH_1" "EU_SOUTH_1" "EU_SOUTH_2" "IL_CENTRAL_1" "CA_WEST_1" "GLOBAL" "US_GOV_WEST_1" "US_GOV_EAST_1"

MongoDB Cloud がこのネットワーク ピアリング コンテナを配置した、AWS（Amazon Web Services）が定義する地理的領域。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "providerName": "AWS",
  • "atlasCidrBlock": "string",
  • "region": "US_CENTRAL",
  • "regionName": "US_EAST_1"
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  • "region": "US_CENTRAL",
  • "vnetName": "stringstringstringstringstringstringst",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

1 つのプロジェクトでのすべてのネットワーク ピアリング コンテナを返す

指定されたプロジェクト内のすべてのネットワーク ピアリング コンテナに関する詳細を返します。ネットワーク ピアリング コンテナには、ネットワークピアリング接続が含まれます。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 つのネットワーク ピアリング コンテナを削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

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

削除対象の MongoDB Cloud ネットワーク コンテナを識別する、ユニークな 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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

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

Cloud ネットワーク コンテナを識別する一意の 24桁の 16 進数 。stringMongoDB

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  • "region": "US_CENTRAL",
  • "vnetName": "stringstringstringstringstringstringst",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

1 つのネットワーク ピアリング コンテナを更新

指定されたプロジェクト内の指定された 1 つのネットワーク ピアリング コンテナのネットワーク詳細とラベルを更新します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

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

削除対象の MongoDB Cloud ネットワーク コンテナを識別する、ユニークな 24 桁の 16 進数文字列。

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

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

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

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

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

指定されたプロジェクト内の指定された 1 つのネットワーク ピアリング コンテナのネットワーク詳細とラベルを更新します。

providerName
string

要求されたネットワーク ピアリング コンテナを提供するクラウド サービス プロバイダー。

atlasCidrBlock
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a...

MongoDB Cloud がプロジェクト内のネットワーク ピアリング コンテナに使用する CIDR（Classless Inter-Domain Routing）表記で表される IP アドレス。MongoDB Cloud は、このクラウドプロバイダーに配置されたすべてのプロジェクトのクラスターに、この範囲の IP アドレスを割り当てます。このプロジェクトに M10 以上のクラスターまたはネットワークピアリング接続が存在する場合、MongoDB Cloud はこの値をロックします。

これらの CIDR ブロックは、RFC 1918 に従って予約された範囲内に収まる必要があります。AWS と Azure ではさらに、ブロックが /24 から /21 の範囲に制限されます。

ターゲット プロジェクトに次のアイテムが含まれている場合、CIDR ブロックは変更できません。

  • 任意の M10 以上のクラスター
  • その他の VPC ピアリング接続

新しいプロジェクトを作成し、ネットワークピアリング接続を作成して、そのプロジェクトに必要な MongoDB Cloud ネットワーク ピアリング コンテナ CIDR ブロックを設定することもできます。MongoDB Cloud では、CIDR ブロックとプロジェクトに選択されたリージョンに基づいて、ネットワークピアリング接続あたりの MongoDB ノードの数が制限されます。

例: 3 つのアベイラビリティーゾーンと /24 の MongoDB CIDR ネットワーク ピアリング コンテナ ブロックの制限をサポートする AWS（Amazon Web Services）リージョンのプロジェクトは、27 個の 3 ノードレプリカセットに相当します。

regionName
必須
string
列挙: "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "CA_CENTRAL_1" "EU_NORTH_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "EU_CENTRAL_2" "SA_EAST_1" "AP_EAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_SOUTHEAST_4" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "AP_SOUTHEAST_1" "AP_SOUTH_1" "AP_SOUTH_2" "CN_NORTH_1" "CN_NORTHWEST_1" "ME_CENTRAL_1" "ME_SOUTH_1" "AF_SOUTH_1" "EU_SOUTH_1" "EU_SOUTH_2" "IL_CENTRAL_1" "CA_WEST_1" "GLOBAL" "US_GOV_WEST_1" "US_GOV_EAST_1"

MongoDB Cloud がこのネットワーク ピアリング コンテナを配置した、AWS（Amazon Web Services）が定義する地理的領域。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "providerName": "AWS",
  • "atlasCidrBlock": "string",
  • "region": "US_CENTRAL",
  • "regionName": "US_EAST_1"
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  • "region": "US_CENTRAL",
  • "vnetName": "stringstringstringstringstringstringst",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

1 つのプロジェクトのすべてのネットワークピアリング接続を返す

指定されたプロジェクト内のすべてのネットワーク ピアリング接続に関する詳細を返します。ネットワーク ピアリングにより、クラウドでホストされる複数のアプリケーションを同じプロジェクトに安全に接続できます。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 形式にするかどうかを示すフラグ。

providerName
string
デフォルト: "AWS"
列挙: "AWS" "AZURE" "GCP"

この VPC ピアリング接続に使用するクラウド サービス プロバイダー。

応答

応答サンプル

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

1 つの新しいネットワークピアリング接続を作成

指定されたプロジェクト内に新しいネットワークピアリング接続を 1 つ作成します。ネットワーク ピアリングにより、クラウドでホストされる複数のアプリケーションを同じプロジェクトに安全に接続できます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。考慮事項と前提条件の詳細については、ネットワーク ピアリングのドキュメントを参照してください。

Azure ネットワーク ピアリングの前提条件
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 つのネットワークピアリング接続を作成します。

accepterRegionName
必須
string

MongoDB Cloud VPC とピアリングしたVPC（Virtual Peering Connection、仮想ピアリング接続）が存在する AWS（Amazon Web Services）のリージョン。VPC と MongoDB Cloud VPC が同じリージョンに存在する場合、リソースは null を返します。

awsAccountId
必須
string = 12文字 ^[0-9]{12}$

MongoDB Cloud VPC とピアリングした VPC を所有する AWS（Amazon Web Services）アカウントを識別するユニークな 12 桁の文字列。

containerId
必須
string = 24文字 ^([a-f0-9]{24})$

指定されたネットワークピアリング接続を含む MongoDB Cloud コンテナを識別するユニークな 24 桁の 16 進数文字列。

providerName
string

要求されたネットワークピアリング接続を提供するクラウド サービス プロバイダー。

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

MongoDB Cloud VPC とピアリングする VPC のサブネットの IP（Internet Protocol）アドレスを、CIDR（Classless Inter-Domain Routing）表記したもの。

vpcId
必須
string >= 5 文字 ^vpc-[0-9a-f]{17}$

MongoDB Cloud VPC とピアリングする AES（Amazon Web Services）上の VPC を識別する、ユニークな文字列。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "vpcId": "string"
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "errorStateName": "REJECTED",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "statusName": "INITIATING",
  • "vpcId": "string"
}

1 つの既存のネットワークピアリング接続を削除

指定されたプロジェクト内の 1 つのネットワークピアリング接続を削除します。プロジェクトに関連付けられた最後のネットワークピアリング接続を削除すると、MongoDB Cloud はプロジェクトの IP アクセス リストから AWS セキュリティ グループも削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

peerId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

peerId
必須
string = 24文字 ^([a-f0-9]{24})$

検索対象のネットワークピアリング接続を識別する、ユニークな 24 桁の 16 進数文字列。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "errorStateName": "REJECTED",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "statusName": "INITIATING",
  • "vpcId": "string"
}

1 つの新しいネットワークピアリング接続を更新

指定されたプロジェクト内の指定されたネットワークピアリング接続を 1 つ更新します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

peerId
必須
string = 24文字 ^([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 つのネットワークピアリング接続を変更します。

accepterRegionName
必須
string

MongoDB Cloud VPC とピアリングしたVPC（Virtual Peering Connection、仮想ピアリング接続）が存在する AWS（Amazon Web Services）のリージョン。VPC と MongoDB Cloud VPC が同じリージョンに存在する場合、リソースは null を返します。

awsAccountId
必須
string = 12文字 ^[0-9]{12}$

MongoDB Cloud VPC とピアリングした VPC を所有する AWS（Amazon Web Services）アカウントを識別するユニークな 12 桁の文字列。

containerId
必須
string = 24文字 ^([a-f0-9]{24})$

指定されたネットワークピアリング接続を含む MongoDB Cloud コンテナを識別するユニークな 24 桁の 16 進数文字列。

providerName
string

要求されたネットワークピアリング接続を提供するクラウド サービス プロバイダー。

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

MongoDB Cloud VPC とピアリングする VPC のサブネットの IP（Internet Protocol）アドレスを、CIDR（Classless Inter-Domain Routing）表記したもの。

vpcId
必須
string >= 5 文字 ^vpc-[0-9a-f]{17}$

MongoDB Cloud VPC とピアリングする AES（Amazon Web Services）上の VPC を識別する、ユニークな文字列。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "vpcId": "string"
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "errorStateName": "REJECTED",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "statusName": "INITIATING",
  • "vpcId": "string"
}

1 つのプロジェクトのピアリング専用モードでの接続を確認（非推奨）

指定されたプロジェクトがピアリング専用で接続モードに設定されているかどうかを確認します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

接続文字列の変更
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
}

1 つのプロジェクトのピアリング専用モードでの接続を無効化（非推奨）

指定されたプロジェクトのピアリング専用モードでの接続を無効にします。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

接続文字列の変更
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
必須
ブール値

指定されたプロジェクトで、ピアリング専用モードでの接続が有効化されているかどうかを示すフラグ。

応答

リクエスト サンプル

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

応答サンプル

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

Online Archive

オンライン アーカイブの返却、追加、編集、削除を行います。

1 つのクラスターのすべてのオンライン アーカイブを返す

すべてのオンライン アーカイブの詳細を返します。このアーカイブには、1 つのプロジェクト内の 1 つのクラスターのデータが格納されています。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 キーにプロジェクト データアクセス管理者ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

1 つのオンラインアーカイブを作成するコレクションを持つクラスターを識別する、人間が判読可能なラベル。

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

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

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

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

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

1 つのオンライン アーカイブを作成します。

collName
必須
string

オンラインアーカイブを作成したコレクションを識別する、人間が判読可能なラベル。

collectionType
string
デフォルト: "STANDARD"
列挙: "TIMESERIES" "STANDARD"

返却対象の MongoDB データベース コレクションの分類。

このパラメーターを TIMESERIES に設定する場合は、"criteria.type" : "date" と "criteria.dateFormat" : "ISODATE" を設定します。

必須
オブジェクト (CriteriaView)

MongoDB Cloud がデータをアーカイブする際のルール。

MongoDB Cloud がアーカイブするデータの選択方法を選ぶには、criteria.typeフィールドを使用します。データの経過時間または MongoDB クエリを使用してデータを選択します。"criteria.type": "DATE" は、日付に基づいてアーカイブするドキュメントを選択します。"criteria.type": "CUSTOM" は、カスタム JSON クエリに基づいてアーカイブするドキュメントを選択します。MongoDB Cloudは、"collectionType": "TIMESERIES" の場合、"criteria.type": "CUSTOM" をサポートしていません。

オブジェクト (DataExpirationRuleView)

アーカイブからデータを削除するタイミングを指定するためのルール。

オブジェクト (CreateDataProcessRegionView)

アーカイブされたデータを保存するリージョンを構成するための設定。

dbName
必須
string

オンライン アーカイブを含むコレクションを格納するデータベースの、人間が判読可能なラベル。

の配列 オブジェクト （オンライン アーカイブのパーティション） non-empty

コレクション内のデータを論理的に分割するために使用するドキュメント パラメーターを格納したリスト。パーティションは、基礎となるコレクション データの大まかなレベルのフィルタリングを提供します。データを分割するには、頻繁にクエリを実行するパラメーターを指定します。CREATE ONE ONLINE ARCHIVE エンドポイントで "criteria.type": "DATE" を指定した場合には、クエリに使用するパラメーターを最大 3 つ指定できます。これらのパラメーターの 1 つは DATE 値である必要があり、この場合は必須です。CREATE ONE ONLINE ARCHIVE エンドポイントで "criteria.type": "CUSTOM" を指定した場合には、クエリに使用するパラメーターを最大 2 つ指定できます。"criteria.type": "DATE" または "criteria.type": "CUSTOM" パラメーターを使用しないクエリでは、MongoDBはアーカイブされたすべてのドキュメントのコレクション全体をスキャンします。これには時間がかかり、コストが増加します。

paused
ブール値

このオンライン アーカイブが一時停止状態で存在するかどうかを示すフラグ。コレクションに別のアクティブなオンライン アーカイブがある場合、再開要求は失敗します。アクティブなオンライン アーカイブを一時停止したり、一時停止したオンライン アーカイブを再開したりするには、このパラメーターを含める必要があります。アクティブなアーカイブを一時停止するには、true に設定します。一時停止したアーカイブを再開するには、false に設定します。

オブジェクト （オンライン アーカイブのスケジュール）

アーカイブ プロセスが定期的に実行される頻度と期間。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dbName": "string",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    }
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "state": "PENDING"
}

オンライン アーカイブ クエリ ログをダウンロード

指定したオンラインアーカイブのクエリログをダウンロードします。 このリソースを使用するには、リクエスト元の API キーにプロジェクトデータの読み取り専用以上のロールが必要です。 API は、JSON 応答スキーマを使用した直接呼び出しをサポートしていません。 "Accept: application/gzip" という形式の accept ヘッダーを使用して gzip レスポンススキーマをリクエストする必要があります。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

1 つのオンライン アーカイブからクエリ ログを返却するコレクションを持つクラスターを識別する、人間が判読可能なラベル。

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

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

startDate
integer <int64> >= 1199145600
例: startDate=1636481348

返却対象のログ メッセージの範囲の開始点を指定する日時。このリソースは、UNIXエポックからの経過秒数で値を表します。

endDate
integer <int64> >= 1199145600
例: endDate=1636481348

返却対象のログ メッセージの範囲の終了点を指定する日時。このリソースは、UNIXエポックからの経過秒数で値を表します。

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

クエリのログをオンライン　アーカイブのみにダウンロードするか、オンライン　アーカイブとクラスターの両方に対してダウンロードするかを示すフラグ。

応答

応答サンプル

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

1 つのオンライン アーカイブを削除

オンライン アーカイブを 1 つ削除します。このアーカイブには、1 つのプロジェクト内の 1 つのクラスターのデータが格納されています。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。

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

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

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

archiveId
必須
string = 24文字 ^([a-f0-9]{24})$

削除対象のオンライン アーカイブを識別する、ユニークな 24 桁の 16 進数文字列。

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つのクラスターに対して 1 つのオンラインアーカイブを返します。このアーカイブには、1 つのプロジェクト内の 1 つのクラスターのデータが格納されています。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

archiveId
必須
string = 24文字 ^([a-f0-9]{24})$

返却対象のオンライン アーカイブを識別する、ユニークな 24 桁の 16 進数文字列。

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "state": "PENDING"
}

1 つのオンライン アーカイブを更新

1 つのオンライン アーカイブの更新、一時停止、再開を行います。このアーカイブには、1 つのプロジェクト内の 1 つのクラスターのデータが格納されています。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。

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

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

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

archiveId
必須
string = 24文字 ^([a-f0-9]{24})$

更新対象のオンライン アーカイブを識別する、ユニークな 24 桁の 16 進数文字列。

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つのオンライン アーカイブの更新、一時停止、再開を行います。

オブジェクト (CriteriaView)

MongoDB Cloud がデータをアーカイブする際のルール。

MongoDB Cloud がアーカイブするデータの選択方法を選ぶには、criteria.typeフィールドを使用します。データの経過時間または MongoDB クエリを使用してデータを選択します。"criteria.type": "DATE" は、日付に基づいてアーカイブするドキュメントを選択します。"criteria.type": "CUSTOM" は、カスタム JSON クエリに基づいてアーカイブするドキュメントを選択します。MongoDB Cloudは、"collectionType": "TIMESERIES" の場合、"criteria.type": "CUSTOM" をサポートしていません。

オブジェクト (DataExpirationRuleView)

アーカイブからデータを削除するタイミングを指定するためのルール。

paused
ブール値

このオンライン アーカイブが一時停止状態で存在するかどうかを示すフラグ。コレクションに別のアクティブなオンライン アーカイブがある場合、再開要求は失敗します。アクティブなオンライン アーカイブを一時停止したり、一時停止したオンライン アーカイブを再開したりするには、このパラメーターを含める必要があります。アクティブなアーカイブを一時停止するには、true に設定します。一時停止したアーカイブを再開するには、false に設定します。

オブジェクト （オンライン アーカイブのスケジュール）

アーカイブ プロセスが定期的に実行される頻度と期間。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "paused": true,
  • "schedule": {
    }
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "state": "PENDING"
}

組織

MongoDB Cloud 内の組織単位の返却、追加、編集を行います。

すべての組織を返す

リクエスト元の API キーがアクセスできるすべての組織を返します。このリソースを使用するには、リクエスト元の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 形式にするかどうかを示すフラグ。

name
string

返却するリストをフィルタリングするために使用される、人間が判読可能な組織のラベル。指定された名前で始まる組織を、大文字と小文字を区別せずに検索します。

応答

応答サンプル

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

1 つの組織を作成

MongoDB Cloud に組織を 1 件作成し、それをリクエスト元の API キーの組織にリンクさせます。このリソースを使用するには、リクエスト元の API キーに組織所有者ロールが必要です。リクエストする API の組織は、支払い組織である必要があります。詳細については、MongoDB Atlas ドキュメントの「支払い組織の構成」を参照してください。

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

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

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

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

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

作成したい組織。

オブジェクト (CreateAtlasOrganizationApiKey)

作成するプログラム API キーの詳細。

federationSettingsId
string = 24文字 ^([a-f0-9]{24})$

新しい組織からリンクされるフェデレーションを識別する、ユニークな 24 桁の 16 進数の文字列。指定する場合、新しい組織の組織オーナー候補には、フェデレーションに関連づけられた組織での所有者ロールが必要です。

name
必須
string [ 1 .. 64 ] 文字 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

組織を識別する、人間が判読可能なラベル。

orgOwnerId
string = 24文字 ^([a-f0-9]{24})$

組織所有者ロールを割り当てる MongoDB クラウド ユーザーを識別する、ユニークな 24 桁の 16 進数文字列。このユーザーは、呼び出し元の API キーと同じ組織のメンバーである必要があります。ただし federationSettingsId を指定した場合は、このユーザーには指定されたフェデレーション内の組織についての所有者ロールが必要です。このパラメータは、Programmatic API Keysで認証する場合にのみ必要です。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "apiKey": {
    },
  • "federationSettingsId": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "orgOwnerId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "apiKey": {
    },
  • "federationSettingsId": "32b6e34b3d91647abb20e7b8",
  • "orgOwnerId": "32b6e34b3d91647abb20e7b8",
  • "organization": {}
}

1 つの組織を削除

指定した 1 件の組織を削除します。MongoDB Cloud はこのリソースに次の制限を課します。

  • アクティブなプロジェクトを持つ組織は削除できません。
  • 組織を削除する前に、組織内のすべてのプロジェクトを削除する必要があります。このリソースを使用するには、リクエスト元の API キーに組織所有者ロールが必要です。
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

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

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

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

応答

応答サンプル

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

1 つの組織を返す

リクエスト元の API がアクセスできる組織を 1 件返します。このリソースを使用するには、リクエスト元の API キーに組織メンバーロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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 キーに組織所有者ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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

指定した組織でアップデートされる詳細です。

name
必須
string [ 1 .. 64 ] 文字 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

組織を識別する、人間が判読可能なラベル。

応答

リクエスト サンプル

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

応答サンプル

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

1 つの組織の 1 つ以上のプロジェクトを返す

指定した組織内の複数のプロジェクトを返します。各組織は複数のプロジェクトを持つことができます。プロジェクトを使用して、次の操作を行います。

  • 開発環境、テスト環境、本番環境などの異なる環境を相互に分離します。
  • 異なる MongoDB Cloud ユーザーまたはチームを異なる環境に関連付けるか、異なる環境の MongoDB Cloud ユーザーに異なる権限を付与します。
  • 個別のクラスターセキュリティ構成を維持します。
  • さまざまなアラート設定を作成します。

このリソースを使用するには、リクエスト元の API キーに組織メンバーロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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 形式にするかどうかを示すフラグ。

name
string

返却するリストをフィルタリングするために使用される、人間が判読可能なプロジェクトのラベル。指定された名前のプレフィックスが付いた組織内のプロジェクトを、大文字と小文字を区別せずに検索します。

応答

応答サンプル

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

すべての組織の招待状を返す

指定した組織に対するすべての保留中の招待を返します。このリソースを使用するには、リクエスト元の API キーに組織所有者ロールが必要です。

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

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

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

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

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

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

username
string <email>

この組織に招待されたユーザーアカウントのメールアドレス。このパラメータを除外すると、このリソースはすべての保留中の招待を返します。

応答

応答サンプル

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

1 つの組織の招待状を更新

指定した組織に対する保留中の招待 1 件の詳細を更新します。更新する招待を指定するには、招待されたユーザーのユーザー名を入力します。このリソースを使用するには、リクエスト元の API キーに組織所有者ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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 件の詳細を更新します。

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

組織への招待が承諾された際に、ユーザーが追加されるプロジェクトのリスト。

役割
の配列 string unique
アイテム列挙: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

MongoDB Cloud ユーザーに割り当てる 1 件以上の組織レベルのロール。

teamIds
の配列 string unique [ items = 24 文字 ^([a-f0-9]{24})$ ]

任意の MongoDB Cloud ユーザーを招待するチームのリスト。

username
string <email>

任意の MongoDB Cloud ユーザーに属する電子メール アドレス。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

1 人の MongoDB クラウド ユーザーを 1 つの Atlas 組織に招待する

MongoDB Cloud ユーザー1件に対して、指定された組織への参加を招待します。指定された組織内の情報にユーザーがアクセスするには、招待を承諾する必要があります。このリソースを使用するには、リクエスト元の API キーに組織所有者ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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

MongoDB Cloud ユーザー1件に対して、指定された組織への参加を招待します。

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

組織への招待が承諾された際に、ユーザーが追加されるプロジェクトのリスト。

役割
の配列 string unique
アイテム列挙: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

MongoDB Cloud ユーザーに割り当てる 1 件以上の組織レベルのロール。

teamIds
の配列 string unique [ items = 24 文字 ^([a-f0-9]{24})$ ]

任意の MongoDB Cloud ユーザーを招待するチームのリスト。

username
string <email>

任意の MongoDB Cloud ユーザーに属する電子メール アドレス。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

1 つの組織の招待状をキャンセル

指定した MongoDB Cloud ユーザーに送信され、保留中となっている組織への参加招待1 件をキャンセルします。ユーザーが承諾した招待をキャンセルすることはできません。このリソースを使用するには、リクエスト元の API キーに組織所有者ロールが必要です。

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

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

招待ID
必須
string

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

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

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

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

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

応答

応答サンプル

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

1 つの組織の招待状を返す

指定した組織への保留中の招待の詳細を返します。このリソースを使用するには、リクエスト元の API キーに組織所有者ロールが必要です。

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

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

招待ID
必須
string = 24文字 ^([a-f0-9]{24})$

招待を識別するユニークな 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",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

招待状 ID を使用して 1 つの組織の招待状を更新

指定した組織に対する保留中の招待 1 件の詳細を更新します。招待を指定するには、その招待のユニークな識別文字列を入力します。組織に対するすべての保留中の招待の ID を取得するには、「すべての組織の招待状を返す」エンドポイントを使用します。このリソースを使用するには、リクエスト元の API キーに組織所有者ロールが必要です。

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

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

招待ID
必須
string = 24文字 ^([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 件の詳細を更新します。

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

組織への招待が承諾された際に、ユーザーが追加されるプロジェクトのリスト。

役割
の配列 string unique
アイテム列挙: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

MongoDB Cloud ユーザーに割り当てる 1 件以上の組織レベルのロール。

teamIds
の配列 string unique [ items = 24 文字 ^([a-f0-9]{24})$ ]

任意の MongoDB Cloud ユーザーを招待するチームのリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

1 つの組織の設定を返す

指定した組織の設定に関する詳細を返します。このリソースを使用するには、リクエスト元の API キーに組織所有者ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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
{
  • "apiAccessListRequired": true,
  • "genAIFeaturesEnabled": true,
  • "maxServiceAccountSecretValidityInHours": 0,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true,
  • "securityContact": "string"
}

1 つの組織の設定を更新

組織の設定を更新します。このリソースを使用するには、リクエスト元の API キーに組織所有者ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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

指定した組織の設定でアップデートする詳細。

apiAccessListRequired
ブール値

API 操作に対し、指定された組織の API アクセスリストに追加された IP アドレスからの発信を要求するかどうかを示すフラグ。

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

この組織が生成系AI機能にアクセスしているかどうかを示すフラグ。この設定は Atlas CMK にのみ適用され、デフォルトで有効になっています。この設定をオンにすると、プロジェクトオーナーはプロジェクトレベルで個々のAI機能を有効または無効にできる可能性があります。

生成系 AI FAQ
maxServiceAccountSecretValidityInHours
integer <int32>

指定された組織内の新しい Atlas Admin APIサービス アカウント シークレットの有効期限が切れるまでの最大期間を時間単位で表す数値。

multiFactorAuthRequired
ブール値

指定された組織にアクセスする前に、ユーザーに多要素認証（MFA）を設定することを要求するかどうかを示すフラグ。 詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/security-multi-factor-authentication/を参照してください。

restrictEmployeeAccess
ブール値

MongoDB サポートが、指定された組織内の任意のデプロイで Atlas インフラストラクチャとクラスター ログに明示的な許可なしでアクセスするのをブロックするかどうかを示すフラグ。 この設定をオンにすると、サポートの問題を解決するために、MongoDB サポートに対して Atlas の配置への24時間のバイパス アクセスを許可することができます。 詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/security-restrict-support-access/を参照してください。

securitycontact
string

指定された組織のセキュリティ関連の通知を受信するための単一のメールアドレスを指定する文字列。セキュリティ担当者を指定しても、セキュリティ上の決定や承認のために Atlas への認可やアクセスは許可されません。空の文字列は有効であり、既存のセキュリティ連絡先（存在する場合）をクリアします。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "apiAccessListRequired": true,
  • "genAIFeaturesEnabled": true,
  • "maxServiceAccountSecretValidityInHours": 0,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true,
  • "securityContact": "string"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "apiAccessListRequired": true,
  • "genAIFeaturesEnabled": true,
  • "maxServiceAccountSecretValidityInHours": 0,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true,
  • "securityContact": "string"
}

1 つの組織のすべての MongoDB クラウド ユーザーを返す

指定された組織に関連付けられている MongoDB Cloud ユーザーの詳細を返します。返される各 MongoDB Cloud ユーザーは、指定された組織または指定された組織内のプロジェクトに属している必要があります。このリソースを使用するには、リクエスト元の API キーに組織メンバーロールが必要です。

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

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

クエリ パラメータ
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 人の MongoDB クラウド ユーザーを削除

指定された組織から MongoDB Cloud ユーザー 1 件を削除します。このリソースを使用するには、リクエスト元の API キーに組織のユーザー管理者ロールが必要です。

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

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

userId
必須
string = 24文字 ^([a-f0-9]{24})$

削除するユーザーを識別する、ユニークな 24 桁の 16 進数の文字列。

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

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

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

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

応答

応答サンプル

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

Performance Advisor

データベース配置に推奨されているインデックスと低速クエリ データを返します。また、MongoDB Cloud が管理する低速操作しきい値の有効／無効を切り替えます。サンプル クエリでフィールド値を表示するには、プロジェクトデータへのアクセスについて読み取り専用以上のロール以上が必要です。それ以外の場合、MongoDB Cloud はフィールド値ではなくリダクションされたデータを返します。

管理された低速操作しきい値を無効にする

指定したプロジェクトに対して MongoDB Cloud で計算された低速操作のしきい値を無効にします。このしきい値により、Performance Advisorとクエリプロファイラーでどの操作が低速と判断されるかが決まります。有効にすると、MongoDB Cloud では、クラスターでの操作の平均実行時間を元に、実行中のクエリが低速であるかどうかが判断されます。結果、しきい値はクラスターのワークロードに合ったものになります。専有クラスター（M10 以上）では、低速操作しきい値はデフォルトで有効になっています。無効にした場合、MongoDB Cloud では 100 ミリ秒以上かかる操作がすべて低速と見なされます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
{
  • "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 が指定されたプロジェクトに対して低速操作しきい値を適用できるようにします。このしきい値により、Performance Advisorとクエリプロファイラーでどの操作が低速と判断されるかが決まります。有効にすると、MongoDB Cloud では、クラスターでの操作の平均実行時間を元に、実行中のクエリが低速であるかどうかが判断されます。結果、しきい値はクラスターのワークロードに合ったものになります。専有クラスター（M10 以上）では、低速操作しきい値はデフォルトで有効になっています。無効にした場合、MongoDB Cloud では 100 ミリ秒以上かかる操作がすべて低速と見なされます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
{
  • "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 つのホストのすべての名前空間を返す

指定されたホスト上でクエリが低速になっているコレクションの名前空間を最大 20 件返します。データベースの読み取り操作を受信したことがないレプリカセットのセカンダリノードを指定した場合、エンドポイントは名前空間を返しません。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

MongoDB プロセスを提供するホストとポートの組み合わせ。ホストは、MongoDB プロセス（mongodまたはmongos）を実行するホストのホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスである必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

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

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

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

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

duration
integer <int64>

クエリがクラスター内の管理対象名前空間から推奨インデックスを検索する時間の長さ。このパラメータは、その値をミリ秒単位で表します。

  • sinceパラメーターを指定しない場合、エンドポイントは現在の時刻より前の期間に該当するデータを返します。
  • durationパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去 24 時間のデータを返します。
以来
integer <int64> >= 1199145600000

クエリが推奨インデックスを取得する日時。このパラメータは、 UNIXエポックから経過したミリ秒数で値を表します。

  • durationパラメーターを指定しない場合、エンドポイントはsince値から現在の時刻までのデータを返します。
  • durationパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去 24 時間のデータを返します。

応答

応答サンプル

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

低速クエリを返す

Performance Advisorとクエリプロファイラーが特定した低速クエリのログ行を返します。Performance Advisor は MongoDB が遅いと判断したクエリをモニターし、クエリ パフォーマンスを改善するための新しいインデックスを提案します。MongoDB Cloud では、クラスターでの平均操作時間に基づいて低速クエリのしきい値が決定されます。これにより、ワークロードに適した推奨が可能になります。このリソースを使用するには、リクエスト元の API キーにプロジェクトのデータアクセスに関する読み取りおよび書込みロールが必要です。

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

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

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

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

MongoDB プロセスを提供するホストとポートの組み合わせ。ホストは、MongoDB プロセス（mongodまたはmongos）を実行するホストのホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスである必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

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

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

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

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

duration
integer <int64>

クラスター内の管理対象名前空間内で、クエリが低速クエリと判断されるまでの時間の長さ。このパラメータは、その値をミリ秒単位で表します。

  • sinceパラメーターを指定しない場合、エンドポイントは現在の時刻より前の期間に該当するデータを返します。
  • durationパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去 24 時間のデータを返します。
名前空間
の配列 string

低速クエリを取得する名前空間。名前空間は 1 件のデータベースと 1 件のコレクション リソースで構成され、.: <database>.<collection> と記述されます。複数の名前空間を含めるには、各名前空間の間をアンパサンド (&) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、すべての名前空間の結果が返されます。

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

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

以来
integer <int64> >= 1199145600000

クエリが低速クエリを検索する日時。このパラメータは、 UNIXエポックから経過したミリ秒数で値を表します。

  • durationパラメーターを指定しない場合、エンドポイントはsince値から現在の時刻までのデータを返します。
  • durationパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去 24 時間のデータを返します。

応答

応答サンプル

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

推奨インデックスを返す

Performance Advisor が提案するインデックスを返します。Performance Advisor は MongoDB が遅いと判断したクエリをモニターし、クエリ パフォーマンスを改善するための新しいインデックスを提案します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

processId
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

MongoDB プロセスを提供するホストとポートの組み合わせ。ホストは、MongoDB プロセス（mongodまたはmongos）を実行するホストのホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスである必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。

クエリ パラメータ
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 形式にするかどうかを示すフラグ。

duration
integer <int64>

クエリがクラスター内の管理対象名前空間から推奨インデックスを検索する時間の長さ。このパラメータは、その値をミリ秒単位で表します。

  • sinceパラメーターを指定しない場合、エンドポイントは現在の時刻より前の期間に該当するデータを返します。
  • durationパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去 24 時間のデータを返します。
名前空間
の配列 string

推奨されたインデックスを検索する名前空間。名前空間は 1 件のデータベースと 1 件のコレクション リソースで構成され、.: <database>.<collection> と記述されます。複数の名前空間を含めるには、各名前空間の間をアンパサンド (&) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、すべての名前空間の結果が返されます。

nExamples
integer <int64>
デフォルト: 5

推奨インデックスの恩恵を受けるクエリ例の最大数。

nIndexes
integer <int64>

推奨するインデックスの最大数を示す数値。

以来
integer <int64> >= 1199145600000

クエリが推奨インデックスを取得する日時。このパラメータは、 UNIXエポックから経過したミリ秒数で値を表します。

  • durationパラメーターを指定しない場合、エンドポイントはsince値から現在の時刻までのデータを返します。
  • durationパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去 24 時間のデータを返します。

応答

応答サンプル

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

プライベートエンドポイント サービス

プライベートエンドポイントを返し、追加、編集、削除を行います。

1 つのプロバイダーの 1 つのプライベートエンドポイント サービスを作成

指定されたクラウド サービス プロバイダーのプライベートエンドポイント サービスを 1 つ作成します。このクラウド サービス プロバイダーは、プロジェクトのプライベートエンドポイント サービスを管理します。プライベートエンドポイント サービスを作成すると、MongoDB Cloud は、プライベートエンドポイント サービスを作成するクラウドプロバイダーのプロジェクトにネットワーク コンテナを作成します（未作成の場合）。MongoDB Cloud のプライベートエンドポイントの用語の詳細については、「プライベートエンドポイントの概念」を参照してください。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

プライベートエンドポイントの概念
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
列挙: "AWS" "AZURE" "GCP"

プライベートエンドポイント サービス作成先のクラウド サービス プロバイダーを識別する、人間が判読可能なラベル。

リージョン
必須
string

プライベートエンドポイント サービスを作成するクラウド・プロバイダーのリージョン。値として受け入れられるリージョンは、 Amazon Web Services、Google Cloud Platform、Microsoft Azure でそれぞれ異なります。

応答

リクエスト サンプル

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

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "cloudProvider": "AWS",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "interfaceEndpoints": [
    ],
  • "regionName": "string",
  • "status": "INITIATING"
}

リージョン化されたプライベートエンドポイントのステータスを返す

指定されたクラウド サービス プロバイダーの各リージョンについて、1 つのリージョンに複数のプライベートエンドポイントを作成できるかどうかを確認します。クラウド サービス プロバイダーがプロジェクトのプライベートエンドポイントを管理します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
}

リージョン化されたプライベートエンドポイントのステータスを切り替える

1 つのプロジェクトのすべてのクラウドサービスプロバイダーで、1 つのリージョンにつき複数のプライベートエンドポイントを作成できる機能を有効または無効にします。クラウド サービス プロバイダーがプロジェクトのプライベートエンドポイントを管理します。この設定を有効にすると、既存のマルチリージョンおよびグローバルのシャーディングされたクラスターへの接続文字列が変更されます。新しい接続文字列を使用するには、アプリケーションをアップデートする必要があります。これにより、ダウンタイムが発生する可能性があります。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールがあり、配置内のすべてのクラスターがシャーディングされたクラスターである必要があります。有効にすると、レプリカセットは作成できなくなります。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 つのリージョンにつき複数のプライベートエンドポイントを作成できる機能を有効または無効にします。

enabled
必須
ブール値

指定されたプロジェクトで、リージョン化されたプライベートエンドポイント設定が有効にされているかどうかを示すフラグ。

  • リージョン化されたプライベート エンドポイントを有効にするには、この値をtrueに設定します。これにより、1 つのクラウドプロバイダー リージョンに複数のプライベート エンドポイントを作成できます。マルチリージョンおよびグローバルのシャーディングされたMongoDB Cloud クラスターに接続するには、この設定を有効にする必要があります。リージョン化されたプライベート エンドポイントを有効にすると、次の制限が発生します。

    • アプリケーションでは、既存のマルチリージョンおよびグローバルのシャーディングされたクラスターに新しい接続文字列を使用する必要があります。これにより、ダウンタイムが発生する可能性があります。

    • MongoDB Cloud プロジェクトにレプリカ セットを含めることはできません。また、このプロジェクトに新しいレプリカセットを作成することもできません。

    • 次の場合は、この設定を無効にすることはできません。

      • 複数のリージョンに複数のプライベートエンドポイント
      • 1 つのリージョンに複数のプライベートエンドポイントがあり、1 つ以上のリージョンに 1 つのプライベートエンドポイントがあります。

  • リージョン化されたプライベートエンドポイントを無効にするには、この値をfalseに設定します。

応答

リクエスト サンプル

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

応答サンプル

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

1 つのプロバイダーのすべてのプライベートエンドポイント サービスを返す

指定されたクラウド サービス プロバイダーのすべてのプライベートエンドポイント サービスの名前、インターフェイス、状態を返します。このクラウド サービス プロバイダーは、プロジェクトのプライベートエンドポイント サービスを管理します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

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

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

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

cloudProvider
必須
string
デフォルト: "AWS"
列挙: "AWS" "AZURE" "GCP"

このプライベートエンドポイント サービスを管理するクラウド サービス プロバイダー。

クエリ パラメータ
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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

cloudProvider
必須
string
デフォルト: "AWS"
列挙: "AWS" "AZURE" "GCP"

このプライベートエンドポイント サービスを管理するクラウド サービス プロバイダー。

endpointServiceId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

cloudProvider
必須
string
デフォルト: "AWS"
列挙: "AWS" "AZURE" "GCP"

このプライベートエンドポイント サービスを管理するクラウド サービス プロバイダー。

endpointServiceId
必須
string = 24文字 ^([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",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "interfaceEndpoints": [
    ],
  • "regionName": "string",
  • "status": "INITIATING"
}

1 つのプロバイダーの 1 つのプライベートエンドポイントを作成

指定されたクラウド サービス プロバイダーにプライベートエンドポイントを 1 件作成します。このクラウド サービス プロバイダーはプライベートエンドポイントサービスを管理します。そのため、プロジェクトのプライベートエンドポイントもこのプロバイダーが管理することになります。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。考慮事項、制限事項、前提条件の詳細については、プライベートエンドポイントの設定に関する MongoDB のドキュメントを参照してください。

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

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

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

cloudProvider
必須
string
デフォルト: "AWS"
列挙: "AWS" "AZURE" "GCP"

このプライベートエンドポイントを管理するクラウド サービス プロバイダー。

endpointServiceId
必須
string = 24文字 ^([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 件作成します。

One of
オブジェクト Amazon Web Services Recursive

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "id": "vpce-3bf78b0ddee411ba1"
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "cloudProvider": "AWS",
  • "connectionStatus": "PENDING_ACCEPTANCE",
  • "deleteRequested": true,
  • "errorMessage": "string",
  • "interfaceEndpointId": "32b6e34b3d91647abb20e7b8"
}

1 つのプロバイダーの 1 つのプライベートエンドポイントを削除

指定されたクラウドサービスプロバイダーによって管理されている、指定されたプロジェクトとプライベートエンドポイントサービスから 1 つのプライベートエンドポイントを削除します。最後のプライベートエンドポイントが特定のプライベートエンドポイントサービスから削除されると、そのプライベートエンドポイントサービス自体も削除されます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

cloudProvider
必須
string
デフォルト: "AWS"
列挙: "AWS" "AZURE" "GCP"

このプライベートエンドポイントを管理するクラウド サービス プロバイダー。

endpointId
必須
string^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF]...

削除したいプライベートエンドポイントを識別するユニークな文字列。endpointIdパラメータの形式は、AWS と Azure で異なります。Azure プライベートエンドポイントでは、endpointIdを URL エンコードする必要があります。

endpointServiceId
必須
string = 24文字 ^([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 = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

cloudProvider
必須
string
デフォルト: "AWS"
列挙: "AWS" "AZURE" "GCP"

このプライベートエンドポイントを管理するクラウド サービス プロバイダー。

endpointId
必須
string^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF]...

返したいプライベートエンドポイントを識別するユニークな文字列。endpointIdパラメータの形式は、AWS と Azure で異なります。Azure プライベートエンドポイントでは、endpointIdを URL エンコードする必要があります。

endpointServiceId
必須
string = 24文字 ^([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",
  • "connectionStatus": "PENDING_ACCEPTANCE",
  • "deleteRequested": true,
  • "errorMessage": "string",
  • "interfaceEndpointId": "32b6e34b3d91647abb20e7b8"
}

プログラム API キー

MongoDB Cloud API を使用するためのアクセストークンの返却、追加、編集、削除を行います。MongoDB Cloud はこれらのキーを組織に適用します。これらのリソースによって、指定されたプロジェクト内でキーを返却したり、割り当てたり、取り消したりすることができます。

1 つのプロジェクトに割り当てられたすべての組織の API キーを返す

指定したプロジェクトに割り当てたすべての組織 API キーを返します。API キーに関連付けられたプロジェクトのプロジェクト オーナーのロールを持つユーザーは、組織のAPIキーを使用してリソースにアクセスできます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

プログラム API キー
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 つの組織 API キーを作成・割り当て

指定された組織 API キーを作成し、指定されたプロジェクトに割り当てます。API キーに関連付けられたプロジェクトのプロジェクト オーナーのロールを持つユーザーは、組織のAPIキーを使用してリソースにアクセスできます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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

指定されたプロジェクトに作成され割り当てられる組織 API キー。

desc
必須
string [ 1 .. 250 ] 文字

このプロジェクト API キーの作成時に入力された目的または説明。

役割
必須
の配列 string non-empty
アイテム列挙: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" "GROUP_ATLAS_ADMIN" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER"

この API キーを付与するロールの一覧。このリストを提供する場合は、少なくとも 1 つのロールを指定し、各ロールがこのプロジェクトに適用されることを確認してください。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "desc": "string",
  • "roles": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

1 つのプロジェクトで 1 つの組織 API キーの割り当てを解除

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

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

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

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

apiUserId
必須
string = 24文字 ^([a-f0-9]{24})$

1 件のプロジェクトから割り当てを解除したい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。

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

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

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

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

応答

応答サンプル

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

1 つのプロジェクトに対する 1 つの組織 API キーのロールを更新

指定したプロジェクトに対して指定した組織 API キーのロールを更新します。プロジェクトには少なくとも 1 つの有効なロールを指定する必要があります。プロジェクトで指定した組織 API キーで過去に設定された、このリクエストに含まれないロールはすべて削除されます。

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

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

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

apiUserId
必須
string = 24文字 ^([a-f0-9]{24})$

1 件のプロジェクトから割り当てを解除したい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
pageNum
integer >= 1
デフォルト: 1
例: pageNum=1

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

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

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

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

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

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

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

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

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

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

更新する組織の API キー。このリクエストには、少なくとも 2 つの本体パラメータのうち 1 つが必要です。

desc
string [ 1 .. 250 ] 文字

このプロジェクト API キーの作成時に入力された目的または説明。

役割
の配列 string
アイテム列挙: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" "GROUP_ATLAS_ADMIN" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER"

この API キーを付与するロールの一覧。このリストを提供する場合は、少なくとも 1 つのロールを指定し、各ロールがこのプロジェクトに適用されることを確認してください。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "desc": "string",
  • "roles": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

1 つのプロジェクトに 1 つの組織の API キーを割り当て

指定された組織 API キーを作成し、指定されたプロジェクトに割り当てます。API キーに関連付けられたプロジェクトのプロジェクト オーナーのロールを持つユーザーは、組織のAPIキーを使用してリソースにアクセスできます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

apiUserId
必須
string = 24文字 ^([a-f0-9]{24})$

1 件のプロジェクトに割り当てたい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。

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

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

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

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

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

指定したプロジェクトに割り当てる組織の API キー。

配列
役割
の配列 string
アイテム列挙: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER" "GROUP_OWNER" "GROUP_READ_ONLY"

この API キーを付与するロールの一覧。このリストを提供する場合は、少なくとも 1 つのロールを指定し、各ロールがこのプロジェクトに適用されることを確認してください。

応答

リクエスト サンプル

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

応答サンプル

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

すべての組織 API キーを返す

指定した組織のすべての組織 API キーを返します。 組織 API キーは、組織へのプログラムによるアクセスを許可します。 API キーを使用してコンソール経由で MongoDB クラウドにログインすることはできません。このリソースを使用するには、リクエスト元のAPIキーに組織メンバーロールが必要です。

プログラム API キー
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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 形式にするかどうかを示すフラグ。

応答

応答サンプル

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

1 つの組織 API キーを作成

指定された組織に対して 1 つの API キーを作成します。 組織 API キーは、組織へのプログラムによるアクセスを許可します。 API キーを使用してコンソールにログインすることはできません。 このリソースを使用するには、要求する API キーに組織所有者のロールが必要です。

プログラム API キー
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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

作成する組織 API キー。

desc
必須
string [ 1 .. 250 ] 文字

このプロジェクト API キーの作成時に入力された目的または説明。

役割
必須
の配列 string non-empty
アイテム列挙: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN"

この API キーを付与するロールの一覧。このリストを提供する場合は、少なくとも 1 件のロールを指定し、各ロールがこのプロジェクトに適用されることを確認してください。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "desc": "string",
  • "roles": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

1 つの組織 API キーを削除

指定された組織から 1 つの組織 API キーを削除します。 組織から API キーを削除すると、MongoDB Cloud は、そのキーを使用するすべてのプロジェクトからそのキーも削除します。 このリソースを使用するには、リクエストする API キーに組織所有者のロールが必要です。

Atlas API Access の設定
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

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

apiUserId
必須
string = 24文字 ^([a-f0-9]{24})$

この組織の API キーを識別する、ユニークな 24 桁の 16 進数の文字列。

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

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

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

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

応答

応答サンプル

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

1 つの組織 API キーを返す

1 つの組織の API キーを返します。 組織 API キーは、組織へのプログラムによるアクセスを許可します。 API キーを使用して、ユーザー インターフェイスから MongoDB Cloud にログインすることはできません。 このリソースを使用するには、要求する API キーに組織メンバーのロールが必要です。

プログラム API キー
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

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

apiUserId
必須
string = 24文字 ^([a-f0-9]{24})$

更新したい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

1 つの組織の API キーを更新

指定した組織の 1 つの組織 API キーを更新します。 組織 API キーは、組織へのプログラムによるアクセスを許可します。 このリソースを使用するには、リクエストする API キーに組織所有者のロールが必要です。

プログラム API キー
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

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

apiUserId
必須
string = 24文字 ^([a-f0-9]{24})$

更新したい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。

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

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

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

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

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

更新する組織の API キー。このリクエストには、少なくとも 2 つの本体パラメータのうち 1 つが必要です。

desc
string [ 1 .. 250 ] 文字

このプロジェクト API キーの作成時に入力された目的または説明。

役割
の配列 string
アイテム列挙: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN"

この API キーを付与するロールの一覧。このリストを提供する場合は、少なくとも 1 件のロールを指定し、各ロールがこのプロジェクトに適用されることを確認してください。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "desc": "string",
  • "roles": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

1 つの組織 API キーのすべてのアクセス リスト エントリを返す

指定した組織の API キーに設定したすべてのアクセスリストエントリを返します。 このリソースを使用するには、リクエスト元のAPIキーに組織メンバーロールが必要です。

プログラム API キー
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

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

apiUserId
必須
string = 24文字 ^([a-f0-9]{24})$

アクセス リスト エントリを返したい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
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 つの組織 API キーのアクセス リスト エントリを作成

指定された組織 API キーのアクセス リスト エントリを作成します。リソースでは、すべての API リクエストが API アクセスリストの IP アドレスから送信される必要があります。このリソースを使用するには、リクエスト元の API キーに読み取り・書き込みロールが必要です。

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

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

apiUserId
必須
string = 24文字 ^([a-f0-9]{24})$

新しいアクセス リスト エントリを作成したい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
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

指定された組織 API キーに対して作成されるアクセス リスト エントリ。

配列
cidrBlock
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a...

API キーのアクセス リストに追加するネットワークアドレスの範囲。このパラメータでは、範囲をインターネット プロトコル バージョン 4 またはバージョン 6 アドレスのクラスレス ドメイン間ルーティング (CIDR) 表記で表現する必要があります。このパラメータに値を設定することも、ipAddressに値を設定することもできますが、同じリクエストで両方を設定することはできません。

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

API キーのアクセス リストに追加したいネットワーク アドレスの範囲。このパラメータでは、アドレスを 1 つのインターネット プロトコル バージョン 4 またはバージョン 6 のアドレスとして表現する必要があります。このパラメータに値を設定することも、cidrBlockに値を設定することもできますが、同じリクエストで両方を設定することはできません。

応答

リクエスト サンプル

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

応答サンプル

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

1 つの組織 API キーの 1 つのアクセス リスト エントリを削除

指定された組織 API キーから指定されたアクセス リスト エントリを削除します。リソースでは、すべての API リクエストが API アクセスリストの IP アドレスから送信される必要があります。このリソースを使用するには、リクエスト元の API キーに読み取り・書き込みロールが必要です。また、リクエスト元の組織の API キーからリクエスト元の IP アドレスを削除することはできません。

Atlas API Access の設定
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

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

apiUserId
必須
string = 24文字 ^([a-f0-9]{24})$

アクセス リスト エントリを除きたい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。

ipAddress
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
例: 192.0.2.0%2F24

1 件の IP アドレスまたは複数の IP アドレスを 1 つの CIDR ブロックとして表し、指定した組織内の API リソースへの要求を制限します。192.0.2.0/24 などのサブネット マスクを含む CIDR ブロックを追加する場合は、スラッシュ / の代わりに URL エンコードされた値 %2F を使用します。

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

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

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

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

応答

応答サンプル

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

1 つの組織 API キーの 1 つのアクセス リスト エントリを返す

指定された組織 API キーのアクセス リスト エントリを 1 つ返します。 リソースには、すべての API リクエストが API アクセスリストの IP アドレスから送信される必要があります。 このリソースを使用するには、要求する API キーに組織メンバーのロールが必要です。

Atlas API Access の設定
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

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

ipAddress
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
例: 192.0.2.0%2F24

1 件の IP アドレスまたは複数の IP アドレスを 1 つの CIDR ブロックとして表し、指定した組織内の API リソースへの要求を制限します。192.0.2.0/24 などのサブネット マスクを含む CIDR ブロックを追加する場合は、スラッシュ / の代わりに URL エンコードされた値 %2F を使用します。

apiUserId
必須
string = 24文字 ^([a-f0-9]{24})$

アクセス リスト エントリを返したい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "cidrBlock": "203.0.113.0/24",
  • "count": 1,
  • "created": "2019-08-24T14:15:22Z",
  • "ipAddress": "203.0.113.10",
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "lastUsedAddress": "203.0.113.10",
  • "links": []
}

プロジェクト IP アクセス リスト

Atlas 内のデータベース配置へのネットワークアクセス制限を返したり、追加、編集、削除したりします。このリソースはホワイトリスト リソースを置き換えます。Atlas は 2021 年 7 月にホワイトリストを削除しました。この新しいリソースを使用するには、アプリケーションを更新してください。このリソースは、プロジェクトの IP アクセスリストを管理し、7 日以内（ユーザー側で指定可能）に自動的に期限切れとなる一時的なアクセス リスト エントリの作成をサポートします。

プロジェクトの IP アクセス リストを返す

指定されたプロジェクトの IP アクセス リストからすべてのアクセス リスト エントリを返します。プロジェクトの IP アクセス リストの各エントリには、1 つの IP アドレスまたは 1 つの CIDR 表記の IP アドレス ブロックが含まれます。MongoDB Cloud は、プロジェクトの IP アクセス リストのエントリからのみクラスタへのクライアント接続を許可します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト Charts 管理者ロールが必要です。このリソースはホワイトリスト リソースを置き換えます。MongoDB Cloud は 2021 年 7 月にホワイトリストを削除しました。この新しいリソースを使用するには、アプリケーションを更新してください。/groups/{GROUP-ID}/accessListエンドポイントはデータベース IP アクセス リストを管理します。このエンドポイントは、MongoDB Cloud 組織のアクセス リストを管理するorgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslistエンドポイントとは異なります。

IP アクセス リスト
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
{}

プロジェクトの IP アクセス リストへのエントリを追加

指定されたプロジェクトに 1 つ以上のアクセス リスト エントリを追加します。MongoDB Cloud は、プロジェクトの IP アクセス リストのエントリからのみクラスタへのクライアント接続を許可します。各エントリは 1 つの IP アドレス、または CIDR で記述された IP アドレスの1件のブロックとして書き込みます。このリソースを使用するには、リクエスト元の API キーにプロジェクトオーナーまたはプロジェクト Charts 管理者ロールが必要です。このリソースはホワイトリスト リソースを置き換えます。MongoDB Cloud は 2021 年 7 月にホワイトリストを削除しました。この新しいリソースを使用するには、アプリケーションを更新してください。/groups/{GROUP-ID}/accessListエンドポイントはデータベース IP アクセス リストを管理します。このエンドポイントは、MongoDB Cloud 組織のアクセス リストを管理するorgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslistエンドポイントとは異なります。このエンドポイントは同時POSTリクエストをサポートしていません。複数のPOSTリクエストを同期させて送信する必要があります。

IP アクセス リスト
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 つ以上のアクセス リスト エントリ。

配列
awsSecurityGroup
string^([0-9]*/)?sg-([0-9]*)

プロジェクトの IP アクセス リストに追加する Amazon Web Services (AWS) セキュリティグループのユニークな文字列。IP アクセス リスト エントリは、1 つの awsSecurityGroup、1 つの cidrBlock、または 1 つの ipAddress のいずれかになります。AWS セキュリティグループを IP アクセスリストに追加する前に、プロジェクトの仮想プライベート接続 (VPC) ピアリングを設定する必要があります。AWS セキュリティグループを一時的なアクセスリスト エントリとして設定することはできません。cidrBlock または ipAddress を設定する場合は、このパラメータを設定しないでください。

cidrBlock
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...

プロジェクトの IP アクセス リストに追加する、クラスレス ドメイン間ルーティング (CIDR) 表記の IP アドレスの範囲。IP アクセス リスト エントリは、1 つの awsSecurityGroup、1 つの cidrBlock、または 1 つの ipAddress のいずれかになります。awsSecurityGroup または ipAddress を設定する場合は、このパラメータを設定しないでください。

comment
string <= 80 文字

この IP アクセス リスト エントリの目的または範囲を説明するコメント。

deleteAfterDate
string <date-time>

MongoDB Cloud が一時アクセスリスト エントリを削除する日時。このパラメーターは、その値を ISO 8601 タイムスタンプ形式で UTC で表し、タイム ゾーンの指定を含めることができます。日付は現在の日付より後で、このリクエストの送信から 1 週間以内である必要があります。この IP アクセス リスト エントリの作成時に有効期限を指定した場合、リソースはこのパラメータを返します。

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

プロジェクトの IP アクセス リストに追加する IP アドレス。IP アクセス リスト エントリは、1 つの awsSecurityGroup、1 つの cidrBlock、または 1 つの ipAddress のいずれかになります。awsSecurityGroup または cidrBlock を設定する場合は、このパラメータを設定しないでください。

応答

リクエスト サンプル

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

応答サンプル

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

1 つのプロジェクト IP アクセス リストから 1 つのエントリを削除

指定されたプロジェクトの IP アクセス リストから 1 件のアクセス リスト エントリを削除します。プロジェクトの IP アクセス リストの各エントリには、1 つの IP アドレス、1 つの CIDR で記述された IP アドレスのブロック、または 1 つの AWS グループ ID が含まれています。MongoDB Cloud は、プロジェクトの IP アクセス リストのエントリからのみクラスタへのクライアント接続を許可します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。このリソースはホワイトリスト リソースを置き換えます。MongoDB Cloud は 2021 年 7 月にホワイトリストを削除しました。 この新しいリソースを使用するには、アプリケーションを更新してください。/groups/{GROUP-ID}/accessListエンドポイントはデータベース IP アクセス リストを管理します。 このエンドポイントは、MongoDB Cloud 組織のアクセス リストを管理するorgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslistエンドポイントとは異なります。

IP アクセス リスト
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

entryValue
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
例: IPv4: 192.0.2.0%2F24 またｈ IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 または IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8

プロジェクトの IP アクセス リストから削除するアクセス リスト エントリ。この値では、1 つの AWS セキュリティグループ ID、1 つの IP アドレス、または 1 つのアドレスの CIDR ブロックのいずれかを使用できます。サブネット マスクを使用する CIDR ブロックの場合は、スラッシュ（/）を URL エンコードされた値（%2F）に置き換えます。IP アクセス リストからエントリを削除すした際、削除したアドレスからの既存の接続が一定時間開いたままになる場合があります。MongoDB Cloud によって接続が閉じられるまでにかかる時間は、次のようないくつかの要因によって異なります。

  • アプリケーションが接続を確立した方法
  • MongoDB Cloud またはアドレスを使用するドライバーの動作、および
  • 接続で使用されるプロトコル（TCP または UDP など）。
クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

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

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

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

応答

応答サンプル

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

1 つのプロジェクト IP アクセス リストを返す

指定されたプロジェクトの IP アクセス リストから 1 件のアクセス リスト エントリを返却します。プロジェクトの IP アクセス リストの各エントリには、1 つの IP アドレスまたは 1 つの CIDR 表記の IP アドレス ブロックが含まれます。MongoDB Cloud は、プロジェクトの IP アクセス リストのエントリからのみクラスタへのクライアント接続を許可します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト Charts 管理者ロールが必要です。このリソースはホワイトリスト リソースを置き換えます。MongoDB Cloud は 2021 年 7 月にホワイトリストを削除しました。この新しいリソースを使用するには、アプリケーションを更新してください。このエンドポイント（/groups/{GROUP-ID}/accessList）は、プロジェクトの IP アクセス リストを管理します。MongoDB Cloud 組織のアクセス リストは管理されません。これらはプログラマティック API キー エンドポイント（/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist）によって管理されます。

IP アクセス リスト
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

entryValue
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
例: IPv4: 192.0.2.0%2F24 またｈ IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 または IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8

プロジェクトの IP アクセスリストから返却したいアクセス リスト エントリ。この値では、1 つの AWS セキュリティグループ ID、1 つの IP アドレス、または 1 つのアドレスの CIDR ブロックのいずれかを使用できます。サブネット マスクを使用する CIDR ブロックの場合は、スラッシュ（/）を URL エンコードされた値（%2F）に置き換えます。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "awsSecurityGroup": "string",
  • "cidrBlock": "string",
  • "comment": "string",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "ipAddress": "string",
  • "links": []
}

1 つのプロジェクト IP アクセス リスト エントリのステータスを返す

1 つのプロジェクトの IP アクセス リスト エントリのステータスを返します。このリソースは、指定されたプロジェクトの IP アクセス リストのエントリが、指定されたプロジェクトのクラスターにサービスを提供しているすべてのクラウドプロバイダーに該当するかどうかを確認します。

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

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

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

entryValue
必須
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
例: IPv4: 192.0.2.0%2F24 またｈ IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 または IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8

どのプロジェクトのアクセス リスト エントリを検証するのかを識別する、ネットワーク アドレスまたはクラウド プロバイダーのセキュリティ構造。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "STATUS": "PENDING"
}

プロジェクト

MongoDB Cloud 内のクラスターとユーザーのコレクションを返したり、追加したり、編集したりします。

すべてのプロジェクトを返す

すべてのプロジェクトの詳細を返します。プロジェクトは、アプリケーション環境、ワークロード、またはその両方をサポートする論理コレクションにクラスターをグループ化します。各プロジェクトには、独自のユーザー、チーム、セキュリティ、タグ、アラート設定を設定できます。このリソースを使用するには、リクエスト元の 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 つ作成

プロジェクトを 1 つ作成します。プロジェクトは、アプリケーション環境、ワークロード、またはその両方をサポートする論理コレクションにクラスターをグループ化します。各プロジェクトには、独自のユーザー、チーム、セキュリティ、タグ、アラート設定を設定できます。このリソースを使用するには、要求する API キーに読み取り書き込みロールが必要です。

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

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

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

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

projectOwnerId
string = 24文字 ^([a-f0-9]{24})$

指定したプロジェクト上で、プロジェクト所有者ロールを付与するMongoDB Cloud ユーザーを識別する、ユニークな 24 桁の 16 進数の文字列。このパラメータを設定すると、最も古い組織オーナーのデフォルト値が上書きされます。

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

プロジェクトを 1 つ作成します。

name
必須
string [ 1 .. 64 ] 文字 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

MongoDB Cloud の組織に含まれるプロジェクトを識別する、人間が判読可能なラベル。

orgId
必須
string = 24文字 ^([a-f0-9]{24})$

プロジェクトが属する MongoDB クラウド組織を識別する、ユニークな 24 桁の 16 進数文字列。

regionUsageRestrictions
string
デフォルト: "COMMERCIAL_FEDRAMP_REGIONS_ONLY"
列挙: "COMMERCIAL_FEDRAMP_REGIONS_ONLY" "GOV_REGIONS_ONLY"

政府の Atlas にのみ適用されます。

商用 Atlas では、このフィールドはリクエストで拒否され、応答が欠落します。

このフィールドは、プロジェクトで利用可能なリージョンの制限を設定します。

値 利用可能なリージョン
COMMERCIAL_FEDRAMP_REGIONS_ONLY FedRAMP Moderate リージョンでの配置のみを許可します。
GOV_REGIONS_ONLY GovCloud リージョンでの配置のみを許可します。
https://www.mongodb.com/ja-jp/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions
の配列 オブジェクト (Resource Tag)

プロジェクトのタグ付けと分類に使用する、長さが 1 ～ 255 文字のキーと値のペアを含むリスト。

Resource Tags
withDefaultAlertsSettings
ブール値

デフォルトのアラート設定でプロジェクトを作成するかどうかを示すフラグ。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ],
  • "withDefaultAlertsSettings": true
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

プロジェクトの名前を使用して 1 つのプロジェクトを返す

指定したプロジェクトの詳細を返します。プロジェクトは、アプリケーション環境、ワークロード、またはその両方をサポートする論理コレクションにクラスターをグループ化します。各プロジェクトには、独自のユーザー、チーム、セキュリティ、タグ、アラート設定を設定できます。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
groupName
必須
string [ 1 .. 64 ] 文字

このプロジェクトを識別する、人間に判読可能なラベル。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

1 つのプロジェクトを削除

指定したプロジェクトを削除します。プロジェクトは、アプリケーション環境、ワークロード、またはその両方をサポートする論理コレクションにクラスターをグループ化します。各プロジェクトには、独自のユーザー、チーム、セキュリティ、タグ、アラート設定を設定できます。プロジェクトを削除できるのは、プロジェクト内のクラスターのオンラインアーカイブがない場合のみです。このリソースを使用するには、要求する API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 つのプロジェクトを返す

指定したプロジェクトの詳細を返します。プロジェクトは、アプリケーション環境、ワークロード、またはその両方をサポートする論理コレクションにクラスターをグループ化します。各プロジェクトには、独自のユーザー、チーム、セキュリティ、タグ、アラート設定を設定できます。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

1 つのプロジェクトを更新

指定されたプロジェクトを識別する、人間が判読可能なラベル、またはプロジェクトに関連付けられたタグを更新します。 このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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

MongoDB Cloud の組織に含まれるプロジェクトを識別する、人間が判読可能なラベル。

の配列 オブジェクト (Resource Tag)

プロジェクトのタグ付けと分類に使用する、長さが 1 ～ 255 文字のキーと値のペアを含むリスト。

Resource Tags

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "name": "string",
  • "tags": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

すべてのプロジェクトの招待を返す

指定したプロジェクトに対するすべての保留中の招待を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 形式にするかどうかを示すフラグ。

username
string <email>

このプロジェクトに招待されたユーザーアカウントのメールアドレス。

応答

応答サンプル

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

1 つのプロジェクト招待を更新する

指定したプロジェクトに対する保留中の招待 1 件の詳細を更新します。更新する招待を指定するには、招待されたユーザーのユーザー名を入力します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 件の詳細を更新します。

役割
の配列 string unique
アイテム列挙: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud ユーザーに割り当てる 1 件以上のプロジェクト レベルのロール。

username
string <email>

指定されたプロジェクトに招待された MongoDB Cloud ユーザーの電子メール アドレス。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

1 人の MongoDB Cloud ユーザーを 1 つのプロジェクトに招待

MongoDB Cloud ユーザー 1 件に対して、指定されたプロジェクトへの参加を招待します。指定されたプロジェクト内の情報にアクセスするには、MongoDB Cloud ユーザーは招待を承諾する必要があります。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

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

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

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

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

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

MongoDB Cloud ユーザー 1 件に対して、指定されたプロジェクトへの参加を招待します。

役割
の配列 string unique
アイテム列挙: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud ユーザーに割り当てる 1 件以上のプロジェクト レベルのロール。

username
string <email>

指定されたプロジェクトに招待された MongoDB Cloud ユーザーの電子メール アドレス。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

1 つのプロジェクトの招待をキャンセル

指定した MongoDB Cloud ユーザーに送信され、保留中となっているプロジェクトへの参加招待 1 件をキャンセルします。ユーザーが承諾した招待をキャンセルすることはできません。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

招待ID
必須
string = 24文字 ^([a-f0-9]{24})$

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

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

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

応答

応答サンプル

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

1 つのプロジェクトの招待を返す

指定されたプロジェクトへの保留中の招待1件を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

招待ID
必須
string = 24文字 ^([a-f0-9]{24})$

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

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

招待IDによる1つのプロジェクト招待の更新

指定したプロジェクトに対する保留中の招待 1 件の詳細を更新します。更新する招待を指定するには、その招待のユニークな識別文字列を入力します。プロジェクトに対するすべての保留中の招待の ID を取得するには、「すべてのプロジェクトの招待状を返す」エンドポイントを使用します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

招待ID
必須
string = 24文字 ^([a-f0-9]{24})$

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

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

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

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

指定したプロジェクトに対する保留中の招待 1 件の詳細を更新します。

役割
の配列 string unique
アイテム列挙: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud ユーザーに割り当てる 1 件以上の組織またはプロジェクト レベルのロール。

応答

リクエスト サンプル

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

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

1 つのプロジェクトのすべての制限を返す

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

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 つのプロジェクト制限を削除

指定したプロジェクトの制限を削除します。制限に応じて、Atlas は制限をデフォルト値にリセットするか、制限を完全に削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
limitName
必須
string
列挙: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask" "atlas.project.deployment.salesSoldM0s"

このプロジェクトの制限を識別する、人間に判読可能なラベル。

制限名 説明 default API オーバーライド制限
atlas.project.deployment.clusters org が sales-sold ではない場合の、このプロジェクトのクラスター数の上限（org が sales-sold の場合、制限は 100 です） 25 90
atlas.project.deployment.nodesPerPrivateLinkRegion このプロジェクトのプライベート リンク リージョンあたりのノード数の制限 50 90
atlas.project.security.databaseAccess.customRoles このプロジェクトのカスタムロールの数の制限 100 1400
atlas.project.security.databaseAccess.users このプロジェクトのデータベース ユーザー数の制限 100 900
atlas.project.security.networkAccess.crossRegionEntries このプロジェクトにおけるクロスリージョン ネットワーク アクセスエントリ数の制限 40 220
atlas.project.security.networkAccess.entries このプロジェクトのネットワークアクセスエントリ数の制限 200 20
dataFederation.bytesProcessed.query 単一のデータフェデレーション クエリ中に処理されるバイト数の制限 該当なし 該当なし
dataFederation.bytesProcessed.daily 現在日にすべての Data Federation テナントで処理されるバイト数の制限 該当なし 該当なし
dataFederation.bytesProcessed.weekly 現在週にすべての Data Federation テナントで処理されるバイト数の制限 該当なし 該当なし
dataFederation.bytesProcessed.monthly 当月のすべての Data Federation テナントで処理されるバイト数の制限 該当なし 該当なし
atlas.project.deployment.privateServiceConnectionsPerRegionGroup リージョン グループごとのプライベート サービス接続の数 50 100
atlas.project.deployment.privateServiceConnectionsSubnetMask GCP PSC ネットワークのサブネット マスク。下限は 20 です。 27 27
atlas.project.deployment.salesSoldM0s org が sales-sold である場合の、このプロジェクト内の M0 クラスタの数の制限 100 100
グループ ID
必須
string = 24文字 ^([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 パラメータ
limitName
必須
string
列挙: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask" "atlas.project.deployment.salesSoldM0s"

このプロジェクトの制限を識別する、人間に判読可能なラベル。

制限名 説明 default API オーバーライド制限
atlas.project.deployment.clusters org が sales-sold ではない場合の、このプロジェクトのクラスター数の上限（org が sales-sold の場合、制限は 100 です） 25 90
atlas.project.deployment.nodesPerPrivateLinkRegion このプロジェクトのプライベート リンク リージョンあたりのノード数の制限 50 90
atlas.project.security.databaseAccess.customRoles このプロジェクトのカスタムロールの数の制限 100 1400
atlas.project.security.databaseAccess.users このプロジェクトのデータベース ユーザー数の制限 100 900
atlas.project.security.networkAccess.crossRegionEntries このプロジェクトにおけるクロスリージョン ネットワーク アクセスエントリ数の制限 40 220
atlas.project.security.networkAccess.entries このプロジェクトのネットワークアクセスエントリ数の制限 200 20
dataFederation.bytesProcessed.query 単一のデータフェデレーション クエリ中に処理されるバイト数の制限 該当なし 該当なし
dataFederation.bytesProcessed.daily 現在日にすべての Data Federation テナントで処理されるバイト数の制限 該当なし 該当なし
dataFederation.bytesProcessed.weekly 現在週にすべての Data Federation テナントで処理されるバイト数の制限 該当なし 該当なし
dataFederation.bytesProcessed.monthly 当月のすべての Data Federation テナントで処理されるバイト数の制限 該当なし 該当なし
atlas.project.deployment.privateServiceConnectionsPerRegionGroup リージョン グループごとのプライベート サービス接続の数 50 100
atlas.project.deployment.privateServiceConnectionsSubnetMask GCP PSC ネットワークのサブネット マスク。下限は 20 です。 27 27
atlas.project.deployment.salesSoldM0s org が sales-sold である場合の、このプロジェクト内の M0 クラスタの数の制限 100 100
グループ ID
必須
string = 24文字 ^([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
例
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "maximumLimit": 0,
  • "name": "atlas.project.deployment.clusters",
  • "value": 0
}

1 つのプロジェクト制限を設定

指定したプロジェクトの制限を設定します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

注意: 以下の設定制限を増加させると、MongoDB Cloud UI のレスポンスタイムが遅くなったり、ユーザー管理のオーバーヘッドが増えて認証や承認の再設計が必要になったりする可能性があります。可能であれば、より持続可能な成長パターンのために、これらのリソースをより多く利用できるように追加のプロジェクトを作成することをお勧めします。

認可:
DigestAuthServiceAccounts
path パラメータ
limitName
必須
string
列挙: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask" "atlas.project.deployment.salesSoldM0s"

このプロジェクトの制限を識別する、人間に判読可能なラベル。

制限名 説明 default API オーバーライド制限
atlas.project.deployment.clusters org が sales-sold ではない場合の、このプロジェクトのクラスター数の上限（org が sales-sold の場合、制限は 100 です） 25 90
atlas.project.deployment.nodesPerPrivateLinkRegion このプロジェクトのプライベート リンク リージョンあたりのノード数の制限 50 90
atlas.project.security.databaseAccess.customRoles このプロジェクトのカスタムロールの数の制限 100 1400
atlas.project.security.databaseAccess.users このプロジェクトのデータベース ユーザー数の制限 100 900
atlas.project.security.networkAccess.crossRegionEntries このプロジェクトにおけるクロスリージョン ネットワーク アクセスエントリ数の制限 40 220
atlas.project.security.networkAccess.entries このプロジェクトのネットワークアクセスエントリ数の制限 200 20
dataFederation.bytesProcessed.query 単一のデータフェデレーション クエリ中に処理されるバイト数の制限 該当なし 該当なし
dataFederation.bytesProcessed.daily 現在日にすべての Data Federation テナントで処理されるバイト数の制限 該当なし 該当なし
dataFederation.bytesProcessed.weekly 現在週にすべての Data Federation テナントで処理されるバイト数の制限 該当なし 該当なし
dataFederation.bytesProcessed.monthly 当月のすべての Data Federation テナントで処理されるバイト数の制限 該当なし 該当なし
atlas.project.deployment.privateServiceConnectionsPerRegionGroup リージョン グループごとのプライベート サービス接続の数 50 100
atlas.project.deployment.privateServiceConnectionsSubnetMask GCP PSC ネットワークのサブネット マスク。下限は 20 です。 27 27
atlas.project.deployment.salesSoldM0s org が sales-sold である場合の、このプロジェクト内の M0 クラスタの数の制限 100 100
グループ ID
必須
string = 24文字 ^([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

更新する制限。

価値
必須
integer <int64>

制限を設定する量。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "value": 0,
  • "name": "atlas.project.deployment.clusters"
}

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "maximumLimit": 0,
  • "name": "atlas.project.deployment.clusters",
  • "value": 0
}

1 つのプロジェクト設定を返す

指定したプロジェクトの設定に関する詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

1 つのプロジェクト設定の更新

指定したプロジェクトの設定を更新します。使用可能なオプションはすべて更新できます。MongoDB クラウドは、リクエストで提供されたオプションのみを更新します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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

更新する設定。

isCollectDatabaseSpecificsStatisticsEnabled
ブール値

指定されたプロジェクトのデータベース固有のメトリクスを収集するかどうかを示すフラグ。

isDataExplorerEnabled
ブール値

指定されたプロジェクトに対して Data Explorer を有効にするかどうかを示すフラグ。

isExtendedStorageSizesEnabled
ブール値

指定されたプロジェクトに対してストレージ サイズ拡張を有効にするかどうかを示すフラグ。

isPerformanceAdvisorEnabled
ブール値

指定したプロジェクトの Performance Advisor とプロファイラーを有効にするかどうかを示すフラグ。

isRealtimePerformancePanelEnabled
ブール値

指定したプロジェクトに対してリアルタイム パフォーマンス パネルを有効にするかどうかを示すフラグ。

isSchemaAdvisorEnabled
ブール値

指定されたプロジェクトに対してスキーマ アドバイザーを有効にするかどうかを示すフラグ。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

1 つのプロジェクトのすべてのユーザーを返す

指定されたプロジェクト内のすべてのユーザーに関する詳細を返します。ユーザーは組織に属しています。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 形式にするかどうかを示すフラグ。

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

返されるリストに、このプロジェクトでロールを持つチームに所属するユーザーを含めるかどうかを示すフラグ。プロジェクトでは、個々のユーザーにはロールが割り当てられていない場合があります。"flattenTeams" : falseの場合、このリソースはプロジェクト内でのロールがあるユーザーのみを返します。"flattenTeams" : true の場合、このリソースはプロジェクト内でのロールがあるユーザーと、プロジェクト内でのロールがあるチームに所属するユーザーの両方を返します。

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

返されるリストに、プロジェクトへの暗黙的なアクセス権を持つユーザー、組織所有者、組織の読み取り専用ロールを含めるかどうかを示すフラグ。プロジェクトでは、個々のユーザーにはロールが割り当てられていない場合があります。"includeOrgUsers": falseの場合、このリソースはプロジェクト内でのロールがあるユーザーのみを返します。"includeOrgUsers": true の場合、このリソースはプロジェクト内でのロールがある持つユーザーと、組織ロールを通じてプロジェクトに暗黙的にアクセスできるユーザーの両方を返します。

応答

応答サンプル

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

1 つのプロジェクトから 1 人のユーザーを削除

指定したユーザーを指定したプロジェクトから削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。

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

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

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

userId
必須
string = 24文字 ^([a-f0-9]{24})$

指定したプロジェクトから削除したい MongoDB Cloud ユーザーを識別する、ユニークな 24 桁の 16 進数の文字列。アプリケーションのユーザー名を使用してアプリケーション・ユーザーの ID を返すには、「1 つのプロジェクトの全てのユーザーを取得」エンドポイントを使用します。

クエリ パラメータ
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 つのインデックスをローリング方式で作成します。M0 無料クラスターまたは M2/M5 共有クラスターではローリングインデックスを作成できません。

1 つのローリング インデックスを作成

名前で識別されるクラスターにローリング方式でインデックスを作成します。この方法でインデックスを作成すると、セカンダリノードから始めて、一度に 1 つのレプリカセットノードに対してスタンドアロンとしてインデックスを構築できます。この方法でインデックスを作成するには、少なくとも 1 つのレプリカセットを選択する必要があります。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。

レプリカセット上のローリングインデックス構築
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

MongoDB Cloud がインデックスを作成するクラスターを識別する、人間に判読可能なラベル。

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

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

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

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

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

指定したクラスターに作成するローリング インデックス。

オブジェクト (Collation)

このインデックス内の文字列を比較するための言語固有のルールを指定する 1 つ以上の設定。

Collation Options
コレクション
必須
string

MongoDB Cloud がインデックスを作成するコレクションの、人間に判読可能なラベル。

db
必須
string

MongoDB Cloud がインデックスを作成するコレクションを保持するデータベースの、人間に判読可能なラベル。

の配列 オブジェクト[ items = 1 properties ]

インデックスを作成するパラメータを記述する 1 つ以上のオブジェクトを含むリスト。

オブジェクト (IndexOptions)

MongoDB Cloud がこの MongoDB インデックスを作成する方法を決定する 1 つまたは複数の設定。

インデックス オプション

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例

2dspere Index

{
  • "collation": {
    },
  • "collection": "accounts",
  • "db": "sample_airbnb",
  • "keys": [
    ],
  • "options": {
    }
}

応答サンプル

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

ルート

MongoDB Cloud ビルドと、このリソースをリクエストするアクセス トークンについて説明する詳細を返します。これにより MongoDB Cloud API が起動します。

この MongoDB アプリケーションのステータスを返す

このリソースは、MongoDB アプリケーションに関する情報と API キーのメタデータを返します。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "apiKey": {
    },
  • "appName": "MongoDB Atlas",
  • "build": "83be55e140f493c88e7f578aae96548dd881587b",
  • "links": [],
  • "throttling": true
}

サーバーレスインスタンス

サーバーレスインスタンスを返したり、追加したり、編集したり、削除したりします。

1 つのプロジェクトからすべてのサーバーレスインスタンスを返す

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

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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つ作成する。 このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 つのサーバーレスインスタンスを作成します。

name
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つのサーバーレスインスタンスを削除

指定されたプロジェクトから 1 つのサーバーレス インスタンスを削除します。サーバーレス インスタンスを削除するには、終了保護を無効にする必要があります。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

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

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

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

name
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つのサーバーレスインスタンスを返す

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

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

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

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

name
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

1 つのプロジェクトの 1 つのサーバーレスインスタンスを更新

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

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

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

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

name
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つのサーバーレスインスタンスを更新します。

オブジェクト （サーバーレス バックアップ オプション）

サーバーレス バックアップを構成する設定のグループ。

の配列 オブジェクト (Resource Tag)

サーバーレスインスタンスにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。

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

サーバーレスインスタンスで終了保護が有効になっているかどうかを示すフラグ。true に設定されていると、MongoDB Cloud はサーバーレスインスタンスを削除しません。false に設定されていると、MongoDB Cloud はサーバーレスインスタンスを削除します。

応答

リクエスト サンプル

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

サーバーレス プライベートエンドポイント

サーバーレスインスタンスのプライベートエンドポイントを返したり、追加したり、編集したり、削除したりします。詳細については、次のチュートリアルの「Atlas 管理 API」タブを参照してください。

サーバーレスインスタンスのプライベートエンドポイントを設定するチュートリアル

1 つのサーバーレスインスタンスのすべてのプライベートエンドポイントを返す

1 つのサーバーレスインスタンスのすべてのプライベートエンドポイントを返します。このリソースを正常に呼び出すには、少なくともプロジェクトの読み取り専用ロールを持っている必要があります。

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

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

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

instanceName
必須
string <= 64 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

テナント エンドポイントに関連付けられたサーバーレスインスタンスを識別する、人間が判読可能なラベル。

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

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

応答

応答サンプル

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

1 つのサーバーレスインスタンスの 1 つのプライベートエンドポイントを作成

1つのサーバーレスインスタンスに対して1つのプライベートエンドポイントを作成します。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

新しいエンドポイントは、作成後すぐには利用できません。詳細なガイダンスについては、リンクされたチュートリアルの手順をお読みください。

サーバーレスインスタンスのプライベートエンドポイントを設定するチュートリアル
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

instanceName
必須
string <= 64 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

テナント エンドポイントが作成されるサーバーレスインスタンスを識別する、人間が判読可能なラベル。

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

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

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

サーバーレスインスタンスに作成するプライベートエンドポイントに関する情報。

comment
string <= 80 文字

プライベートエンドポイントに関連付けられた、人間が判読可能なコメント。

応答

リクエスト サンプル

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

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "providerName": "AWS",
  • "status": "RESERVATION_REQUESTED"
}

1 つのサーバーレスインスタンスの 1 つのプライベートエンドポイントを削除

1つのサーバーレスインスタンスから1つのプライベートエンドポイントを削除します。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

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

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

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

instanceName
必須
string <= 64 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

テナント エンドポイントが削除されるサーバーレスインスタンスを識別する、人間が判読可能なラベル。

endpointId
必須
string = 24文字 ^([a-f0-9]{24})$

削除されるテナント エンドポイントを識別するユニークな 24 桁の 16 進数文字列。

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

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

応答

応答サンプル

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

1 つのサーバーレスインスタンスの 1 つのプライベートエンドポイントを返す

1 つのサーバーレスインスタンスの 1 つのプライベートエンドポイントを返します。ユニークな ID を使用してこのエンドポイントを識別します。このリソースを正常に呼び出すには、少なくともプロジェクトの読み取り専用ロールを持っている必要があります。

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

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

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

instanceName
必須
string <= 64 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

テナント エンドポイントに関連付けられたサーバーレスインスタンスを識別する、人間が判読可能なラベル。

endpointId
必須
string = 24文字 ^([a-f0-9]{24})$

テナントエンドポイントを識別する、ユニークな 24 桁の 16 進数文字列。

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "providerName": "AWS",
  • "status": "RESERVATION_REQUESTED"
}

1 つのサーバーレスインスタンスの 1 つのプライベートエンドポイントを更新

1 つのサーバーレスインスタンスの 1 つのプライベートエンドポイントを更新します。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

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

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

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

instanceName
必須
string <= 64 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

更新するテナント エンドポイントに関連付けられたサーバーレスインスタンスを識別する、人間が判読可能なラベル。

endpointId
必須
string = 24文字 ^([a-f0-9]{24})$

更新対象のテナント エンドポイントを識別する、ユニークな 24 桁の 16 進数文字列。

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

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

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

アップデートに使用されるオブジェクト。

comment
string <= 80 文字

プライベートエンドポイントに関連付けられた、人間が判読可能なコメント。

providerName
必須
string

テナントエンドポイントのクラウドプロバイダーを識別する、人間に判読可能なラベル。

cloudProviderEndpointId
string^vpce-[0-9a-f]{17}$

プライベートエンドポイントのネットワークインターフェイスを識別するユニークな文字列。

応答

リクエスト サンプル

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

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "providerName": "AWS",
  • "status": "RESERVATION_REQUESTED"
}

共有階層復元ジョブ

共有階層データベース配置の復元ジョブの返却・追加を行います。

1 つの M2 または M5 クラスターから 1 つの復元ジョブを作成

指定したクラスターを復元します。MongoDB Cloud では、復元のターゲットクラスターにできるクラスターが限定されています。ターゲットクラスターは、保管時の暗号化を使用したり、スナップショットと異なる MongoDB のメジャーリリース バージョンを実行したり、復元中にクライアントリクエストを受信することができません。MongoDB Cloud は、復元操作の前に、ターゲットクラスター上の既存のデータをすべて削除します。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

グループ ID
必須
string = 24文字 ^([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

復元ジョブの詳細。

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

復元するスナップショットを識別するユニークな 24 桁の 16 進数文字列。

targetDeploymentItemName
必須
string [ 1 .. 64 ] 文字 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

スナップショットの復元先となるターゲットプロジェクト上のクラスターを識別する、人間が判読できるラベル。スナップショットは M2 以上の層のクラスターに復元できます。

targetProjectId
string = 24文字 ^([a-f0-9]{24})$

スナップショットを復元したいクラスターを含んだプロジェクトを識別する、ユニークな 24 桁の 16 進数文字列。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "snapshotUrl": "string",
  • "status": "PENDING",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

1 つの M2 または M5 クラスターのすべての復元ジョブを返す

指定された M2 または M5 クラスターのすべての復元ジョブを返します。復元ジョブではスナップショットを使用してクラスターが復元されます。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

グループ ID
必須
string = 24文字 ^([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
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つの M2 または M5 クラスターの 1 つの復元ジョブを返す

指定された復元ジョブを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

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

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

restoreId
必須
string = 24文字 ^([a-f0-9]{24})$

返す対象である復元ジョブを識別するユニークな 24 桁の 16 進数文字列。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "snapshotUrl": "string",
  • "status": "PENDING",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

共有階層スナップショット

共有階層データベース配置のスナップショットをダウンロードを返し、リクエストします

1 つの M2 または M5 クラスター スナップショットをダウンロード

指定された共有クラスターのスナップショットを 1 つ要求します。このリソースは、スナップショットをダウンロードするために使用できるsnapshotURLを返します。このsnapshotURLは、リクエスト後 4 時間アクティブのままになります。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

グループ ID
必須
string = 24文字 ^([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

ダウンロードするスナップショット。

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

復元するスナップショットを識別するユニークな 24 桁の 16 進数文字列。

targetDeploymentItemName
必須
string [ 1 .. 64 ] 文字 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

スナップショットの復元先となるターゲットプロジェクト上のクラスターを識別する、人間が判読できるラベル。スナップショットは M2 以上の層のクラスターに復元できます。

targetProjectId
string = 24文字 ^([a-f0-9]{24})$

スナップショットを復元したいクラスターを含んだプロジェクトを識別する、ユニークな 24 桁の 16 進数文字列。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "snapshotUrl": "string",
  • "status": "PENDING",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

1 つの M2 または M5 クラスターのすべてのスナップショットを返す

指定された共有クラスターのすべてのスナップショットの詳細を返します。 このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][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 つの M2 または M5 クラスターの 1 つのスナップショットを返す

指定した共有クラスターのスナップショットの詳細を返します。 このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

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

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

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

clusterName
必須
string [ 1 .. 64 ] 文字 ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

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

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

目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。

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

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

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

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

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "expiration": "2019-08-24T14:15:22Z",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "scheduledTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "PENDING"
}

チーム

チームを返却、追加、編集、削除します。

1 つのプロジェクトのすべてのチームを返す

ユニークな 24 桁の 16 進数識別子を使用して指定されたプロジェクト内で認証されたユーザーがアクセスできるすべてのチームを返します。 チームの全メンバーが同じプロジェクト アクセスを共有します。 このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 形式にするかどうかを示すフラグ。

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

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

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

レスポンスが返す 1 ページあたりのアイテムの数。

pageNum
integer >= 1
デフォルト: 1
例: pageNum=1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{}

1 つのプロジェクトに 1 つ以上のチームを追加

指定したプロジェクトに 1 つのチームを追加します。チームの全メンバーが同じプロジェクトへのアクセスを共有します。MongoDB Cloud では、ユーザー数は 1 プロジェクトあたり最大 100 チーム、1 組織あたり最大 250 チームに制限されています。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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

指定したプロジェクトに追加するチーム。

配列
roleNames
の配列 string unique
アイテム列挙: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud ユーザーに割り当てる 1 つ以上の組織レベルまたはプロジェクト レベルのロール。

teamId
string = 24文字 ^([a-f0-9]{24})$

チームを識別するユニークな 24 進数文字列。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

応答サンプル

コンテンツタイプ
application/ JSON
{}

1 つのプロジェクトから 1 つのチームを削除

ユニークな 24 桁の 16 進数識別子を使用して指定されたプロジェクトから、ユニークな 24 桁の 16 進数識別子を使用して指定された 1 件のチームを削除します。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

teamId
必須
string = 24文字 ^([a-f0-9]{24})$

指定したプロジェクトから削除したいチームを識別する、ユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
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 つのプロジェクトでのチームのロール更新

指定されたチームに割り当てられたプロジェクトの役割を更新します。特定のプロジェクトにチーム ロールを付与し、チーム内のユーザーにプロジェクトにアクセスするロールを付与できます。チームの全メンバーが同じプロジェクトへのアクセスを共有します。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

teamId
必須
string = 24文字 ^([a-f0-9]{24})$

ロールを更新したいチームを識別するユニークな 24 桁の 16 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

リクエスト ボディ スキーマ: application/json

指定したチームに割り当てられたプロジェクト ロール。

roleNames
の配列 string unique
アイテム列挙: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud ユーザーに割り当てる 1 つ以上の組織レベルまたはプロジェクト レベルのロール。

teamId
string = 24文字 ^([a-f0-9]{24})$

チームを識別するユニークな 24 進数文字列。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "roleNames": [
    ],
  • "teamId": "32b6e34b3d91647abb20e7b8"
}

応答サンプル

コンテンツタイプ
application/ JSON
{}

1 つの組織のすべてのチームを返す

指定した組織に属するすべてのチームを返します。チームを使用すると、MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。MongoDB Cloud は、アクセス権を持つチームのみを返します。このリソースを使用するには、要求する API キーに組織メンバーのロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

itemsPerPage
integer [ 1 .. 500 ]
デフォルト: 100
例: itemsPerPage=100

レスポンスが返す 1 ページあたりのアイテムの数。

includeCount
ブール値
デフォルト: true
例: includeCount=true

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

pageNum
integer >= 1
デフォルト: 1
例: pageNum=1

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{}

1 つの組織に 1 つのチームを作成

指定した組織に 1 つのチームを作成します。チームを使用すると、MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。MongoDB Cloudでは、チーム数は 1 組織につき最大 250 チームに制限されています。このリソースを使用するには、リクエストする API キーに組織所有者のロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([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

指定した組織で作成するチーム。

name
必須
string

チームを識別する、人間に判読可能なラベル。

usernames
の配列 string <email> unique

このチーム内の MongoDB Cloud ユーザーを含むリスト。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "name": "string",
  • "usernames": [
    ]
}

応答サンプル

コンテンツタイプ
application/ JSON
{}

チームの名前を使用して 1 つのチームを返す

人間が判読できる名前を使用して識別した 1 つのチームを返します。このチームは 1 つの組織に属しています。チームを使用すると、MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。このリソースを使用するには、要求する API キーに組織メンバーのロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

teamName
必須
string

情報を返したいチームの名前。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{}

1 つの組織から 1 つのチームを削除

ユニークな 24 桁の 16 進数 ID を使用して指定された 1 つのチームを、ユニークな 24 桁の 16 進数識別子を使用して指定された組織から削除します。 このリソースを使用するには、リクエストする API キーに組織所有者のロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

teamId
必須
string = 24文字 ^([a-f0-9]{24})$

削除したいチームを識別する、ユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{ }

チームの ID を使用して 1 つのチームを返す

ユニークな 24 桁の 16 進数 ID を使用して識別した 1 つのチームを返します。このチームは 1 つの組織に属しています。チームを使用すると、MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。このリソースを使用するには、要求する API キーに組織メンバーのロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

teamId
必須
string = 24文字 ^([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 つのチームの名前を変更します。チームを使用すると、MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。このリソースを使用するには、リクエストする API キーに組織所有者のロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

teamId
必須
string = 24文字 ^([a-f0-9]{24})$

名称を変更したいチームを識別する、ユニークな 24 桁の 16 進数の文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

リクエスト ボディ スキーマ: application/json

指定したチームで更新する詳細。

name
必須
string

チームを識別する、人間に判読可能なラベル。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "name": "string"
}

応答サンプル

コンテンツタイプ
application/ JSON
{}

1 つのチームに割り当てられたすべての MongoDB Cloud ユーザーを返す

ユニークな 24 桁の 16 進数識別子を使用して指定されたチームに割り当てられたすべての MongoDB Cloud ユーザーを返します。このチームは 1 つの組織に属しています。チームを使用すると、MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。このリソースを使用するには、要求する API キーに組織メンバーのロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

teamId
必須
string = 24文字 ^([a-f0-9]{24})$

アプリケーション ユーザーを返したいチームを識別する、ユニークな 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

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つの組織から 1 つのチームへ MongoDB Cloud ユーザーを割り当て

指定した組織の 1 人以上の MongoDB Cloud ユーザーを指定したチームに追加します。チームを使用すると、MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。1 つの組織から最大 250 人の MongoDB Cloud ユーザーを 1 つのチームに割り当てることができます。このリソースを使用するには、リクエストする API キーに組織所有者のロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

teamId
必須
string = 24文字 ^([a-f0-9]{24})$

MongoDB Cloud ユーザーを追加するチームを識別するユニークな 24 進数文字列。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

リクエスト ボディ スキーマ: application/json

指定したチームに追加する 1 人以上の MongoDB Cloud ユーザー。

配列
id
必須
string = 24文字 ^([a-f0-9]{24})$

MongoDB Cloud ユーザーを識別するユニークな 24 桁の 16 進数文字列。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1 つのチームから 1 人の MongoDB Cloud ユーザーを削除

指定されたチームから 1 人の MongoDB Cloud ユーザーを削除します。このチームは 1 つの組織に属しています。チームを使用すると、MongoDB Cloud ユーザーにプロジェクトにアクセスするロールを付与できます。このリソースを使用するには、リクエストする API キーに組織所有者のロールが必要です。

組織チームの管理
認可:
DigestAuthServiceAccounts
path パラメータ
orgId
必須
string = 24文字 ^([a-f0-9]{24})$
例: 4888442a3354817a7320eb61

プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。

teamId
必須
string = 24文字 ^([a-f0-9]{24})$

1 件のデータベース アプリケーション ユーザーを削除するチームを識別する、ユニークな 24 桁の 16 進数の文字列。

userId
必須
string = 24文字 ^([a-f0-9]{24})$

指定したチームから削除する MongoDB Cloud ユーザーを識別する、ユニークな 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"
}

サードパーティ統合

サードパーティのサービス統合構成を返したり、追加したり、編集したり、削除したりします。MongoDB Cloud は、設定した各サードパーティ サービスにアラートを送信します。

IMPORTANT: 各プロジェクトは、1つの integrationType につき 1 つの構成しか持つことができません。

すべてのアクティブなサードパーティ サービス統合を返す

構成されたすべてのサードパーティ サービスとの統合を許可する設定を返します。これらの設定は、1 つの MongoDB Cloud プロジェクトで管理されるすべてのデータベースに適用されます。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクトオーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([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 つのサードパーティ サービス統合を削除

1 つのサードパーティ サービス統合の構成を許可する設定を削除します。これらの設定は、1 つの MongoDB Cloud プロジェクトで管理されるすべてのデータベースに適用されます。プロジェクトから統合を削除すると、そのプロジェクトの統合構成のみが削除されます。このアクションは、他のプロジェクトや組織の設定済みの {INTEGRATION-TYPE}統合には影響しません。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクトオーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
integrationType
必須
string (Integration Type)
列挙: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

MongoDB Cloud と統合するサービスを識別する、人間に判読可能なラベル。

グループ ID
必須
string = 24文字 ^([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 つのサードパーティ サービスとの統合を構成する設定を返します。これらの設定は、1 つの MongoDB Cloud プロジェクトで管理されるすべてのデータベースに適用されます。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクトオーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

integrationType
必須
string (Integration Type)
列挙: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

MongoDB Cloud と統合するサービスを識別する、人間に判読可能なラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

応答

応答サンプル

コンテンツタイプ
application/ JSON
例
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "type": "DATADOG"
}

1 つのサードパーティ サービス統合を構成

1 つのサードパーティ サービス統合を構成する設定を追加します。これらの設定は、指定した MongoDB Cloud プロジェクトで管理されているすべてのデータベースに適用されます。各プロジェクトには、 {INTEGRATION-TYPE}ごとに 1 つの構成のみを含めることができます。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクトオーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
integrationType
必須
string (Integration Type)
列挙: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

MongoDB Cloud と統合するサービスを識別する、人間に判読可能なラベル。

グループ ID
必須
string = 24文字 ^([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

プロジェクトに設定するサードパーティ統合。

apiKey
必須
string

MongoDB Cloud が Datadog アカウントにアクセスできるようにするキー。

注：API または統合キーが必要な通知を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • Atlas UI を通じてアラートを表示または編集します。

  • Atlas Administration API から通知するアラートを問い合わせます。

id
string または NULL

統合ID。

リージョン
string
列挙: "US" "EU" "US3" "US5" "AP1"

MongoDB が Datadog API にアクセスするために使用するリージョン URL を示す 2 文字のコード。

Datadog のリージョンの詳細については、 Datadog サイトを参照してください。

タイプ
string

MongoDB Cloud と統合するサービスを識別する、人間に判読可能なラベル。値はサードパーティのサービス統合タイプと一致する必要があります。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "type": "DATADOG"
}

応答サンプル

コンテンツタイプ
application/ JSON
{}

1 つのサードパーティ サービス統合を更新

1 件のサードパーティ サービスとの統合を構成する設定を更新します。これらの設定は、1 つの MongoDB Cloud プロジェクトで管理されるすべてのデータベースに適用されます。 このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクトオーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
integrationType
必須
string (Integration Type)
列挙: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

MongoDB Cloud と統合するサービスを識別する、人間に判読可能なラベル。

グループ ID
必須
string = 24文字 ^([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

プロジェクトに設定するサードパーティ統合。

apiKey
必須
string

MongoDB Cloud が Datadog アカウントにアクセスできるようにするキー。

注：API または統合キーが必要な通知を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • Atlas UI を通じてアラートを表示または編集します。

  • Atlas Administration API から通知するアラートを問い合わせます。

id
string または NULL

統合ID。

リージョン
string
列挙: "US" "EU" "US3" "US5" "AP1"

MongoDB が Datadog API にアクセスするために使用するリージョン URL を示す 2 文字のコード。

Datadog のリージョンの詳細については、 Datadog サイトを参照してください。

タイプ
string

MongoDB Cloud と統合するサービスを識別する、人間に判読可能なラベル。値はサードパーティのサービス統合タイプと一致する必要があります。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
例
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "type": "DATADOG"
}

応答サンプル

コンテンツタイプ
application/ JSON
{}

x.509 認証

ユーザーが管理する X.509 構成を返したり、編集したり、削除したりします。また、データベース ユーザーのために、MongoDB Cloud が管理する X.509 証明書を返して生成します。次のリソースは、X.509 証明書を使用して認証するデータベース ユーザーの管理に役立ちます。これらの X.509 証明書は自分で管理することも、MongoDB Cloud に管理させることもできます。MongoDB Cloud が証明書を管理する場合、証明機関も管理されるため、データベース ユーザー用の証明書が生成できます。追加の X.509 設定は必要ありません。証明書を管理する場合は、証明機関を提供し、データベース ユーザー用の証明書を生成する必要があります。

自己管理型 X.509 証明書

1 人の MongoDB ユーザーに割り当てられたすべての X.509 証明書を返す

指定された MongoDB ユーザーの有効期限が切れていないすべての X.509 証明書を返します。この MongoDB ユーザーは 1 つのプロジェクトに属しています。Atlas がこれらの証明書と MongoDB ユーザーを管理します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

username
必須
string

証明書を返す MongoDB データベース ユーザーアカウントを表す、人間が判読できるラベル。

クエリ パラメータ
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 人の MongoDB ユーザーに対して 1 つの X.509 証明書を作成

指定された MongoDB ユーザーに対して 1 つの X.509 証明書を生成します。Atlas は、1 つのプロジェクトに属する証明書と MongoDB ユーザーを管理します。このリソースを使用するには、リクエストする API キーにプロジェクト オーナーのロールが必要です。

MongoDB Cloud が管理するデータベース ユーザー用証明書を生成するには、目的の MongoDB データベース ユーザーに"x509Type" : "MANAGED"を設定します。

自己管理型 X.509 モードで独自の認証局 (CA) を管理している場合は、独自の CA を使用してデータベースユーザーの証明書を生成する必要があります。

自己管理型 X.509
認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

username
必須
string

証明書を作成する MongoDB データベース ユーザーアカウントを表す、人間が判読できるラベル。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

pretty
ブール値
デフォルト: false
例: pretty=false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

リクエスト ボディ スキーマ: application/json

指定された MongoDB ユーザーに対して 1 つの X.509 証明書を生成します。

monthsUntilExpiration
integer <int32> <= 24
デフォルト: 3

証明書の有効期限が切れるまでの有効月数。

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "monthsUntilExpiration": 3
}

応答サンプル

コンテンツタイプ
application/ JSON
"string"

カスタマーマネージドの X.509 を無効化

アップロードされた認証局を含む、プロジェクトのカスタマー マネージド X.509 設定をクリアし、自己管理型 X.509 を無効にします。

この設定を更新すると、データベースのローリング再起動がトリガーされます。このエンドポイントを使用するには、プロジェクト オーナーのロールが必要です。

認可:
DigestAuthServiceAccounts
path パラメータ
グループ ID
必須
string = 24文字 ^([a-f0-9]{24})$
例: 32b6e34b3d91647abb20e7b8

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

クエリ パラメータ
envelope
ブール値
デフォルト: false
例: envelope=false

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}