サーバログ収集の設定

Prev Next

Classic環境で利用できます。

Classic環境のサーバに対するログ収集を設定します。ログ収集の設定が完了したら、サーバにログ収集エージェントをインストールします。

参考

ログ収集エージェントをインストールしないと Cloud Log Analyticsを通じてログを収集できません。ログ収集エージェントのインストール方法は、サーバログ収集エージェントのインストールをご参照ください。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/{regionCode}-v1/classic/servers/collecting-infos

リクエストヘッダ

Cloud Log Analytics APIで共通して使用されるヘッダの詳細は、Cloud Log Analyticsのリクエストヘッダをご参照ください。

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

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Required リージョンコード
  • kr | sgn | jpn | uswn | den
    • kr: 韓国リージョン
    • sgn: シンガポールリージョン
    • jpn: 日本リージョン
    • uswn: 米国西部リージョン
    • den: ドイツリージョン

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
collectingInfos Array Required ログ収集設定

collectingInfos

collectingInfosの説明は次の通りです。

フィールド タイプ 必須の有無 説明
logPath String Required 収集対象ログのパス
  • Cloud Log Analyticsコンソールの Managementメニューを参照
  • <例>/var/log/messages、/var/log/secure*
logTemplate String Required 収集対象のログテンプレート
  • Cloud Log Analyticsコンソールの Managementメニューを参照
  • <例>APACHE、TOMCAT
logType String Required 収集対象のログタイプ
  • Cloud Log Analyticsコンソールの Managementメニューを参照
  • <例>SYSLOG、security_log
servername String Required ログ収集対象のサーバ名
osType String Required ログ収集対象のサーバ OS
instanceNo Integer Required ログ収集対象のサーバインスタンス番号
ip String Required ログ収集対象のサーバ IPアドレス

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/classic/servers/collecting-infos' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--data '{
      "collectingInfos": [   
            {
            "logPath": "/var/log/messages",
            "logTemplate": "SYSLOG",
            "logType": "SYSLOG",
            "servername": "s1933b2316e4",
            "osType": "CentOS 7.3 (64-bit)",
            "ip": "***.***.***.***",
            "instanceNo": 27231808
            }
      ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer - レスポンスステータスコード
message String - レスポンスステータスメッセージ
result Object - レスポンス結果
result.configKey String - ログ収集エージェントの Install Key
result.usage String - ログ収集エージェントのインストールコマンド

レスポンスステータスコード

Cloud Log Analytics APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Log Analyticsのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "リクエストが正常に処理されました。",
    "result": {
        "configKey": "*********",
        "usage": "curl -s http://cm.cla.ncloud.com/setUpCla/********* | sudo sh"
    }
}