リクエスト

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

メソッド	URI
POST	/getIDSList

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`startDateTime`	Long	Required	セキュリティイベント照会開始時間(Unix timestamp) <例> 1720540427000
`endDateTime`	Long	Required	セキュリティイベント照会終了時間(Unix timestamp) <例> 1720540427000
`page`	Integer	Required	ページ番号
`countPerPage`	Integer	Required	ページごとの表示数
`order`	String	Optional	イベント検知時間のソート順序 `asc` \| `desc`(デフォルト) `asc`: 昇順 `desc`: 降順
`regionCode`	String	Optional	リージョンコード `KR` \| `DEN` \| `JPN` \| `SGN` \| `USWN` `KR`: 韓国 `DEN`: ドイツ `JPN`: 日本 `SGN`: シンガポール `USWN`: 米国
`zoneName`	String	Optional	ゾーン区分 `KR-1` \| `KR-2`
`attackType`	String	Optional	検知された攻撃タイプ
`attackIp`	String	Optional	攻撃者 IPアドレス
`targetIp`	String	Optional	攻撃対象の IPアドレス

リクエスト例

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

curl --location --request POST 'https://securitymonitoring.apigw.ntruss.com/vsecuritymonitoring/v1/getIDSList'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
  "startDateTime": 1719849227000,
  "endDateTime": 1720108427000,
  "page": 1,
  "countPerPage": 20
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`returnCode`	Integer	-	リクエストに対する処理結果コード
`idsDataList[]`	Array	-	IDSセキュリティイベントリスト
`idsDataList[].ticketId`	String	-	セキュリティイベントに付与された固有番号
`idsDataList[].date`	String	-	セキュリティイベントの検知時間(Unix timestamp)
`idsDataList[].product`	String	-	サービス区分 `IDS` \| `IDS_V2` `IDS`: Classic環境 `IDS_V2`: VPC環境
`idsDataList[].reportType`	String	-	レポート区分
`idsDataList[].eventNm`	String	-	検知されたセキュリティイベントの名前
`idsDataList[].attackerIp`	String	-	攻撃者 IPアドレス
`idsDataList[].targetIp`	String	-	攻撃対象の IPアドレス
`idsDataList[].attackType`	String	-	検知された攻撃タイプ
`idsDataList[].region`	String	-	リージョン
`idsDataList[].zoneName`	String	-	ゾーン区分 `KR-1` \| `KR-2`
`idsDataList[].platForm`	String	-	プラットフォーム区分 `CLASSIC` \| `VPC`
`idsDataList[].vpcName`	String	-	VPC名
`returnMessage`	String	-	リクエストに対する処理結果メッセージ
`totalRows`	Integer	-	照会されたリストの総数
`page`	Integer	-	リクエストページ番号

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

Security Monitoring APIで共通して使用されるエラーコードの詳細は、Security Monitoringの共通エラーコードをご参照ください。

レスポンス例

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

{
    "returnCode": 0,
    "idsDataList": [
        {
            "ticketId": "526068433",
            "date": "1720044438000",
            "product": "IDS_V2",
            "reportType": "Detection analysis",
            "attackerIp": null,
            "targetIp": "***.***.***.***",
            "attackType": "SSH Bruteforce",
            "region": "Korea",
            "zoneName": "KR-2",
            "platForm": "VPC",
            "vpcName": "kr-sm-vpc"
        }
    ],
    "returnMessage": "SUCCESS",
    "totalRows": 1,
    "page": 1
}

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

リクエスト
レスポンス

タグ

Security Monitoring