SearchExceptionRule

인쇄
공유
PDF

기사 요약

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

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

개요

예외 규칙 목록을 검색합니다.

필요 권한

View/getUserExceptionRuleDetail

요청

요청 파라미터

파라미터명	필수 여부	타입	설명
pageIndex	Yes	integer	페이지 번호
pageSize	Yes	integer	페이지 출력 갯수
createdTimeFrom	No	integer	예외 규칙 생성 일자 검색 시작 기간 (timestamp)
createdTimeTo	No	integer	예외 규칙 생성 일자 검색 종료 기간 (timestamp)
deletedTimeFrom	No	integer	예외 규칙 삭제 일자 검색 시간 기간 (timestamp)
deletedTimeTo	No	integer	예외 규칙 삭제 일자 검색 종료 기간 (timestamp)
exceptTarget	No	string	예외 규칙 적용 대상의 인스턴스 ID
exceptedRuleName	No	string	예외 규칙 이름
executor	No	string	프로세스의 실행 계정
executorOfParent	No	string	부모 프로세스의 실행 계정
processArg	No	string	프로세스 인자
processArgOfParent	No	string	부모 프로세스의 인자
processName	No	string	프로세스 이름
processNameOfParent	No	string	부모 프로세스의 이름

요청 헤더

헤더명	필수 여부	타입	설명
X-NCP-USE_PLATFORM_TYPE	Yes	string	VPC, CLASSIC 환경 중 택일

응답

응답 바디

응답 메시지 (1)

항목	타입	설명
success	boolean	요청 처리 여부
code	Integer	응답코드
message	String	응답 메시지
result	Object	요청 결과
- content	Array	예외 규칙 내역 목록
- totalCount	Integer	총 항목 갯수
- pageSize	Integer	현재 페이지 출력 갯수
- pageIndex	Integer	현재 페이지 번호
- totalPages	Integer	총 페이지 갯수

응답 메시지 (2) : 예외 규칙 내역(content)

항목	타입	설명
exceptedRuleId	string	예외 규칙 ID
exceptedRuleName	string	예외 규칙 이름
exceptTargetType	string	예외 적용 대상 유형 (서버 그룹: serverGroup, 모든 서버: everyServer, 특정 서버: server)
exceptTarget	string	예외 적용 대상의 인스턴스 ID
exceptTargetName	string	예외 적용 대상의 이름
processName	string	(예외 규칙 조건) 비교할 프로세스 이름
processNameCondition	string	(예외 규칙 조건) 프로세스 이름 비교 조건 (정확히 일치: EQUAL, 조건 사용하지 않음: NOT_USE, 시작 문자열 일치: START, 마지막 문자열 일치: END)
processArg	string	(예외 규칙 조건) 비교할 프로세스 인자
processArgCondition	string	(예외 규칙 조건) 프로세스 인자 비교 조건 (정확히 일치: EQUAL, 조건 사용하지 않음: NOT_USE, 시작 문자열 일치: START, 마지막 문자열 일치: END)
executor	string	(예외 규칙 조건) 비교할 실행 계정
executorCondition	string	(예외 규칙 조건) 실행 계정 비교 조건 (정확히 일치: EQUAL, 조건 사용하지 않음: NOT_USE, 시작 문자열 일치: START, 마지막 문자열 일치: END)
processNameOfParent	string	(예외 규칙 조건) 비교할 부모 프로세스 이름
processNameOfParentCondition	string	(예외 규칙 조건) 부모 프로세스 이름 비교 조건 (정확히 일치: EQUAL, 조건 사용하지 않음: NOT_USE, 시작 문자열 일치: START, 마지막 문자열 일치: END)
processArgOfParent	string	(예외 규칙 조건) 비교할 부모 프로세스 인자
processArgOfParentCondition	string	(예외 규칙 조건) 부모 프로세스 인자 비교 조건 (정확히 일치: EQUAL, 조건 사용하지 않음: NOT_USE, 시작 문자열 일치: START, 마지막 문자열 일치: END)
executorOfParent	string	(예외 규칙 조건) 비교할 부모 프로세스의 실행 계정
executorOfParentCondition	string	(예외 규칙 조건) 부모 프로세스의 실행 계정 비교 조건 (정확히 일치: EQUAL, 조건 사용하지 않음: NOT_USE, 시작 문자열 일치: START, 마지막 문자열 일치: END)
createdTime	integer	예외 규칙 생성 일자(timestamp)
createdTime	integer	예외 규칙 삭제 일자(deletedTime)
isDeleted	boolean	예외 규칙 삭제 여부
memo	boolean	예외 규칙 메모

예시

요청 예시

POST {WBD_API_URL}/exception-rules
X-NCP-USE_PLATFORM_TYPE: VPC
Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key or STS Access Key}`
x-ncp-apigw-signature-v2: {API Gateway Signature}

{
  "createdTimeFrom": 0,
  "createdTimeTo": 0,
  "deletedTimeFrom": 0,
  "deletedTimeTo": 0,
  "exceptTarget": "string",
  "exceptedRuleName": "string",
  "executor": "string",
  "executorOfParent": "string",
  "pageIndex": 0,
  "pageSize": 0,
  "processArg": "string",
  "processArgOfParent": "string",
  "processName": "string",
  "processNameOfParent": "string"
}

응답 예시

{
  "success": true,
  "code": 0,
  "message": "success",
  "result": {
    "content": [
      {
        "disabled": false,
        "actionName": null,
        "permission": null,
        "exceptedRuleId": "2021022013573700000001",
        "exceptedRuleName": "test",
        "exceptTargetType": "server",
        "exceptTarget": "{target_instance_id}",
        "exceptTargetName": "{target_name}",
        "processName": "{process_name}",
        "processNameCondition": "EQUAL",
        "processArg": "{process_arg}",
        "processArgCondition": "EQUAL",
        "executor": "{executor}",
        "executorCondition": "EQUAL",
        "processNameOfParent": "{parent_process_name}",
        "processNameOfParentCondition": "EQUAL",
        "processArgOfParent": "{parent_process_arg}",
        "processArgOfParentCondition": "EQUAL",
        "executorOfParent": "{parent_executor}",
        "executorOfParentCondition": "EQUAL",
        "createdTime": 1613797057218,
        "deletedTime": null,
        "isDeleted": false,
        "memo": null,
        "memberNo": 1234,
        "groupIsDeleted": null
      }
    ],
    "totalCount": 14,
    "pageSize": 1,
    "pageIndex": 0,
    "totalPages": 14
  }
}

오류 코드 예시

{
  "success": false,
  "code": 400,
  "message": "Platform must be not null.",
  "result": null
}

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

What's Next

UpdateExceptionRuleMemo

개요
필요 권한
요청
응답
예시
오류 코드 예시

태그