GetDeletedExceptionRule

Prev Next

VPC環境で利用できます。

ユーザーにより削除された例外ルールリストを照会します。

リクエスト

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

メソッド URI
GET /deleted-exception-rules

リクエストヘッダ

Webshell Behavior Detector APIで共通して使用されるヘッダの詳細は、Webshell Behavior Detectorの共通ヘッダをご参照ください。

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

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
pageIndex Integer Required ページ番号
pageSize Integer Required ページ表示数

リクエスト例

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

curl --location --request GET 'https://wbd.apigw.ntruss.com/api/v1/deleted-exception-rules?pageIndex=0&pageSize=2' \
--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' \
--header 'X-NCP-USE_PLATFORM_TYPE: VPC'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
success Boolean - リクエスト処理の有無
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
content Array - 例外ルールリスト
totalCount Integer - レスポンス結果数
pageSize Integer - ページ表示数
pageIndex Integer - ページ番号
totalPages Integer - ページの総数

content

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

フィールド タイプ 必須の有無 説明
disabled Boolean - 例外ルールは無効化かどうか
  • サブアカウントの場合に表示
  • true | false
    • true: 無効化
    • false: 有効化
actionName String - サブアカウントのアクション名
  • サブアカウントの場合に表示
permission Enum - サブアカウントの権限
  • サブアカウントの場合に表示
  • Allow | Deny
exceptedRuleId String - 例外ルール ID
exceptedRuleName String - 例外ルール名
exceptTargetType String - 例外対象のタイプ
  • serverGroup | everyServer | server
    • serverGroup: サーバグループ
    • everyServer: すべてのサーバ
    • server: 特定のサーバ
exceptTarget String - 例外対象のインスタンス ID
exceptTargetName String - 例外対象の名前
processName String - 比較対象のプロセス名
processNameCondition String - プロセス名の比較条件
  • EQUAL | NOT_USE | START | END
    • EQUAL: 完全に一致
    • NOT_USE: 比較条件を使用しない
    • START: 先頭の文字列が一致
    • END: 末尾の文字列が一致
processArg String - 比較対象のプロセス引数
processArgCondition String - プロセス引数の比較条件
  • EQUAL | NOT_USE | START | END
    • EQUAL: 完全に一致
    • NOT_USE: 比較条件を使用しない
    • START: 先頭の文字列が一致
    • END: 末尾の文字列が一致
executor String - 比較対象の実行アカウント
executorCondition String - 実行アカウントの比較条件
  • EQUAL | NOT_USE | START | END
    • EQUAL: 完全に一致
    • NOT_USE: 比較条件を使用しない
    • START: 先頭の文字列が一致
    • END: 末尾の文字列が一致
processNameOfParent String - 比較対象の親プロセス名
processNameOfParentCondition String - 親プロセス名の比較条件
  • EQUAL | NOT_USE | START | END
    • EQUAL: 完全に一致
    • NOT_USE: 比較条件を使用しない
    • START: 先頭の文字列が一致
    • END: 末尾の文字列が一致
processArgOfParent String - 比較対象の親プロセス引数
processArgOfParentCondition String - 親プロセス引数の比較条件
  • EQUAL | NOT_USE | START | END
    • EQUAL: 完全に一致
    • NOT_USE: 比較条件を使用しない
    • START: 先頭の文字列が一致
    • END: 末尾の文字列が一致
executorOfParent String - 比較対象親プロセスの実行アカウント
executorOfParentCondition String - 親プロセス実行アカウントの比較条件
  • EQUAL | NOT_USE | START | END
    • EQUAL: 完全に一致
    • NOT_USE: 比較条件を使用しない
    • START: 先頭の文字列が一致
    • END: 末尾の文字列が一致
createdTime Integer - 例外ルールの作成日時(Timestamp)
deletedTime Integer - 例外ルールの削除日時(Timestamp)
isDeleted Boolean - 例外ルールは削除されたかどうか
  • true | false
    • true: 削除済み
    • false: 削除されていない
memo String - メモ
memberNo Integer - VM使用会員番号
groupIsDeleted Boolean - サーバグループは削除されたかどうか
  • true | false
    • true: 削除済み
    • false: 削除されていない

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

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

レスポンス例

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

{
    "success": true,
    "code": 0,
    "message": "success",
    "result": {
        "content": [
            {
                "disabled": false,
                "actionName": null,
                "permission": null,
                "exceptedRuleId": "2024080714034600000005",
                "exceptedRuleName": "excep-rule-3",
                "exceptTargetType": "server",
                "exceptTarget": "{target-instance-id}",
                "exceptTargetName": "{target-name}",
                "processName": "{process}",
                "processNameCondition": "EQUAL",
                "processArg": "{process-and-arguments}",
                "processArgCondition": "EQUAL",
                "executor": "www-data",
                "executorCondition": "EQUAL",
                "processNameOfParent": "{process}",
                "processNameOfParentCondition": "EQUAL",
                "processArgOfParent": "{process-and-arguments}",
                "processArgOfParentCondition": "EQUAL",
                "executorOfParent": "www-data",
                "executorOfParentCondition": "EQUAL",
                "createdTime": 1723007026658,
                "deletedTime": 1723007047168,
                "isDeleted": true,
                "memo": null,
                "memberNo": 26***90,
                "groupIsDeleted": null
            },
            {
                "disabled": false,
                "actionName": null,
                "permission": null,
                "exceptedRuleId": "2024080714030700000003",
                "exceptedRuleName": "excep-rule-1",
                "exceptTargetType": "server",
                "exceptTarget": "{target-instance-id}",
                "exceptTargetName": "{target-name}",
                "processName": "{process}",
                "processNameCondition": "EQUAL",
                "processArg": "{process-and-arguments}",
                "processArgCondition": "EQUAL",
                "executor": "www-data",
                "executorCondition": "EQUAL",
                "processNameOfParent": "{process}",
                "processNameOfParentCondition": "EQUAL",
                "processArgOfParent": "{process-and-arguments}",
                "processArgOfParentCondition": "EQUAL",
                "executorOfParent": "www-data",
                "executorOfParentCondition": "EQUAL",
                "createdTime": 1723006987534,
                "deletedTime": 1723009178564,
                "isDeleted": true,
                "memo": "need update",
                "memberNo": 26***90,
                "groupIsDeleted": null
            }
        ],
        "totalCount": 7,
        "pageSize": 2,
        "pageIndex": 0,
        "totalPages": 4
    }
}