ログ コレクション ジョブの拡張
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ログ コレクション ジョブを作成すると、Cloud Manager は指定された Cloud Manager の配置からログをダウンロードするためのバックグラウンド ジョブを開始します。 各ジョブは指定された有効期限で作成されます。 このエンドポイントを使用して、既存のログ コレクション ジョブの有効期限を延長します。
すでに有効期限が切れているログ コレクション ジョブの期間を延長することはできません。
ベース URL: https://cloud.mongodb.com/api/public/v 1.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 にするかどうかを示すフラグ 形式。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
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://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?pretty=true" 6 --data ' 7 { 8 "expirationDate": "2019-04-06T12:02:54Z" 9 }'
応答例
応答ヘッダー
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
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}
レスポンス本体
このエンドポイントは、レスポンス本体を返しません。