SearchExceptionRule
    • PDF

    SearchExceptionRule

    • PDF

    記事の要約

    VPC環境で利用できます。

    作成された例外ルールリストのうち、目的の項目を検索します。

    リクエスト

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

    メソッドURI
    POST/exception-rules

    リクエストヘッダ

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

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    createdTimeFromIntegerOptional例外ルール作成日時の検索開始日時(Timestamp)
    createdTimeToIntegerOptional例外ルール作成日時の検索終了日時(Timestamp)
    deletedTimeFromIntegerOptional例外ルール削除日時の検索開始日時(Timestamp)
    deletedTimeToIntegerOptional例外ルール削除日時の検索終了日時(Timestamp)
    exceptTargetStringOptional例外対象のインスタンス ID
    exceptedRuleNameStringOptional例外ルール名
    executorStringOptionalプロセスの実行アカウント
    executorOfParentStringOptional親プロセスの実行アカウント
    pageIndexIntegerRequiredページ番号
    pageSizeIntegerRequiredページ表示数
    processArgStringOptionalプロセス引数
    processArgOfParentStringOptional親プロセス引数
    processNameStringOptionalプロセス名
    processNameOfParentStringOptional親プロセス名

    リクエスト例

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

    curl --location --request POST 'https://wbd.apigw.ntruss.com/api/v1/exception-rules' \
    --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' \
    --data '{
        "createdTimeFrom": 1723006826000,
        "createdTimeTo": 1723008146000,
        "pageIndex": 0,
        "pageSize": 1
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    successBoolean-リクエスト処理の有無
    codeInteger-レスポンスコード
    messageString-レスポンスメッセージ
    resultObject-レスポンス結果
    contentArray-例外ルールリスト
    totalCountInteger-レスポンス結果数
    pageSizeInteger-ページ表示数
    pageIndexInteger-ページ番号
    totalPagesInteger-ページの総数

    content

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

    フィールドタイプ必須の有無説明
    disabledBoolean-例外ルールは無効化かどうか
    • サブアカウントの場合に表示
    • true | false
      • true: 無効化
      • false: 有効化
    actionNameString-サブアカウントのアクション名
    • サブアカウントの場合に表示
    permissionEnum-サブアカウントの権限
    • サブアカウントの場合に表示
    • Allow | Deny
    exceptedRuleIdString-例外ルール ID
    exceptedRuleNameString-例外ルール名
    exceptTargetTypeString-例外対象のタイプ
    • serverGroup | everyServer | server
      • serverGroup: サーバグループ
      • everyServer: すべてのサーバ
      • server: 特定のサーバ
    exceptTargetString-例外対象のインスタンス ID
    exceptTargetNameString-例外対象の名前
    processNameString-比較対象のプロセス名
    processNameConditionString-プロセス名の比較条件
    • EQUAL | NOT_USE | START | END
      • EQUAL: 完全に一致
      • NOT_USE: 比較条件を使用しない
      • START: 先頭の文字列が一致
      • END: 末尾の文字列が一致
    processArgString-比較対象のプロセス引数
    processArgConditionString-プロセス引数の比較条件
    • EQUAL | NOT_USE | START | END
      • EQUAL: 完全に一致
      • NOT_USE: 比較条件を使用しない
      • START: 先頭の文字列が一致
      • END: 末尾の文字列が一致
    executorString-比較対象の実行アカウント
    executorConditionString-実行アカウントの比較条件
    • EQUAL | NOT_USE | START | END
      • EQUAL: 完全に一致
      • NOT_USE: 比較条件を使用しない
      • START: 先頭の文字列が一致
      • END: 末尾の文字列が一致
    processNameOfParentString-比較対象の親プロセス名
    processNameOfParentConditionString-親プロセス名の比較条件
    • EQUAL | NOT_USE | START | END
      • EQUAL: 完全に一致
      • NOT_USE: 比較条件を使用しない
      • START: 先頭の文字列が一致
      • END: 末尾の文字列が一致
    processArgOfParentString-比較対象の親プロセス引数
    processArgOfParentConditionString-親プロセス引数の比較条件
    • EQUAL | NOT_USE | START | END
      • EQUAL: 完全に一致
      • NOT_USE: 比較条件を使用しない
      • START: 先頭の文字列が一致
      • END: 末尾の文字列が一致
    executorOfParentString-比較対象親プロセスの実行アカウント
    executorOfParentConditionString-親プロセス実行アカウントの比較条件
    • EQUAL | NOT_USE | START | END
      • EQUAL: 完全に一致
      • NOT_USE: 比較条件を使用しない
      • START: 先頭の文字列が一致
      • END: 末尾の文字列が一致
    createdTimeInteger-例外ルールの作成日時(Timestamp)
    deletedTimeInteger-例外ルールの削除日時(Timestamp)
    isDeletedBoolean-例外ルールは削除されたかどうか
    • true | false
      • true: 削除済み
      • false: 削除されていない
    memoString-メモ
    memberNoInteger-VM使用会員番号
    groupIsDeletedBoolean-サーバグループは削除されたかどうか
    • 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": "2024080714082200000007",
                    "exceptedRuleName": "excep-rule-4",
                    "exceptTargetType": "server",
                    "exceptTarget": "{target-instance-id}",
                    "exceptTargetName": "{target-name}",
                    "processName": "{process}",
                    "processNameCondition": "START",
                    "processArg": "{process-and-arguments}",
                    "processArgCondition": "EQUAL",
                    "executor": "root",
                    "executorCondition": "EQUAL",
                    "processNameOfParent": "{process}",
                    "processNameOfParentCondition": "EQUAL",
                    "processArgOfParent": "{process-and-arguments}",
                    "processArgOfParentCondition": "EQUAL",
                    "executorOfParent": "root",
                    "executorOfParentCondition": "EQUAL",
                    "createdTime": 1723007302525,
                    "deletedTime": null,
                    "isDeleted": false,
                    "memo": null,
                    "memberNo": 26***90,
                    "groupIsDeleted": null
                }
            ],
            "totalCount": 4,
            "pageSize": 1,
            "pageIndex": 0,
            "totalPages": 4
        }
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.