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

項目一覧

Resource

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

注意

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

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

すでに有効期限が切れているログコレクションジョブの期間を延長することはできません。

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

Resource

PATCH /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}

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

名前	タイプ	必要性	説明
グループ ID	string	必須	ログコレクションリクエストジョブを識別する一意な 24 桁の 16 進数のstring 。
JOB-ID	string	必須	再試行するログコレクションジョブを識別する一意の 24 桁の 16 進数string 。プロジェクトに関連付けられている ID を取得するには、「1 つのプロジェクトのすべてのログコレクションジョブを取得」エンドポイントを使用します。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

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

false

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

名前	タイプ	必要性	説明
expirationDate	string	必須	タイムスタンプ（ UNIXエポックからの経過秒数単位）このジョブが期限切れになった場合。これは、ジョブが作成された時点から最大6か月後です。リクエストが行われる時刻に先行する日付は指定できません。

応答

このエンドポイントは、レスポンス本体を返しません。

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?pretty=true" \
6      --data '
7       {
8         "expirationDate": "2019-04-06T12:02:54Z"
9       }'

応答例

応答ヘッダー

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}

レスポンス本体

このエンドポイントは、レスポンス本体を返しません。

戻る

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

失敗したログコレクションジョブの再試行

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?pretty=true" \
6	--data '
7	{
8	"expirationDate": "2019-04-06T12:02:54Z"
9	}'

注意