AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

オートメーション構成を取得する

プロジェクトのオートメーション構成によって、MongoDB プロセスとエージェントの最終状態が決まります。 MongoDB Agent は、指定された目的に従って配置を構築します。

重要

プロジェクトのオートメーション構成には、パスワードやキー値などの機密情報が含まれる場合があります。機密情報をリダクションするオートメーション構成を取得するには、/groups/{グループ ID}/automationConfig/noSecrets エンドポイントとなる接続されたデバイスを使用します。

このリソースにはProject Automation Adminロールが必要です。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{PROJECT-ID}/automationConfig
名前
タイプ
必要性
説明

プロジェクトID

string

必須

オートメーション構成を所有するグループの一意の識別子。

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体をpretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

これらのパラメーターを確認するには、「オートメーション構成パラメーター 」を参照してください。

curl --user "{publicApiKey}:{privateApiKey}" --digest \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \ --output currentAutomationConfig.json
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

この構成の例については、「オートメーション構成の例 」を参照してください。