Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
ログ収集ジョブ

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

項目一覧

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

注意

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

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

ベース URL: https://cloud.mongodb.com/api/public/v 1.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 。

  • PROCESS resourceTypeの場合、値はレプリカセットの名前とそれに続くノード名です。 たとえば、 Cluster0-shard-1-node-0 。

    レプリカセットの名前、ノードのリスト、およびその他の情報を取得するには、クラスターにアクセスしてrs.conf()._idとrs.status()を実行します。

  • REPLICASET resourceTypeの場合、値はクラスター内のレプリカセットの名前とそれに続くシャード名です。 たとえば、 test-123abc-shard-0 。

sizeRequestedPerFileBytes

数値

必須

各ログファイルのサイズ（バイト単位）。

logTypes

配列

必須

収集するログのタイプを指定する文字列の配列。 各配列要素は、次の値のいずれかである必要があります。

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

編集済み

ブール値

必須

trueに設定されている場合、このジョブに関連する 応答内のメール、ホスト名、 アドレス、名前空間は、ランダムなIP APIstring値に置き換えられます。

logCollectionFromDate

string

任意

ISO8601 でのログコレクションの開始日時 形式（UTC）。日付と時刻は過去のものである必要があります。

logCollectionToDate

string

logCollectionFromDateを使用する場合は必須です。

ISO8601 のログコレクションの終了日時 形式（UTC）。日付と時刻は過去のものである必要があります。 logCollectionToDateはlogCollectionFromDateの後になければなりません。

応答

名前
タイプ
説明

id

string

作成されたログ コレクション ジョブの一意の識別子です。

リクエストの例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request POST "https://cloud.mongodb.com/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         "logCollectionFromDate": "2024-07-18T13:53:17Z",
18         "logCollectionToDate": "2024-07-18T15:53:17Z"
19       }'

応答例

応答ヘッダー

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" }

戻る

ログのダウンロード

次へ

拡張