create-box

Prev Next

VPC環境で利用できます。

Boxを作成します。インフラの作成に一定時間がかかりますので、非同期で処理されます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/box/create-box

リクエストヘッダ

Datafence APIで共通して使用されるヘッダの詳細は、Datafenceのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
fenceId Integer Required Datafence番号
description String Optional Boxの説明
createBoxInfo Object Required Boxの作成情報
createBoxInfo.connectServerList Array Required Connectサーバリスト
  • 1~4台に設定
createBoxInfo.linuxServerList Array Required Linuxサーバリスト
createBoxInfo.windowsServerList Array Conditional Windows Serverリスト
  • 1~4台以内に設定
  • linuxServerList未設定時、必ず入力
createBoxInfo.nasList Array Required NASリスト
createBoxInfo.hadoopList Array Optional Hadoopクラスタリスト
createBoxInfo.tensorFlowCpuServerList Array Conditional TensorFlow CPUサーバリスト
  • 1~4台以内に設定
createBoxInfo.tensorFlowGpuServerList Array Conditional TensorFlow GPUサーバリスト
  • 1~2台以内に設定

connectServerList

connectServerListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
specCode String Required Connectサーバスペックコード
softwareCode String Optional Connectサーバソフトウェアコード
storageSize Integer Required Connectサーバブロックストレージ容量(GB)
  • 10~2000
  • 10GB単位で設定
userPassword1 String Conditional Connectサーバの ncp1アカウントパスワード
  • 英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、`、₩、/、&、$、スペース
userPassword2 String Conditional Connectサーバの ncp2アカウントパスワード
  • 英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、`、₩、/、&、$、スペース

linuxServerList

linuxServerListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
specCode String Required Linuxサーバスペックコード
softwareCode String Required Linuxサーバソフトウェアコード
storageSize Integer Required Linuxサーバブロックストレージ容量(GB)
  • 10~2000
  • 10GB単位で設定
userPassword String Required Linuxサーバアカウントのパスワード
  • 英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、`、₩、/、&、$、スペース

windowsServerList

windowsServerListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
specCode String Required Windows Serverスペックコード
softwareCode String Required Windows Serverソフトウェアコード
storageSize Integer Required Windows Serverブロックストレージ容量(GB)
  • 10~2000
  • 10GB単位で設定
userPassword String Required Windows Serverアカウントのパスワード
  • 英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、`、₩、/、&、$、スペース

nasList

nasListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
nasSize Integer Optional NASボリュームサイズ(GB)
  • 500~10000
  • 100GB単位で設定
count Integer Optional NAS数

hadoopList

hadoopListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
EdgeNodeSpecCode String Optional エッジノードスペックコード
masterNodeSpecCode String Optional マスターノードスペックコード
masterNodeStorageSize Integer Optional マスターノードブロックストレージ容量(GB)
  • 100~2000
  • 10GB単位で設定
workerNodeSpecCode String Optional ワーカーノードスペックコード
workerNodeCount Integer Optional ワーカーノード数
workerNodeStorageSize Integer Optional ワーカーノードブロックストレージ容量(GB)
  • 100~2000
  • 10GB単位で設定
userPassword String Conditional Hadoopクラスタアカウントのパスワード
  • 英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、`、₩、/、&、$、スペース

tensorFlowCpuServerList

tensorFlowCpuServerListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
specCode String Optional TensorFlow CPUサーバスペックコード
softwareCode String Optional TensorFlow CPUサーバソフトウェアコード
storageSize Integer Optional TensorFlow CPUサーバブロックストレージ容量(GB)
  • 100~2000
  • 10GB単位で設定
userPassword String Conditional TensorFlow CPUサーバアカウントのパスワード
  • 英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、`、₩、/、&、$、スペース

tensorFlowGpuServerList

tensorFlowGpuServerListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
specCode String Optional TensorFlow GPUサーバスペックコード
softwareCode String Optional TensorFlow GPUサーバソフトウェアコード
storageSize Integer Optional TensorFlow GPUサーバブロックストレージ容量(GB)
  • 100~2000
  • 10GB単位で設定
userPassword String Conditional TensorFlow GPUサーバアカウントのパスワード
  • 英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、`、₩、/、&、$、スペース

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://datafence.apigw.ntruss.com/api/v1/box/create-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 '{
  "fenceId": 26,
  "createBoxInfo": {
    "connectServerList": [
      {
        "specCode": "SVR.VSVR.STAND.C004.M016.NET.SSD.B100.G002",
        "softwareCode": "",
        "storageSize": 300,
        "userPassword1": "Password1000#",
        "userPassword2": "Password1000#"
      }
    ],
    "linuxServerList": [
      {
        "specCode": "SVR.VSVR.STAND.C004.M016.NET.SSD.B050.G002",
        "softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR2004.B050",
        "storageSize": 500,
        "userPassword": "Password1000#"
      }
    ],
    "windowsServerList": [
      {
        "specCode": "SVR.VSVR.STAND.C004.M016.NET.SSD.B100.G002",
        "softwareCode": "SW.VSVR.OS.WND64.WND.SVR2019EN.B100",
        "storageSize": 500,
        "userPassword": "Password1000#"
      }
    ],
    "nasList": [
      {
        "nasSize": 500,
        "count": 1
      }
    ]
  }
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
message String - API処理結果メッセージ

レスポンスステータスコード

Datafence APIで共通して使用されるレスポンスステータスコードの詳細は、Datafence APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "message": "Box creation requested."
}