Bare Metal Server

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

Classic 환경의 Bare Metal 서버 인스턴스(VM) 목록을 조회하고, 서버별 Cloud Log Analytics 서비스를 통한 로그 수집 설정 상태를 확인합니다.

요청

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

메서드	URI
GET	/api/{regionCode}-v1/classic/baremetal

요청 헤더

Cloud Log Analytics API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Log Analytics 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`regionCode`	String	Required	리전 코드 `kr` \| `krs` `kr`: 수도권 `krs`: 남부권

요청 쿼리 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`pageNo`	Integer	Optional	페이지 번호 1~100 (기본값: 1)
`pageSize`	Integer	Optional	페이지당 항목 수 20~100 (기본값: 20)

요청 예시

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

curl --location --request GET 'https://cloudloganalytics.apigw.gov-ntruss.com/api/{regionCode}-v1/classic/servers/baremetal' \
--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' \

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`code`	Integer	-	응답 상태 코드
`message`	String	-	응답 상태 메시지
`result`	Object	-	응답 결과
`result.pageSize`	Integer	-	페이지 당 항목 수
`result.currentPage`	Integer	-	현재 페이지 번호
`result.totalPage`	Integer	-	전체 페이지 수
`result.totalCount`	Integer	-	전체 항목 수
`result.isPaged`	Boolean	-	페이징 여부 `true` \| `false` `true`: 페이징 `false`: 페이징 안 함
`result.serverInfos`	Array	-	서버 목록 서버 정보 로그 수집 설정 정보
`result.collectingCount`	Integer	-	로그 수집 설정 완료 서버 수

`serverInfos`

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

필드	타입	필수 여부	설명
`collectingInfo`	Object	-	로그 수집 설정 정보
`collectingInfo.collectorAgentVersion`	String	-	로그 수집 에이전트 버전
`collectingInfo.logTypeCount`	Integer	-	수집 대상 로그 유형 개수
`collectingInfo.collectionStatus`	String	-	로그 수집 상태
`collectingInfo.settingStatus`	String	-	로그 수집 설정 상태
`collectingInfo.settingStatusColor`	String	-	로그 수집 설정 상태 색상 표기 값
`collectingInfo.servername`	String	-	로그 수집 대상 서버 이름
`collectingInfo.logCollectorDate`	String	-	로그 수집 설정 일시
`collectingInfo.logTypeList`	String	-	수집 대상 로그 유형 목록
`collectingInfo.configKey`	String	-	로그 수집 에이전트 Install Key
`collectingInfo.isCollecting`	Boolean	-	로그 수집 활성화 여부 `true` \| `false` `true`: 활성화 `false`: 비활성화

참고

Server 정보 관련 필드에 대한 설명은 Server API 가이드와 Server 사용 가이드를 참조해 주십시오.

응답 상태 코드

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

응답 예시

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

{
  "code": 0,
  "message": "요청이 정상적으로 처리되었습니다",
  "result": {
    "pageSize": 10,
    "currentPage": 1,
    "totalPage": 1,
    "totalCount": 1,
    "isPaged": true,
    "serverInfos": [
      {
        "servername": "testbmServer",
        "publicIp": null,
        "osName": "Windows Server 2012(64bit) R2 English Edition",
        "createYmdt": 1731946617857,
        "privateIp": "***.***.***.***",
        "serverStatusCode": "RUN",
        "serverStatusName": "RUNNING",
        "serverStatusKorean": "운영중",
        "serverStatusValue": "운영중",
        "serverStatusColor": "green",
        "serverImageName": "win-2012-64-R2-en",
        "uptime": 1751946617857,
        "message": null,
        "occuredTime": null,
        "logType": null,
        "zoneNo": "2",
        "zoneName": "KR-1",
        "secureZoneNo": null,
        "platformTypeCode": "WND64",
        "cpuCount": 16,
        "osDiskType2Code": "NET",
        "returnProtectionYn": "N",
        "virtualNetworkInterfaceIp": null,
        "portForwardingIp": "***.***.***.***",
        "virtualNetworkDomainNo": "3",
        "hostName": "test",
        "gpuCount": null,
        "softwareProductCode": "SPSW0WINNTEN0015A",
        "virtualNetworkDomainName": "MND001",
        "virtualNetworkInterfaceNo": null,
        "internalDnsHostName": null,
        "regionName": "Korea",
        "serverInstanceDetailTypeCode": null,
        "operationCode": "NULL",
        "macAddr": "**:**:**:**:**:**",
        "alisRaidTypeName": null,
        "networkMonitoringYn": null,
        "lastServerStateSyncYmdt": null,
        "instanceProductType2Code": "STAND",
        "accessControlGroupList": [],
        "lastLbServerStatusSyncYmdt": null,
        "objectMonitoringInstanceNo": null,
        "secureZoneName": null,
        "loginKeyName": "pub",
        "publicIpInstanceNo": null,
        "serverInstanceTypeCode": "SVR",
        "instanceNo": 1207632,
        "portForwardingIpBackboneCode": "PUBLC",
        "osDiskType2DetailCode": "SSD",
        "feeChargingMonitoringYn": "N",
        "regionCode": "KR",
        "internalPort": "3389",
        "rootPassword": "*********",
        "cncNo": 5,
        "productCode": "SPSVRSSD00000003A",
        "memorySize": {
          "json.expansion@key": "json.bigdecimal",
          "json.expansion@value": "4294967296"
        },
        "instanceDesc": "Administrator\nF5NdU9yaHci",
        "regionNo": "1",
        "isSsdStorageAddable": true,
        "externalPort": "3948",
        "baseBlockStorageSize": {
          "json.expansion@key": "json.bigdecimal",
          "json.expansion@value": "107374182400"
        },
        "backboneCode": "PUBLC",
        "isSupportOS": true,
        "collectingInfo": {
          "collectorAgentVersion": "5.5.1",
          "logTypeCount": 3,
          "collectionStatus": "미설정",
          "settingStatus": "설정완료",
          "settingStatusColor": "green",
          "servername": "test",
          "logCollectorDate": "2024-11-13 13:37:11",
          "logTypeList": "apache_error,apache_access,wineventlog",
          "configKey": "*********",
          "isCollecting": true
        }
      }
    ],
    "collectingCount": 1
  }
}