オートメーション構成のリソース
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
この API は、プロジェクトのオートメーション構成を管理するためのautomationConfigリソースを提供します。 構成は、配置内のさまざまな MongoDB クラスター、レプリカセット、スタンドアロンを定義し、各プロセスの実行方法を定義します。 オートメーションは、指定された目的に従って配置を構築します。 オートメーションを使用する各MongoDB Agentは、ホスト上で実行されるMongoDBプロセスに責任を負います。 この構成では、配置の MongoDB エージェントの 設定も指定されます。
実行中の MongoDB プロセスが定義された構成と一致する場合、プロセスは「成功状態」になります。 すべてのホスト上のすべてのプロセスが目的の状態になると、配置自体が目的の状態になります。
オートメーション構成を更新するには、ユーザー アカウントのアクセス リストにある IP アドレスからリクエストを発行する必要があります。
オートメーション構成の追加のコピー
MongoDB Agent はmms-cluster-config-backup.jsonファイルに構成のコピーを保存します。 オートメーションは、オートメーションが目的の状態 に達することができた最新バージョンの構成を保存します。 エージェントが構成の変更を処理できない場合、古いバージョンの構成を保存し続けます。
オートメーション構成パラメーター
オートメーション構成には、Cloud Manager のインスタンス、エージェント、クラスター、セキュリティに関する大量の情報が含まれています。 この複雑さでは、これらのパラメーターは独自のリファレンス ページとして見つけることができます。
完全なオートメーション構成ファイルの例を確認するには、「オートメーション構成の例 」を参照してください。
エンドポイント
以下は、 オートメーション構成リソース で使用できるエンドポイントを一覧表示したものです。
方式 | エンドポイント | 説明 |
|---|---|---|
GET | 現在のオートメーション構成を取得する | |
PUT | 現在のオートメーション構成を置き換える | |
POST | MongoDB Agent を更新する | |
GET | 現在のバックアップログ設定を取得する | |
PUT | 現在のバックアップログ設定を更新する | |
GET | 現在のモニタリング ログ設定を取得する | |
PUT | 現在のモニタリング ログ設定を更新する |