SearchExceptionRule

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

VPC 환경에서 이용 가능합니다.

생성된 예외 규칙 목록 중 원하는 항목을 검색합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/exception-rules

요청 헤더

Webshell Behavior Detector API에서 공통으로 사용하는 헤더에 대한 정보는 Webshell Behavior Detector 공통 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`createdTimeFrom`	Integer	Optional	예외 규칙 생성 일자 검색 시작 일시(Timestamp)
`createdTimeTo`	Integer	Optional	예외 규칙 생성 일자 검색 종료 일시(Timestamp)
`deletedTimeFrom`	Integer	Optional	예외 규칙 삭제 일자 검색 시작 일시(Timestamp)
`deletedTimeTo`	Integer	Optional	예외 규칙 삭제 일자 검색 종료 일시(Timestamp)
`exceptTarget`	String	Optional	예외 대상의 인스턴스 ID
`exceptedRuleName`	String	Optional	예외 규칙 이름
`executor`	String	Optional	프로세스의 실행 계정
`executorOfParent`	String	Optional	부모 프로세스의 실행 계정
`pageIndex`	Integer	Required	페이지 번호
`pageSize`	Integer	Required	페이지 출력 개수
`processArg`	String	Optional	프로세스 인자
`processArgOfParent`	String	Optional	부모 프로세스 인자
`processName`	String	Optional	프로세스 이름
`processNameOfParent`	String	Optional	부모 프로세스 이름

요청 예시

요청 예시는 다음과 같습니다.

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
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`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": "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
    }
}

이 문서가 도움이 되었습니까?

What's Next

UpdateExceptionRuleMemo

요청
응답

태그