SearchDetectionTarget
- 인쇄
- PDF
SearchDetectionTarget
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
개요
탐지 대상 목록을 검색합니다.
필요 권한
- View/getDetectionTargetDetail
요청
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 설명 |
|---|---|---|---|
| pageIndex | Yes | integer | 페이지 번호 |
| pageSize | Yes | integer | 페이지 출력 갯수 |
| agentStatus | No | array | 에이전트 상태 (활성: enable, 비활성: disable, 미설치: notInstalled, 오류: error, 활성화 진행중: activating, 에이전트 다운: down) |
| fileUploadPath | No | string | WAS 파일 업로드 경로 |
| webRootPath | No | string | WAS 웹 루트 경로 |
| ipAddress | No | string | 탐지 대상 IP 주소 |
| memo | No | string | 탐지 대상 메모 |
| serverGroupName | No | string | 탐지 대상 서버 그룹 이름 |
| serverImageName | No | string | 탐지 대상 서버 이미지 이름 |
| serverName | No | string | 탐지 대상 서버 이름 |
요청 헤더
| 헤더명 | 필수 여부 | 타입 | 설명 |
|---|---|---|---|
| X-NCP-USE_PLATFORM_TYPE | Yes | string | VPC, CLASSIC 환경 중 택일 |
응답
응답 바디
- 응답 메시지 (1)
| 항목 | 타입 | 설명 |
|---|---|---|
| success | boolean | 요청 처리 여부 |
| code | Integer | 응답코드 |
| message | String | 응답 메시지 |
| result | Object | 요청 결과 |
- 응답 메시지 (2) : 탐지 대상
| 항목 | 타입 | 설명 |
|---|---|---|
| instanceNo | string | VM 인스턴스 ID |
| serverName | string | 서버이름 |
| serverImageName | string | 서버 이미지 이름 |
| serverStatus | string | 서버 상태 |
| serverType | string | 서버 유형 |
| ipAddress | string | 서버 IP |
| agentStatus | string | 에이전트 상태 |
| serverGroupId | string | 서버 그룹 ID |
| serverGroupName | string | 서버 그룹 이름 |
| platform | string | 서버 플랫폼 환경 (VPC, CLASSIC) |
| wasConfigList | object | WAS 탐지 설정 |
| registeredTime | integer | 서버 탐지 대상 등록 일자 (timestamp) |
| activationTime | integer | 에이전트 활성화 일자 (timestamp) |
| latestActivationTime | integer | 최근 에이전트 활성화 일자 (timestamp) |
| latestDeactivationTime | integer | 최근 에이전트 비활성화 일자 (timestamp) |
| lastUpdatedTime | integer | 마지막 탐지 대상 정보 수정 일자 (timestamp) |
| memo | string | 탐지 대상 메모 |
| agentVersion | string | 에이전트 설치 버전 |
| agentEnable | boolean | 에이전트 활성화 여부 |
| agentStage | string | 에이전트 상태 |
- 응답 메시지 (3) : WAS 탐지 설정 (wasConfigList)
| 항목 | 타입 | 설명 |
|---|---|---|
| wasType | string | WAS 타입 (jsp, php) |
| webRootPaths | array | 웹루트 디렉터리(Document Root) 경로 |
| fileUploadPaths | array | 업로드 디렉터리(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
}
이 문서가 도움이 되었습니까?