modify-data-box

Prev Next

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

Data Box 인프라 설정을 변경합니다. 인프라 변경 작업에 일정 시간이 소요되므로 비동기 방식으로 처리됩니다.

요청

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

메서드 URI
POST /api/v1/data-box/modify-data-box

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
dataBoxFrameNo String Required Data Box Frame 번호
dataBoxInfo Object Required Data Box 정보
dataBoxInfo.dataBoxNo String Required Data Box 번호
dataBoxInfo.connectServerList Array Optional Connect 서버 목록
dataBoxInfo.hadoopList Array Optional Hadoop 클러스터 목록
dataBoxInfo.linuxServerList Array Optional Linux 서버 목록
dataBoxInfo.memo String Optional Data Box에 대한 설명
dataBoxInfo.nasList Array Optional NAS 목록
dataBoxInfo.tensorFlowCpuServerList Array Optional Tensorflow CPU 서버 목록
dataBoxInfo.tensorFlowGpuServerList Array Optional Tensorflow GPU 서버 목록

connectServerList

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

필드 타입 필수 여부 설명
actionType String Optional 처리 유형
  • CREATE | UPDATE | DELETE
    • CREATE: 생성
    • UPDATE: 수정
    • DELETE: 반납
blockStorageInstanceNo Integer Optional Connect 서버와 연결된 블록 스토리지의 인스턴스 번호
prodSpecId Integer Conditional Connect 서버 스펙 코드
serverInstanceNo Integer Conditional Connect 서버 인스턴스 번호
storageSize Integer Optional Connect 서버 블록 스토리지 크기(GB)
  • actionTypeCREATE, UPDATE인 경우
adminPassword String Conditional Connect 서버 어드민 계정 비밀번호
  • 영문 대소문자, 숫자, 특수 문자를 조합하여 8~14자 이내로 입력
  • 사용 불가 특수 문자: ', ", ₩, /, &, `, 공백
  • actionTypeCREATE인 경우, 필수 입력
userPassword1 String Conditional Connect 서버 ncp1 계정 비밀번호
  • 영문 대소문자, 숫자, 특수 문자를 조합하여 8~14자 이내로 입력
  • 사용 불가 특수 문자: ', ", ₩, /, &, `, 공백
  • actionTypeCREATE인 경우, 필수 입력
userPassword2 String Conditional Connect 서버 ncp2 계정 비밀번호
  • 영문 대소문자, 숫자, 특수 문자를 조합하여 8~14자 이내로 입력
  • 사용 불가 특수 문자: ', ", ₩, /, &, `, 공백
  • actionTypeCREATE인 경우, 필수 입력

hadoopList

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

필드 타입 필수 여부 설명
actionType String Optional 처리 유형
  • CREATE | UPDATE | DELETE
    • CREATE: 생성
    • UPDATE: 수정
    • DELETE: 반납
hadoopInstanceNo Integer Conditional Hadoop 클러스터 인스턴스 번호
EdgeNodeProdSpecId Integer Conditional 엣지 노드 서버 스펙 코드
masterNodeProdSpecId Integer Conditional 마스터 노드 서버 스펙 코드
masterNodeStorageSize Integer Optional 마스터 노드 블록 스토리지 크기(GB)
  • actionTypeCREATE인 경우
workerNodeCount Integer Optional 워커 노드 개수
  • actionTypeCREATE인 경우
workerNodeProdSpecId Integer Conditional 워커 노드 서버 스펙 코드
workerNodeStorageSize Integer Optional 워커 노드 블록 스토리지 크기(GB)
  • actionTypeCREATE인 경우
userPassword String Conditional Hadoop 클러스터 계정 비밀번호
  • 영문 대소문자, 숫자, 특수 문자를 조합하여 8~14자 이내로 입력
  • 사용 불가 특수 문자: ', ", ₩, /, &, `, 공백
  • actionTypeCREATE인 경우, 필수 입력

linuxServerList

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

필드 타입 필수 여부 설명
actionType String Optional 처리 유형
  • CREATE | UPDATE | DELETE
    • CREATE: 생성
    • UPDATE: 수정
    • DELETE: 반납
blockStorageInstanceNo Integer Optional Linux 서버와 연결된 블록 스토리지의 인스턴스 번호
prodSpecId Integer Optional Linux 서버 스펙 코드
serverInstanceNo Integer Conditional Linux 서버 인스턴스 번호
storageSize Integer Optional Linux 서버 블록 스토리지 크기(GB)
  • actionTypeCREATE, UPDATE인 경우
userPassword String Conditional Linux 서버 계정 비밀번호
  • 영문 대소문자, 숫자, 특수 문자를 조합하여 8~14자 이내로 입력
  • 사용 불가 특수 문자: ', ", ₩, /, &, `, 공백
  • actionTypeCREATE인 경우, 필수 입력

