リクエスト

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

メソッド	URI
POST	/api/{regionCode}-v1/logs/search

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`interval`	String	Optional	照会周期 `5m` (デフォルト) <例> `1d`、`1h`、`1m`
`keyword`	String	Optional	照会キーワードすべて検索 (デフォルト)
`logTypes`	String	Optional	ログのタイプすべて検索 (デフォルト) <例> `SYSLOG`、`security_log`、`tomcat`
`timestampFrom`	String	Optional	照会開始日 Unix Timestamp形式
`timestampTo`	String	Optional	照会終了日 Unix Timestamp形式
`pageNo`	Integer	Optional	ページ番号 1~100 (デフォルト: 1)
`pageSize`	Integer	Optional	ページごとの項目数 10~100 (デフォルト: 10)

リクエスト例

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

curl --location --request POST 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/logs/search' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
-date '{
  "interval": "30m",
  "pageNo": 1,
  "pageSize": 10
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	Integer	-	レスポンスステータスコード
`message`	String	-	レスポンスステータスメッセージ
`result`	Object	-	レスポンス結果
`result.pageSize`	Integer	-	ページごとの項目数
`result.currentPage`	Integer	-	現在のページ番号
`result.totalPage`	Integer	-	総ページ番号
`result.totalCount`	Integer	-	ログ数の合計
`result.isPaged`	Boolean	-	追加ページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`result.chartData`	Array	-	ログ数ログの発生時間 Unix Timestamp形式ログ発生数
`result.searchResult`	Array	-	照会結果

`searchResult`

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

フィールド	タイプ	必須の有無	説明
`logTime`	Integer	-	ログの発生時間 Unix Timestamp形式
`logType`	String	-	ログのタイプ
`servername`	String	-	ログ収集対象のサーバ名
`logDetail`	String	-	ログの内容

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

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

レスポンス例

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

{
    "code": 0,
    "message": "リクエストが正常に処理されました。",
    "result": {
        "pageSize": 3,
        "currentPage": 1,
        "totalPage": 1695,
        "totalCount": 5083,
        "isPaged": true,
        "chartData": [
            [
                1731987000000,
                2111
            ],
            [
                1731988800000,
                2620
            ],
            [
                1731990600000,
                352
            ]
        ],
        "searchResult": [
            {
                "logTime": "1731990853000",
                "logType": "CDB_MSSQL",
                "servername": "m-100514954-002",
                "logDetail": "select \r\n\tcase \r\n\t\twhen count(a.name) + count(b.name) = 0 then 'not exists'\r\n\t\twhen count(a.name) + count(b.name) = 1 then 'stop'\r\n\t\twhen count(a.name) + count(b.name) = 2 then 'start'\r\n\tend xe_status\r\nfrom sys.server_event_sessions a\r\n\tleft join sys.dm_xe_sessions b\r\n\ton a.name = b.name \r\nwhere a.name = 'AuditLog'"
            },
            {
                "logTime": "1731990847925",
                "logType": "ses_log",
                "servername": "{name=ses-test-m-62vl}",
                "logDetail": "[2024-11-19T13:34:07,621][WARN ][o.o.p.c.u.JsonConverter  ] [ses-test-m-62vl] Json Mapping Error: Cannot invoke \"java.lang.Long.longValue()\" because \"this.cacheMaxSize\" is null (through reference chain: org.opensearch.performanceanalyzer.collectors.CacheConfigMetricsCollector$CacheMaxSizeStatus[\"Cache_MaxSize\"])"
            },
            {
                "logTime": "1731990847000",
                "logType": "CDB_MSSQL",
                "servername": "m-100514954-001",
                "logDetail": "select \r\n\tcase \r\n\t\twhen count(a.name) + count(b.name) = 0 then 'not exists'\r\n\t\twhen count(a.name) + count(b.name) = 1 then 'stop'\r\n\t\twhen count(a.name) + count(b.name) = 2 then 'start'\r\n\tend xe_status\r\nfrom sys.server_event_sessions a\r\n\tleft join sys.dm_xe_sessions b\r\n\ton a.name = b.name \r\nwhere a.name = 'AuditLog'"
            }
        ]
    }
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Cloud Log Analytics