ログコレクションジョブの作成

項目一覧

Resource

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

注意

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

ログコレクションジョブを作成すると、 MongoDB Ops Managerはバックグラウンドジョブを開始して、指定されたMongoDB Ops Manager配置からログをダウンロードします。このエンドポイントを使用して、新しいログコレクションジョブを作成します。

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

Resource

POST /groups/{GROUP-ID}/logCollectionJobs

リクエストパスパラメーター

名前	タイプ	必要性	説明
グループ ID	string	必須	ログコレクションリクエストジョブを識別する一意な 24 桁の 16 進数のstring 。

リクエストクエリパラメータ

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

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

false

リクエストボディパラメータ

名前	タイプ	必要性	説明
resourceType	string	必須	ログを収集するリソースのタイプ。次のいずれかの値である必要があります。 `CLUSTER`、シャーディングされたクラスターの場合。 `PROCESS`、レプリカセット内のノードの場合 `REPLICASET`、レプリカセットの場合は。
resourceName	string	必須	ログを収集するリソースの名前。リソースタイプによって値が定義されます。 `CLUSTER` `resourceType`の場合、値は配置名または`CLUSTER-ID`の名前です。たとえば、 `my-deployment` 。この値を取得するには、 /groups/{GROUP-ID}/clusters/{CLUSTER-ID}エンドポイントを使用します。 `PROCESS` `resourceType`の場合、値はレプリカセットの名前とそれに続くノード名です。たとえば、 `Cluster0-shard-1-node-0` 。この値を取得するには、 /groups/{PROJECT-ID}/automationConfigエンドポイントを使用します。値は`processes.name`パラメーターにあります。レプリカセットの名前、ノードのリスト、およびその他の情報を取得するには、クラスターにアクセスして`rs.conf()._id`と`rs.status()`を実行します。 `REPLICASET` `resourceType`の場合、値はクラスター内のレプリカセットの名前とそれに続くシャード名です。たとえば、 `test-123abc-shard-0` 。
sizeRequestedPerFileBytes	数値	必須	各ログファイルのサイズ（バイト単位）。
logTypes	配列	必須	収集するログのタイプを指定する文字列の配列。各配列要素は、次の値のいずれかである必要があります。 `AUTOMATION_AGENT` `BACKUP_AGENT` `MONITORING_AGENT` `MONGODB` `FTDC`
編集済み	ブール値	必須	`true`に設定されている場合、このジョブに関連する応答内のメール、ホスト名、アドレス、名前空間は、ランダムなIP APIstring値に置き換えられます。

応答

名前	タイプ	説明
id	string	作成されたログコレクションジョブの一意の識別子です。

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?pretty=true" \
6      --data '
7        {
8          "resourceType": "PROCESS",
9          "resourceName": "my_deployment_1",
10          "redacted": true,
11          "sizeRequestedPerFileBytes": 10000000,
12          "logTypes": [
13              "FTDC",
14              "MONGODB",
15              "AUTOMATION_AGENT"
16          ]
17        }'

応答例

応答ヘッダー

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 201 Created
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}

レスポンス本体

1 { "id": "5c81086e014b76a3d85e1113" }

戻る

ログ収集ジョブからのログのダウンロード

ログコレクションジョブの拡張

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?pretty=true" \
6	--data '
7	{
8	"resourceType": "PROCESS",
9	"resourceName": "my_deployment_1",
10	"redacted": true,
11	"sizeRequestedPerFileBytes": 10000000,
12	"logTypes": [
13	"FTDC",
14	"MONGODB",
15	"AUTOMATION_AGENT"
16	]
17	}'

注意