MongoDB Atlas for Government API関数は Atlas APIと同じ方法で使用されますが、次のベース URL を使用します。
https://cloud.mongodbgov.com/api/atlas/v2
MongoDB Atlas for 政府 APIを使用してクラスターを管理するには、APIリクエストを認証する必要があります。MongoDB Atlas for Government APIは次の認証方法を受け入れます。
サービス アカウント アクセス トークン（OAuth 2.0）
APIキー（HTTPダイジェスト認証）
使用例
この curl の例では、プロジェクトのデータベースユーザーを検索します。希望する認証方法に該当するタブを選択してください。
サービスアカウントを使用して API リクエストを行うには、サービスアカウントを使用してアクセス トークンを生成し、そのアクセス トークンをリクエストで使用します。
サービスアカウントのクライアント シークレットを検索します。
サービス アカウントの作成後すぐに保存した mdb_sa_sk_ で始まるクライアントシークレットを見つけます。クライアントシークレットを保存しなかった場合は、新しいクライアントシークレットを生成する必要があります。
アクセス トークンをリクエストします。
重要
アクセス トークンは 1 時間（3600 秒）有効です。アクセス トークンを更新することはできません。このアクセス トークンの有効期限が切れたら、この手順を繰り返して新しいアクセス トークンを生成します。
次の例の {BASE64-AUTH} を前のステップの出力に置き換え、実行します。
1 curl --request POST \ 2 --url https://cloud.mongodbgov.com/api/oauth/token \ 3 --header 'accept: application/json' \ 4 --header 'cache-control: no-cache' \ 5 --header 'authorization: Basic {BASE64-AUTH}' \ 6 --header 'content-type: application/x-www-form-urlencoded' \ 7 --data 'grant_type=client_credentials'
{"access_token":"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImYyZjE2YmE4LTkwYjUtNDRlZS1iMWYwLTRkNWE2OTllYzVhNyJ9.eyJpc3MiOiJodHRwczovL2Nsb3VkLWRldi5tb25nb2RiLmNvbSIsImF1ZCI6ImFwaTovL2FkbWluIiwic3ViIjoibWRiX3NhX2lkXzY2MjgxYmM2MDNhNzFhNDMwYjkwNmVmNyIsImNpZCI6Im1kYl9zYV9pZF82NjI4MWJjNjAzYTcxYTQzMGI5MDZlZjciLCJhY3RvcklkIjoibWRiX3NhX2lkXzY2MjgxYmM2MDNhNzFhNDMwYjkwNmVmNyIsImlhdCI6MTcxMzkwNTM1OSwiZXhwIjoxNzEzOTA4OTU5LCJqdGkiOiI4ZTg1MTM3YS0wZGU1LTQ0N2YtYTA0OS1hMmVmNTIwZGJhNTIifQ.AZSFvhcjwVcJYmvW6E_K5UnDmeiX2sJgL27vo5ElzeBuPawRciKkn6ervZ6IpUTx2HHllGgAAMmhaP9B66NywhfjAXC697X9KcOzm81DTtvDjLrFeRSc_3vFmeGvfUKKXljEdWBnbmwCwtBlO5SJuBxb1V5swAl-Sbq9Ymo4NbyepSnF","expires_in":3600,"token_type":"Bearer"}%
API 呼び出しを行います。
次の例の {ACCESS-TOKEN} を前のステップの出力に置き換えます。
次のサンプル GET リクエストは、組織内のすべてのプロジェクトを返します。
curl --request GET \ --url https://cloudgov.mongodb.com/api/atlas/v2/groups \ --header 'Authorization: Bearer {ACCESS-TOKEN}' \ --header 'Accept: application/vnd.atlas.2023-02-01+json' \ --header 'Content-Type: application/json'
次のサンプル POST リクエストは、リクエスト本文を受け取り、組織内に MyProject という名前のプロジェクトを作成します。
curl --header 'Authorization: Bearer {ACCESS-TOKEN}' \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ --include \ --request POST "https://cloudgov.mongodb.com/api/atlas/v2/groups" \ --data ' { "name": "MyProject", "orgId": "5a0a1e7e0f2912c554080adc" }'
APIキーを使用して API リクエストを行うには、{PUBLIC-KEY}:{PRIVATE-KEY} をAPIキーに置き換えて次のコマンドを実行します。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2025-03-12+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キーを使用してAPIに認証する方法の詳細については、Atlas 管理API認証メソッドを参照してください。
API を設定するには、 「 Atlas API アクセスの設定」 を参照してください。
考えられるエラーのリストについては、「 Atlas API エラー コード 」を参照してください。
プロジェクトを作成する
作成時に標準または政府（ gov ）リージョンで使用するプロジェクトを指定する必要があります。 同じプロジェクトで、政府と標準リージョンをまたがってクラスターを配置することはできません。
デフォルトでは、AtlasGov API は標準リージョンで使用するための新しいプロジェクトを指定します。
API を使用して政府リージョン向けのプロジェクトを作成するには、 POSTリクエスト データに次の内容を含めます。
"regionUsageRestrictions" : "GOV_REGIONS_ONLY"
政府に関する考慮事項のための Atlas
次のクラウドプロバイダー、MongoDB 製品、および機能はすべてのAPIリソースで使用できません。
Azure
Atlas Online Archives
Atlas Triggers
MongoDB Charts
Atlas Device SDK
無料クラスター、フレキシブルなクラスター、
M10クラスター
商用 Atlas APIリソースの多くは、制限されているか利用できません。
データベースユーザー
SCRAMで認証するデータベースユーザーは、 SCRAM-SHA-256を使用する必要があります。
クラスター
AtlasGov クラスターは階層 M20 以上である必要があります。Atlas は、 無料クラスターと Flex クラスターをサポートしていません。
アラート
お支払い方法に関連するアラートは表示されません。
アラートは、複数の異なるメールアドレスから送信される場合があります。 詳細については、「 アラートと通信 」を参照してください。
サードパーティ統合設定
サードパーティのモニタリング統合を構成するには、 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保証ワークロードのリージョン間でサポートされています。
柔軟なクラスター スナップショットと復元ジョブ
AtlasGov では Flex クラスターは利用できません。
Online Archive
AtlasGov では Atlas Online Archive は利用できません。
ネットワークピアリング
Amazon Web Services GovCloud リージョンとMongoDBクラスターは、 Amazon Web Services GovCloud リージョンでのみピアリングできます。 MongoDBクラスターとAmazon Web Services Amazon Web Servicesの商用リージョンのみをピアリングできます。
GCP 保証ワークロード リージョンの MongoDB クラスターとのみピアリングできるのは、GCP 保証ワークロード リージョンです。
プライベートエンドポイント
Amazon Web Services GovCloud リージョンとAmazon Web Services GovCloud リージョンのMongoDBクラスターのみをリンクできます。 Amazon Web Services の商用リージョンと、 Amazon Web Servicesの商用リージョンのMongoDBクラスターのみにリンクできます。
GCP 保証ワークロード リージョンは、GCP 保証ワークロード リージョンの MongoDB クラスターとのみリンクできます。
モニタリングとログ
標準の Atlas ログに加えて、AtlasGov はすべての失敗したログイン試行、一時ロックアウト、失敗したAPIダイジェスト認証に関連するユーザー名と IP アドレスをログに記録します。
カスタマー キー管理を使用した保管時の暗号化
Amazon Web Services GovCloud およびGCP保証されたワークロードのリージョン専用プロジェクトのデータを暗号化するには、 Amazon Web Services GovCloud およびGCP保証されたワークロードのリージョンで KMS キーを使用する必要があります。 Amazon Web Services Amazon Web Services Web Services の商用リージョンで KMS キーを使用する必要があります。
Atlas ユーザー
MongoDB Atlas を Government ユーザー用に作成することはできません。 MongoDB Atlas for Government は招待によってのみ利用できます。
Atlas Stream Processing
Atlas Stream Processing は AtlasGov では利用できません。
トリガー
AtlasGov では trigger は利用できません。