SearchDetectionTarget
    • PDF

    SearchDetectionTarget

    • PDF

    기사 요약

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

    등록된 탐지 대상 중 원하는 항목을 검색합니다.

    요청

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

    메서드URI
    POST/servers

    요청 헤더

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

    요청 바디

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

    필드타입필수 여부설명
    pageIndexIntegerOptional페이지 번호
    pageSizeIntegerOptional페이지 출력 개수
    agentStatusArrayOptional에이전트 상태
    • enable | disable | notInstalled | error | activating | down
      • enable: 활성 상태
      • disable: 비활성 상태
      • notInstalled: 미설치 상태
      • error: 오류 상태
      • activating: 활성화 진행 중 상태
      • down: 에이전트 다운 상태
    fileUploadPathStringOptional파일의 업로드 디렉터리
    webRootPathStringOptional웹 루트 디렉터리
    ipAddressStringOptional서버 IP
    memoStringOptional메모
    serverGroupNameStringOptional서버 그룹 이름
    serverImageNameStringOptionalVM의 서버 이미지 이름
    serverNameStringOptionalVM의 서버 이름

    요청 예시

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

    curl --location --request POST 'https://wbd.apigw.ntruss.com/api/v1/servers' \
    --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 '{
        "agentStatus": [
            "enable"
        ]
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드타입필수 여부설명
    successBoolean-요청 처리 여부
    codeInteger-응답 코드
    messageString-응답 메시지
    resultObject-응답 결과
    contentArray-탐지 대상 목록
    totalCountInteger-응답 결과 개수
    pageSizeInteger-페이지 출력 개수
    pageIndexInteger-페이지 번호
    totalPagesInteger-총 페이지 개수

    content

    content에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    instanceNoString-VM의 인스턴스 번호
    serverNameString-VM의 서버 이름
    serverImageNameString-VM의 서버 이미지 이름
    serverStatusString-VM의 현재 상태
    serverTypeString-VM 유형
    serverEnvTypeString-서버 환경 유형
    ipAddressString-서버 IP
    agentStatusString-에이전트 상태
    serverGroupIdString-서버 그룹 ID
    serverGroupNameString-서버 그룹 이름
    platformString-서버 플랫폼
    • VPC | CLASSIC
    wasConfigListArray-WAS 탐지 설정
    registeredTimeInteger-탐지 대상 등록 일시(Timestamp)
    activationTimeInteger-에이전트 활성화 일시(Timestamp)
    latestActivationTimeInteger-에이전트의 마지막 활성화 일시(Timestamp)
    latestDeactivationTimeInteger-에이전트의 마지막 비활성화 일시(Timestamp)
    lastUpdatedTimeInteger-탐지 대상의 마지막 정보 수정 일시(Timestamp)
    memberNoInteger-VM 사용 회원 번호
    memoString-메모
    commandResultString-명령의 결과에 대한 상세 메시지
    resultCodeString-명령의 결과 코드
    agentVersionString-설치된 에이전트 버전
    agentEnableBoolean-에이전트 활성화 여부
    • true | false
      • true: 활성
      • false: 비활성
    agentStageString-에이전트 상태
    chargeInstanceNoString-과금 기준이 되는 인스턴스 번호
    resultParamJSON-에이전트의 실행/오류 등에 대한 상세 내용
    clusterNameString-에이전트가 설치된 Pod의 클러스터 이름

    wasConfigList

    wasConfigList에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    wasTypeString-WAS 유형
    • jsp | php
    webRootPathsArray-웹 루트 디렉터리
    fileUploadPathsArray-파일의 업로드 디렉터리

    응답 상태 코드

    Webshell Behavior Detector API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Webshell Behavior Detector 공통 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

    {
        "success": true,
        "code": 0,
        "message": "success",
        "result": {
            "content": [
                {
                    "instanceNo": "25****43",
                    "serverName": "tomcat",
                    "serverImageName": "CentOS 7.8 (64-bit) with Tomcat",
                    "serverStatus": "running",
                    "serverType": "VPCServer",
                    "serverEnvType": "HOST",
                    "ipAddress": "172.***.***.***",
                    "agentStatus": "enable",
                    "serverGroupId": null,
                    "serverGroupName": null,
                    "platform": "VPC",
                    "wasConfigList": [
                        {
                            "wasType": "jsp",
                            "webRootPaths": [
                                "/opt/tomcat/webapps"
                            ],
                            "fileUploadPaths": [
                                "/opt/tomcat/webapps/helloworld"
                            ]
                        }
                    ],
                    "registeredTime": 1722409425616,
                    "activationTime": 1722410006635,
                    "latestActivationTime": 1722475527004,
                    "latestDeactivationTime": null,
                    "lastUpdatedTime": 1722475536504,
                    "memberNo": 27***85,
                    "memo": "",
                    "commandResult": "OK",
                    "resultCode": 0,
                    "agentVersion": "1.0.5.030",
                    "agentEnable": true,
                    "agentStage": "RUNNING",
                    "chargeInstanceNo": "25****65",
                    "resultParam": null,
                    "clusterName": null
                }
            ],
            "totalCount": 1,
            "pageSize": 20,
            "pageIndex": 0,
            "totalPages": 1
        }
    }
    

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

    What's Next
    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.