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

項目一覧

必須のロール

Resource
リクエスト
path パラメータ
クエリパラメータ
ボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

必須のロール

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

Resource

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

GET /groups/{PROJECT-ID}/automationConfig

リクエスト

path パラメータ

名前	タイプ	必要性	説明
プロジェクトID	string	必須	自動化構成を所有するグループの一意の識別子。

クエリパラメータ

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

ボディパラメータ

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

応答

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

リクエストの例

curl --user "{publicApiKey}:{privateApiKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \
     --output currentAutomationConfig.json

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

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

戻る

オートメーション構成のリソース

オートメーション構成の更新