MENU
      get-data-box-frame-infra-list

        get-data-box-frame-infra-list


        기사 요약

        Data Box Frame의 인프라 목록을 조회합니다.

        GET https://{endpoint}/data-box-frame/get-data-box-frame-list
        HTTP

        요청

        요청 파라미터

        파라미터명필수 여부타입제약 사항설명
        dataBoxFrameNoNoIntegerData Box Frame 번호
        pageNoNoInteger1 ~ 100페이지 번호
        pageSizeNoInteger1 ~ 100페이지 당 조회되는 항목 수

        응답

        HTTP 상태코드설명
        200성공
        400요청 정보 오류
        401인증 실패
        403요청 정보에 대한 권한 없음
        404리소스가 존재하지 않음
        500서버 오류

        예시

        요청 예시

        GET https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/get-data-box-frame-infra-list?dataBoxFrameNo=1046
        HTTP

        응답 예시

        {
          "totalCount": 2,
          "content": [
            {
              "infraType": "Server",
              "instanceName": "admin-1046-1",
              "privateIp": "-.-.-.-",
              "publicIp": "-.-.-.-",
              "osName": "Ubuntu",
              "specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
              "prodSpecId": 2001,
              "userName": "root",
              "useData": "",
              "createDate": "2023-03-15 10:53:09",
              "statusCode": "SET_USE",
              "statusName": "Using",
              "instanceNo": "-",
              "instanceStatusCode": "RUN"
            },
            {
              "infraType": "NAS",
              "instanceName": "pub1046n1",
              "privateIp": "",
              "osName": "",
              "specName": "500",
              "userName": "/mnt/nasr/pub1046n1",
              "useData": "0",
              "createDate": "2023-03-15 10:53:09",
              "statusCode": "USE",
              "statusName": "Using",
              "instanceNo": "-",
              "nasVolumeSize": "500"
            }
          ],
          "usePseudonymInfo": "Y"
        }
        JSON

        속성

        항목필수 여부타입제약 사항설명
        totalCountYesIntegerData Box Frame의 Infra 수
        infraTypeYesStringInfra 유형(Server, NAS
        instanceNameYesStringInfra 명
        privateIpYesStringInfra의 비공인 IP
        publicIpNoStringInfra의 공인 IP
        osNameYesString서버의 OS 명(NAS의 경우, 빈 String 반환)
        specNameYesString서버의 스펙 명(NAS의 경우, NAS의 용량 반환)
        userNameYesStirng서버의 접속 계정명(NAS의 경우, 마운트 경로 반환)
        createDateYesStringData Box Frame 생성 일시
        statusCodeYesStringData Box Frame 상태 코드
        statusNameYesStringData Box Frame 상태 명
        instanceNoYes

        오류 코드

        HTTP Status Code리턴 코드설명
        200-일반적인 요청 성공
        40010001,
        130***
        요청 정보 및 파라미터 오류
        40310002요청 정보에 대한 권한 없음
        40410009리소스가 존재하지 않음
        500130000서비스 내부 오류
        500139999연동 서비스 API 호출 오류

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

        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.