SearchDetectionTarget
    • PDF

    SearchDetectionTarget

    • PDF

    기사 요약

    개요

    탐지 대상 목록을 검색합니다.

    필요 권한

    • View/getDetectionTargetDetail

    요청

    요청 파라미터

    파라미터명필수 여부타입설명
    pageIndexYesinteger페이지 번호
    pageSizeYesinteger페이지 출력 갯수
    agentStatusNoarray에이전트 상태 (활성: enable, 비활성: disable, 미설치: notInstalled, 오류: error, 활성화 진행중: activating, 에이전트 다운: down)
    fileUploadPathNostringWAS 파일 업로드 경로
    webRootPathNostringWAS 웹 루트 경로
    ipAddressNostring탐지 대상 IP 주소
    memoNostring탐지 대상 메모
    serverGroupNameNostring탐지 대상 서버 그룹 이름
    serverImageNameNostring탐지 대상 서버 이미지 이름
    serverNameNostring탐지 대상 서버 이름

    요청 헤더

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

    응답

    응답 바디

    • 응답 메시지 (1)
    항목타입설명
    successboolean요청 처리 여부
    codeInteger응답코드
    messageString응답 메시지
    resultObject요청 결과
    • 응답 메시지 (2) : 탐지 대상
    항목타입설명
    instanceNostringVM 인스턴스 ID
    serverNamestring서버이름
    serverImageNamestring서버 이미지 이름
    serverStatusstring서버 상태
    serverTypestring서버 유형
    ipAddressstring서버 IP
    agentStatusstring에이전트 상태
    serverGroupIdstring서버 그룹 ID
    serverGroupNamestring서버 그룹 이름
    platformstring서버 플랫폼 환경 (VPC, CLASSIC)
    wasConfigListobjectWAS 탐지 설정
    registeredTimeinteger서버 탐지 대상 등록 일자 (timestamp)
    activationTimeinteger에이전트 활성화 일자 (timestamp)
    latestActivationTimeinteger최근 에이전트 활성화 일자 (timestamp)
    latestDeactivationTimeinteger최근 에이전트 비활성화 일자 (timestamp)
    lastUpdatedTimeinteger마지막 탐지 대상 정보 수정 일자 (timestamp)
    memostring탐지 대상 메모
    agentVersionstring에이전트 설치 버전
    agentEnableboolean에이전트 활성화 여부
    agentStagestring에이전트 상태
    • 응답 메시지 (3) : WAS 탐지 설정 (wasConfigList)
    항목타입설명
    wasTypestringWAS 타입 (jsp, php)
    webRootPathsarray웹루트 디렉터리(Document Root) 경로
    fileUploadPathsarray업로드 디렉터리(Upload Directory) 경로

    예시

    요청 예시

    POST {WBD_API_URL}/servers
    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}
    
    {
      "agentStatus": [
        "enable"
      ],
      "fileUploadPath": "string",
      "ipAddress": "string",
      "memo": "string",
      "pageIndex": 0,
      "pageSize": 0,
      "serverGroupName": "string",
      "serverImageName": "string",
      "serverName": "string",
      "webRootPath": "string"
    }
    

    응답 예시

    {
      "success": true,
      "code": 0,
      "message": "success",
      "result": {
        "content": [
          {
            "instanceNo": "{instance-id}",
            "serverName": "{server-name}",
            "serverImageName": "{server-image-name}",
            "serverStatus": "running",
            "serverType": "VPCServer",
            "ipAddress": "xxx.xxx.xxx.xxx",
            "agentStatus": "enable",
            "serverGroupId": null,
            "serverGroupName": null,
            "platform": "VPC",
            "wasConfigList": [
              {
                "wasType": "jsp",
                "webRootPaths": [
                  "{web_root_path_1}",
                  "{web_root_path_2}"
                ],
                "fileUploadPaths": [
                    "{file_upload_path_1}",
                    "{file_upload_path_2}"
                ]
              }
            ],
            "alarmTarget": null,
            "registeredTime": 1608276918271,
            "activationTime": 1608276931590,
            "latestActivationTime": 1613793972444,
            "latestDeactivationTime": 1613793948575,
            "lastUpdatedTime": 1613793972290,
            "memberNo": 1234,
            "memo": "{memo}",
            "commandResult": "OK",
            "resultCode": 0,
            "agentVersion": "{agent_version}",
            "agentEnable": true,
            "agentStage": "RUNNING",
            "chargeInstanceNo": "{charge_instance_no}",
            "resultParam": null
          }
        ],
        "totalCount": 1,
        "pageSize": 1,
        "pageIndex": 0,
        "totalPages": 1
      }
    }
    

    오류 코드 예시

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

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

    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.