nasList

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

필드 타입 필수 여부 설명
actionType String Required 처리 유형
  • CREATE | DELETE
    • CREATE: 생성
    • DELETE: 반납
count Integer Optional NAS 개수
  • actionTypeCREATE인 경우
nasInstanceNo Integer Conditional NAS 인스턴스 번호
nasSize Integer Optional NAS 볼륨 크기(GB)
  • actionTypeCREATE인 경우

tensorFlowCpuServerList

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

필드 타입 필수 여부 설명
actionType String Optional 처리 유형
  • CREATE | UPDATE | DELETE
    • CREATE: 생성
    • UPDATE: 수정
    • DELETE: 반납
blockStorageInstanceNo Integer Optional Tensorflow CPU 서버와 연결된 블록 스토리지의 인스턴스 번호
prodSpecId Integer Optional Tensorflow CPU 서버 스펙 코드
serverInstanceNo Integer Conditional Tensorflow CPU 서버 인스턴스 번호
storageSize Integer Optional Tensorflow CPU 서버 블록 스토리지 크기(GB)
  • actionTypeCREATE, UPDATE인 경우
userPassword String Conditional Tensorflow CPU 서버 계정 비밀번호
  • 영문 대소문자, 숫자, 특수 문자를 조합하여 8~14자 이내로 입력
  • 사용 불가 특수 문자: ', ", ₩, /, &, `, 공백
  • actionTypeCREATE인 경우, 필수 입력

tensorFlowGpuServerList

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

필드 타입 필수 여부 설명
actionType String Optional 처리 유형
  • CREATE | UPDATE | DELETE
    • CREATE: 생성
    • UPDATE: 수정
    • DELETE: 반납
blockStorageInstanceNo Integer Optional Tensorflow GPU 서버와 연결된 블록 스토리지의 인스턴스 번호
prodSpecId Integer Optional Tensorflow GPU 서버 스펙 코드
serverInstanceNo Integer Conditional Tensorflow GPU 서버 인스턴스 번호
storageSize Integer Optional Tensorflow GPU 서버 블록 스토리지 크기(GB)
  • actionTypeCREATE, UPDATE인 경우
userPassword String Conditional Tensorflow GPU 서버 계정 비밀번호
  • 영문 대소문자, 숫자, 특수 문자를 조합하여 8~14자 이내로 입력
  • 사용 불가 특수 문자: ', ", ₩, /, &, `, 공백
  • actionTypeCREATE인 경우, 필수 입력

요청 예시

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

curl --location --request POST 'https://databoxframe.apigw.ntruss.com/api/v1/data-box/modify-data-box' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "dataBoxFrameNo": 83,
  "dataBoxInfo": {
    "dataBoxNo": "381",
    "connectServerList": [
      {
        "actionType": "CREATE",
        "blockStorageInstanceNo": *********,
        "prodSpecId":4001 ,
        "serverInstanceNo": *********,
        "storageSize": 500,
        "adminPassword": "********",
        "userPassword1": "********",
        "userPassword2": "********"
      }
    ],
    "hadoopList": [
      {
        "actionType": "CREATE",
        "hadoopInstanceNo": *********,
        "edgeNodeProdSpecId": 5001,
        "masterNodeProdSpecId": 5101,
        "masterNodeStorageSize": 500,
        "workerNodeCount": 2,
        "workerNodeProdSpecId": 5201,
        "workerNodeStorageSize": 500,
        "userPassword": "********"
      }
    ],
    "linuxServerList": [
      {
        "actionType": "CREATE",
        "blockStorageInstanceNo": *********,
        "prodSpecId": 6001,
        "serverInstanceNo": *********,
        "storageSize": 500,
        "userPassword": "********"
      }
    ],
    "memo": "dbf001",
    "nasList": [
      {
        "actionType": "CREATE",
        "count": 1,
        "nasInstanceNo": *********,
        "nasSize": 600
      }
    ],
    "tensorFlowCpuServerList": [
      {
        "actionType": "CREATE",
        "blockStorageInstanceNo": *********,
        "prodSpecId": 7001,
        "serverInstanceNo": *********,
        "storageSize": 500,
        "userPassword": "********"
      }
    ],
    "tensorFlowGpuServerList": [
      {
        "actionType": "CREATE",
        "blockStorageInstanceNo": *********,
        "prodSpecId": 7101,
        "serverInstanceNo": *********,
        "storageSize": 500,
        "userPassword": "********"
      }
    ]
  }
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
returnMessage String - API 처리 결과 메시지

응답 상태 코드

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

응답 예시

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

{
    "returnMessage": "Data Box infrastructure modification requested."
}