ListDefaultCollectorConfigurations を呼び出して、コレクターのデフォルト構成ファイルを取得します。
デバッグ
リクエストヘッダー
この操作では、共通リクエストヘッダーのみを使用します。詳細については、「共通リクエストパラメーター」をご参照ください。
リクエスト構造
GET /openapi/beats/default-configurations HTTP/1.1
リクエストパラメーター
| パラメーター | タイプ | 位置 | 必須 | 例 | 説明 |
| resType | String | クエリ | はい | fileBeat | コレクタータイプ。有効な値:
|
| resVersion | String | クエリ | はい | 6.8.5_with_community | コレクターバージョン。コレクターによってデプロイされるマシンのタイプが異なり、オプションのバージョンも異なります。具体的な説明は次のとおりです。
|
| sourceType | String | クエリ | いいえ | ECS | マシンをデプロイするコレクターのタイプを指定し、指定しない場合はすべてを返します。有効な値:
|
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| RequestId | String | 8BAE3C32-8E4A-47D6-B4B0-95B5DE643BF5 | リクエストの ID。 |
| Result | Result の配列 | 戻り結果。 | |
| content | String | - key: log\n title: ログファイルコンテンツ\n description: >\n ログファイルの行が含まれています。\n fields:\n ...... | 構成ファイルの内容。 |
| fileName | String | fields.yml | 構成ファイルの名前。 |
例
サンプルリクエスト
GET /openapi/beats/default-configurations?ResVersion=6.8.5 _with_community&resType=fileBeat&sourceType=ECS HTTP/1.1 パブリックリクエストヘッダー
サンプルの成功レスポンス
JSON フォーマット
{ "Result": [ { "fileName": "fields.yml", "content": "- key: log\n title: ログファイルコンテンツ\n description: >\n ログファイルの行が含まれています。\n fields:\n ......" }, { "fileName": "filebeat.yml", "content": "###################### Filebeat 構成例 #########################\n\n# このファイルは構成ファイルの例です ......" } ], "RequestId": "8BAE3C32-8E4A-47D6-B4B0-95B5DE643BF5" }
エラーコード
エラーコードのリストについては、 API エラーセンター をご覧ください。