API
項目一覧
MongoDB Atlas for Government API関数は Atlas APIと同じ方法で使用されますが、次のベース URL を使用します。
https://cloud.mongodbgov.com/api/atlas/v2
AtlasGov は、 SHA-256
HTTP ダイジェスト認証 を使用して、 による API リクエストを認証します。
使用例
このcurl
の例では、プロジェクトのデータベースユーザーを検索します。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ # update date to desired API version --include \ --request GET "https://cloud.mongodbgov.com/api/atlas/v2/groups/{PROJECT-ID}/databaseUsers?pretty=true"
PROJECT-ID
は Project Settingsにあります。組織のAccess ManagerのAPI KeysタブでAPIキー ペアを生成できます。
Atlas のドキュメントを参照
APIの使用の詳細については、 Atlas API を参照してください。
API を設定するには、 「 Atlas API アクセスの設定」 を参照してください。
考えられるエラーのリストについては、「 Atlas API エラー コード 」を参照してください。
プロジェクトを作成する
作成時に標準または政府( gov
)リージョンで使用するプロジェクトを指定する必要があります。 同じプロジェクトで、政府と標準リージョンをまたがってクラスターを配置することはできません。
デフォルトでは、AtlasGov API は標準リージョンで使用するための新しいプロジェクトを指定します。
API を使用して政府リージョン向けのプロジェクトを作成するには、 POST
リクエスト データに次の内容を含めます。
"regionUsageRestrictions" : "GOV_REGIONS_ONLY"
政府に関する考慮事項のための Atlas
次のクラウドプロバイダー、MongoDB 製品、および機能はすべてのAPIリソースで使用できません。
Azure
Atlas Data Lake
Atlas Online Archives
Atlas Triggers
MongoDB Charts
Atlas Device SDK
無料クラスター、共有クラスター、フレキシブル、
M10
クラスター
商用 Atlas APIリソースの多くは、制限されているか利用できません。
データベースユーザー
SCRAMで認証するデータベースユーザーは、 SCRAM-SHA-256
を使用する必要があります。
クラスター
AtlasGov クラスターは階層 M20
以上である必要があります。 Atlas は、 無料クラスター、フレキシブルなクラスター、 共有クラスター をサポートしていません。
アラート
お支払い方法に関連するアラートは表示されません。
アラートは、複数の異なるメールアドレスから送信される場合があります。 詳細については、「 アラートと通信 」を参照してください。
サードパーティ統合設定
サードパーティのモニタリング統合を構成するには、 Project Owner
ロールが必要です。
Datadog
Datadog と統合すると、AtlasGov は Datadog for Government サイト(US1-FED)を使用します。
US1 -FED の詳細については、 Datadog のドキュメント を参照してください。
クラウドバックアップ
標準プロジェクトと Gov リージョン専用プロジェクト間での復元は許可されていません。 バックアップが Gov リージョン専用( Amazon Web Services GovCloud またはGCP保証ワークロード)プロジェクトのクラスターから作成されている場合、データは Gov リージョン専用プロジェクト内のクラスターにのみ復元できます。 同じ制限は標準プロジェクトにも適用され、標準リージョンのバックアップは標準プロジェクトのクラスターにのみ復元できます。
クロスクラウド復元は、 Amazon Web Services GovCloud とGCP保証ワークロードのリージョン間でサポートされています。
柔軟な共有クラスター スナップショットと復元ジョブ
Flex クラスターと Shared クラスターは AtlasGov では利用できません。
Online Archive
AtlasGov では Atlas Online Archive は利用できません。
ネットワークピアリング
Amazon Web Services GovCloud リージョンとMongoDBクラスターは、 Amazon Web Services GovCloud リージョンでのみピアリングできます。 Amazon Web ServicesMongoDBクラスターとAmazon Web Services リージョンのみをピアリングできます。
GCP 保証ワークロード リージョンの MongoDB クラスターとのみピアリングできるのは、GCP 保証ワークロード リージョンです。
プライベートエンドポイント
Amazon Web ServicesAmazon Web Services GovCloudMongoDB リージョンとAmazon Web Services GovCloud リージョンの クラスターのみをリンクできます。Amazon Web ServicesAmazon Web Services StandardMongoDB リージョンとAmazon Web Services Standard リージョンの クラスターのみをリンクできます。
GCP 保証ワークロード リージョンは、GCP 保証ワークロード リージョンの MongoDB クラスターとのみリンクできます。
モニタリングとログ
標準の Atlas ログに加えて、AtlasGov はすべての失敗したログイン試行、一時ロックアウト、失敗したAPIダイジェスト認証に関連するユーザー名と IP アドレスをログに記録します。
カスタマー キー管理を使用した保管時の暗号化
KMSAmazon Web ServicesGovCloud および 保証されたワークロードのリージョン専用プロジェクトのデータを暗号化するには、GCP Amazon Web ServicesGovCloud および 保証されたワークロードのリージョンでGCP キーを使用する必要があります。KMSAmazon Web ServicesStandard リージョン専用プロジェクトのデータを暗号化するには、Amazon Web StandardAmazon Web Services リージョンで キーを使用する必要があります。
Atlas ユーザー
MongoDB Atlas を Government ユーザー用に作成することはできません。 MongoDB Atlas for Government は招待によってのみ利用できます。
Atlas Stream Processing
Atlas Stream Processing は AtlasGov では利用できません。
トリガー
AtlasGov では trigger は利用できません。