重要
それぞれの Atlas Administration API には独自のリソースがあり、初期設定が必要です。
Atlas Administration API サーバーには、パブリックインターネットからのみアクセスできます。Atlas Administration API は、ネットワーク ピアリングまたはプライベート エンドポイントを使用する接続では使用できません。
詳細については、 「プログラムによる Atlas へのアクセス」を参照してください。
Atlas 管理API は、REST アーキテクチャ スタイルの原則に従い、Atlas の機能へのプログラムによるアクセスを可能にする多数の内部リソースを公開します。Atlas Administration APIの詳細については、Atlas Administration APIリファレンスを参照してください。
Atlas 管理API、クラスターに保存されているデータへのアクセスは提供されていません。データベースでデータを読み書きするには、適切な読み取りロールまたは書き込みロールを持つデータベースユーザーの認証情報を使用してクラスターで認証する必要があります。Atlas 管理API を使用して、データベースユーザーを作成および管理できます。
Atlas 管理APIを使用して Atlas クラスターを管理するには、次のいずれかの認証方法でAPIリクエストを認証する必要があります。
サービス アカウント アクセス トークン（OAuth 2.0）
APIキー（HTTPダイジェスト認証）
これらの方法の詳細については、Atlas Administration API認証メソッドを参照してください。
次のセクションでは、サービス アカウントとAPIキーを使用して、Atlas 組織とプロジェクトへのプログラムによるアクセスを構成する方法について説明します。
注意
MongoDB Atlas共有責任モデルは、安全で回復力のあるデータ環境を維持するためのMongoDBとそのカスタマーの補完的な役割を定義します。このフレームワークの下、 MongoDB は基礎のプラットフォームのセキュリティと運用上の整合性を管理しますが、カスタマーは特定の配置の構成、管理、データ ポリシーに責任を負います。所有者のセキュリティと運用の優れ性の詳細な内訳については、共有責任モデルを参照してください。
必要なアクセス権
組織のサービス アカウントまたはAPIキーを作成するには、その組織に対するOrganization Ownerアクセス権が必要です。
プロジェクトへのサービス アカウントへのアクセスを許可するには、プロジェクト を所有する組織への Organization Owner アクセス権が必要です。
プロジェクトへのAPIキー アクセスを許可するには、そのプロジェクトに対する Project Owner アクセス権が必要です。
任意: IPアクセス リストが必要
Atlas UI を使用して組織を作成すると、Atlas では Atlas 管理APIのIP アクセス リストが自動的に必要になります。これにより、IP アクセス リストで指定したロケーション ベースのIPまたはCIDRアドレスからのAPIリクエストのみにAPIリクエストが制限されます。IP アクセス リストエントリなしで Atlas 管理APIにリクエストを送信すると、サーバーは403 ステータス コードで応答します。
この機能を無効にすると、 IP アクセス リストが空である限り、インターネット上のどのアドレスからでもAPIリクエストを行うことができます。IP アクセス リストエントリを追加すると、そのIPアドレスからのリクエストのみがリクエストを行うことができます。
注意
IP アクセス リストは、サービス アカウント アクセス トークンの使用に適用され、作成または取り消しではありません。任意のIPアドレスからトークンを生成できますが、そのIPアドレスがアクセスリストにある場合のみ、APIを呼び出すことができます。
組織の作成後、すべての Atlas Administration API リクエストに対して IP アクセス リストを要求するように組織を設定するには、次の手順を実行します。
Atlas で、Organization Settings ページに移動します。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
サイドバーで、Organization Settings をクリックします。
[ Organization Settings ]ページが表示されます。
組織へのプログラムによるアクセスの付与
プロジェクトへのプログラムによるアクセスの付与
これら 2 つの認証方法の詳細については、Atlas 管理API認証メソッド を参照してください。
プロジェクトへのAPIキーアクセスを付与するには、そのプロジェクトに対する Project Access Manager または Project Owner アクセス権が必要です。
プロジェクトからのプロジェクト アクセス権の追加
組織のサービス アカウントやAPIキーをまだ作成していないAPIは、プロジェクト用にそれらを作成して、Atlas Administration プロジェクトへのアクセスを許可します。プロジェクトに対して作成したサービス アカウントまたはAPIキーは、権限 Organization Member を持つ親組織に自動的に追加されます。
APIリクエストを行う
Atlas 管理API、リクエストを認証するために、サービス アカウントまたはAPIキーの 2 つの認証方法のいずれかを使用します。次の手順を完了するには、希望する認証方法を構成するときに保存したキーまたはシークレットが必要です。
すべての Atlas Administration API エンドポイントには次のベース URL があります。
https://cloud.mongodb.com/api/atlas/<version>
重要
MongoDB は、セキュリティを強化するために HTTPS URL を使用します。HTTP URL を使用すると、301ステータスコードが返されます。
あるいは、OpenAPI v3 仕様 をサポートする任意のツールを使用して、コードサンプルやモック サーバーを生成することもできます。たとえば、Atlas Admin API 仕様をPostman にインポートして curl コマンドを生成できます。
警告
Postman を使用して HTTP URL を使用すると、期待どおりに301ステータスコードが返されます。しかし、このシナリオでは、Postman が HTTPS でリクエストを自動的に再試行する可能性がありますが、同時に再試行リクエストからヘッダーと本文を削除することがあります。これにより、301ではなく401のステータスコードが返され、リクエストが失敗した理由を特定することが困難になります。
以下の方法で、Postman を使用して curl コマンドを生成します。
MongoDB Atlas Administration APIドキュメントで、ナビゲーション バーの Download source をクリックします。
次のステップ
Atlas Administration API の詳細については、「Atlas Administration API リファレンス」を参照してください。
プログラムによる Atlas Administration API へのアクセスを管理するには、次のいずれかの手順を参照してください。