modify-data-box-frame-admin-infra

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

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

요청

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

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

요청 헤더

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

요청 바디

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

필드	타입	필수 여부	설명
`dataBoxFrameNo`	Integer	Required	Data Box Frame 번호 get-data-box-frame-list 참조
`memo`	String	Optional	Data Box Frame에 대한 메모
`adminServerList`	Array	Conditional	어드민 서버 목록
`nasList`	Array	Conditional	NAS 목록

`adminServerList`

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

필드	타입	필수 여부	설명
`actionType`	String	Required	처리 유형 `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 생성 `UPDATE`: 수정 `DELETE`: 반납
`adminServerInstanceNo`	Integer	Conditional	어드민 서버 인스턴스 번호 get-data-box-frame-infra-list 참조 `actionType`이 `UPDATE` 또는 `DELETE`인 경우, 필수 입력
`prodSpecId`	Integer	Conditional	서버 스펙 코드 Product Spec Code 참조 `actionType`이 `CREATE` 또는 `UPDATE`인 경우, 필수 입력
`userPassword`	String	Required	어드민 서버 접속 비밀번호 영문 대소문자, 숫자, 특수 문자를 조합하여 8~14자 이내로 입력 사용 불가 특수 문자: ', ", ₩, /, &, `, 공백 `actionType`이 `CREATE`인 경우, 필수 입력

`nasList`

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

필드	타입	필수 여부	설명
`actionType`	String	Required	처리 유형 `CREATE` \| `DELETE` `CREATE`: 생성 `DELETE`: 반납
`count`	Integer	Conditional	NAS 개수 `actionType`이 `CREATE`인 경우, 필수 입력
`nasInstanceNo`	Integer	Conditional	NAS 인스턴스 번호 Product Spec Code 참조 `actionType`이 `DELETE`인 경우, 필수 입력
`nasSize`	Integer	Conditional	NAS 볼륨 크기(GB) 500~10000 100GB 단위로 설정 NAS 총 사용량(10TB)으로 인해 제한될 수 있음 `actionType`이 `CREATE`인 경우, 필수 입력

요청 예시

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

curl --location --request POST 'https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/modify-data-box-frame-admin-infra' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "adminServerList": [
    {
      "actionType": "UPDATE",
      "adminServerInstanceNo": ********,
      "prodSpecId": 2001,
      "userPassword": "********"
    }
  ],
  "dataBoxFrameNo": "83",
  "memo": "about data box frame",
  "nasList": [
    {
      "actionType": "CREATE",
      "count": 1,
      "nasInstanceNo": ********,
      "nasSize": 600
    }
  ]
}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

응답 상태 코드

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

응답 예시

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

{
    "returnMessage": "Modification of the Data Box Frame infrastructure has been requested."
}