重要
それぞれの 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 組織とプロジェクトへのプログラムによるアクセスを構成する方法について説明します。
必要なアクセス権
組織のサービス アカウントまたはAPIキーを作成するには、その組織への Organization Owner アクセス権が必要です。
プロジェクトへのサービス アカウントへのアクセスを許可するには、プロジェクト を所有する組織への Organization Owner アクセス権が必要です。
プロジェクトへのAPIキー アクセスを許可するには、そのプロジェクトに対する Project Owner アクセス権が必要です。
オプション: IPアクセス リストが必要
Atlas UI を使用して組織を作成すると、Atlas では Atlas Administration APIのIP アクセス リストが自動的に必要になります。これにより、 IP アクセス リストで指定したロケーション ベースのIPまたは CIDR アドレスからの API リクエストのみにAPIリクエストが制限されます。 IP アクセス リストエントリなしで Atlas Administration APIにリクエストを送信すると、サーバーは ステータス403 コードで応答します。
この機能を無効にすると、 IP アクセス リストが空である限り、インターネット上のどのアドレスからでもAPIリクエストを行うことができます。 IP アクセス リストエントリを追加すると、そのIPアドレスからのリクエストのみがリクエストを行うことができます。
注意
IP アクセス リストは、サービス アカウント アクセス トークンの使用に適用され、作成または取り消しではありません。任意のIPアドレスからトークンを生成できますが、そのIPアドレスがアクセスリストにある場合のみ、APIを呼び出すことができます。
組織の作成後、すべての Atlas Administration API リクエストに対して IP アクセス リストを要求するように組織を設定するには、次の手順を実行します。
Atlas で、Organization Settings ページに移動します。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
サイドバーで、Organization Settings をクリックします。
[ Organization Settings ]ページが表示されます。
組織へのプログラムによるアクセスの付与
プロジェクトへのプログラムによるアクセスの付与
これら 2 つの認証方法の詳細については、「 Atlas Administration API認証メソッド 」を参照してください。
プロジェクトにAPIキーアクセスを付与するには、そのプロジェクトに対するProject Access ManagerまたはProject Ownerアクセス権が必要です。
プロジェクトからのプロジェクト アクセス権の追加
組織用のサービス アカウントまたは API キーをまだ作成していない場合は、プロジェクト用に作成して、そのプロジェクトに Atlas Administration API へのアクセス権を付与できます。プロジェクト用に作成したサービス アカウントまたは API キーは、Organization Member 権限を持つ親組織に自動的に追加されます。
APIリクエストを行う
Atlas Administration 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 管理APIドキュメントで、ナビゲーション バーの Download source をクリックします。
次のステップ
Atlas Administration API の詳細については、「Atlas Administration API リファレンス」を参照してください。
プログラムによる Atlas Administration API へのアクセスを管理するには、次のいずれかの手順を参照してください。