Docs Menu
Docs Home
/ /
配置のインポート
Docs Home
/ /
リソース
/
配置のインポート
Docs Home
/
管理
/
Ops Manager
/
API
/
リソース
/
配置のインポート

インポート配置リクエストの作成

注意

グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。

新しいインポート配置リクエストを作成して、既存のMongoDBプロセスを Ops Managerオートメーションに追加します。このエンドポイントは、複数のMongoDBプロセスをモニタリングとオートメーション管理の両方にインポートするプロセスを開始します。

重要

この機能は Ops Manager 8.0.13 以降で使用可能です。

インポートされた配置は、プロジェクトのオートメーション構成に追加されます。 MongoDB Agent はプロセスの監視を開始し、オートメーション構成に従ってそれらを管理します。

必須のロール

このエンドポイントにはProject Automation Admin ロールが必要です。

エンドポイント

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

POST /automation/importDeployment/{PROJECT-ID}

リクエスト

path パラメータ

名前
タイプ
必要性
説明

プロジェクトID

string

必須

インポートされた配置を所有する プロジェクトの一意の識別子。

クエリ パラメータ

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前
説明

status

HTTPレスポンス コード

content

期待される応答本体

false

ボディ パラメータ

名前
タイプ
必要性
説明

シードホストポート

string

必須

検出のために接続するシードMongoDBプロセスのホスト名とポート（例: mongodb1.example.com:27017）。

requestedProcesses

配列

必須

インポートを続行する前に検出する必要があるMongoDBプロセスを表すホスト名とポート文字列の配列。

timeouts

オブジェクト

任意

さまざまなインポート フェーズのタイムアウト設定。

timeouts.SeedHostConnectionSec

数値

任意

シードホストへの接続のタイムアウト（秒）。範囲: 60-86400 秒。デフォルトでは、システム設定が使用されます。

timeouts.processesDiscoverySec

数値

任意

すべての必要なプロセスを検出するためのタイムアウト（秒）。範囲: 60-86400 秒。デフォルトでは、システム設定が使用されます。

timeouts.automationMongoDB

数値

任意

オートメーションのインポートを完了するためのタイムアウト（秒）。範囲: 60-86400 秒。デフォルトでは、システム設定が使用されます。

timeouts.goalStateSec

数値

任意

オートメーションの目標状態に達するためのタイムアウト（秒）。範囲: 60-86400 秒。デフォルトでは、システム設定が使用されます。

authMechanism

string

任意

MongoDBプロセスに接続するための認証メカニズム。可能な値は次のとおりです。

  • MONGODB_CR （これは SCRAM-SHA-1、SCRAM-SHA-256、MONGODB-CR をカバーします。）

  • GSSAPI

  • PLAIN

  • MONGODB_X509

  • NONE

username

string

条件付き

MongoDBプロセスに認証するためのユーザー名。 authMechanism が指定されている場合は必須です。

パスワード

string

条件付き

MongoDBプロセスに認証するためのパスワード。 authMechanism が MONGODB_CR の場合は必須です。

MongoDB Ops Manager は応答ドキュメントにこのパラメーターを含めません。

adminDb

string

任意

認証するデータベース。デフォルト: admin。

pemKeyFilePath

string

任意

TLSクライアント認証の PEM キーファイルへのパス。

pemKeyFilePassword

string

任意

PEM キーファイルのパスワード。

MongoDB Ops Manager は応答ドキュメントにこのパラメーターを含めません。

adminKerberosKeytab

string

任意

GSSAPI認証用の Kerberos キータブファイルへのパス。

adminLdapGroupDn

string

任意

PLAIN認証の LDAP グループ識別名。

saslServiceName

string

任意

GSSAPI認証の SASL サービス名。

caFilePath

string

任意

TLS 接続の証明機関ファイルへのパス。

clusterCaFilePath

string

任意

TLS 接続のクラスター認証局ファイルへのパス。

clientCertificateMode

string

任意

TLS 接続のクライアント証明書モード。

応答

インポートリクエストが正常に送信された場合、 HTTPステータスが 200 の空の成功応答を返します。

注意

このエンドポイントは、作成された インポートリクエストのIDを返しません。インポートリクエストのステータスを追跡するには、 Get Import Deployment requests エンドポイントを使用してプロジェクトのすべてのリクエストを一覧表示し、リクエストの作成時間やその他のプロパティによってリクエストを識別します。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/automation/importDeployment/{PROJECT-ID}?pretty=true" \
     --data '{
       "seedHostport": "mongodb1.example.com:27017",
       "requiredProcesses": [
         "mongodb1.example.com:27017",
         "mongodb2.example.com:27017",
         "mongodb3.example.com:27018"
       ],
       "timeouts": {
         "seedHostConnectionSec": 300,
         "processesDiscoverySec": 600,
         "automationImported": 600,
         "goalStateSec": 1200
       },
       "authMechanism": "MONGODB_CR",
       "username": "admin",
       "password": "password123",
       "adminDb": "admin"
     }'

応答例

応答ヘッダー

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}

レスポンス本体

{}

戻る

配置のインポート

次へ

インポート配置リクエストの取得

項目一覧