create-data-box

Prev Next

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
dataBoxFrameNo String Required Data Box Frame番号
dataBoxInfo Object Required Data Box情報
dataBoxInfo.connectServerList Array Required Connectサーバリスト
dataBoxInfo.hadoopList Array Optional Hadoopクラスタリスト
dataBoxInfo.linuxServerList Array Optional Linuxサーバリスト
dataBoxInfo.memo String Optional Data Boxに関する説明
dataBoxInfo.nasList Array Required NASリスト
dataBoxInfo.sslVpnCount Integer Required Data Boxで使用する SSL VPNアカウント数
  • Connectサーバの最大数の3倍まで
dataBoxInfo.tensorFlowCpuServerList Array Conditional TensorFlow CPUサーバリスト
  • tensorFlowGpuServerList未設定時は必ず入力
dataBoxInfo.tensorFlowGpuServerList Array Conditional TensorFlow GPUサーバリスト
  • tensorFlowCpuServerList未設定時は必ず入力

connectServerList

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

フィールド タイプ 必須の有無 説明
prodSpecId Integer Optional Connectサーバスペックコード
storageSize Integer Optional Connectサーバブロックストレージ容量(GB)
adminPassword String Conditional Connectサーバアドミンアカウントパスワード
  • 英数字、記号を組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、₩、/、&、`、スペース
userPassword1 String Conditional Connectサーバの ncp1アカウントパスワード
  • 英数字、記号を組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、₩、/、&、`、スペース
userPassword2 String Conditional Connectサーバの ncp2アカウントパスワード
  • 英数字、記号を組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、₩、/、&、`、スペース

hadoopList

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

フィールド タイプ 必須の有無 説明
edgeNodeProdSpecId Integer Optional エッジノードサーバスペックコード
masterNodeProdSpecId Integer Optional マスターノードサーバスペックコード
masterNodeStorageSize Integer Optional マスターノードブロックストレージ容量(GB)
workerNodeProdSpecId Integer Optional ワーカーノードサーバスペックコード
workerNodeCount Integer Optional ワーカーノード数
workerNodeStorageSize Integer Optional ワーカーノードブロックストレージ容量(GB)
userPassword String Optional Hadoopクラスタアカウントパスワード
  • 英数字、記号を組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、₩、/、&、`、スペース

linuxServerList

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

フィールド タイプ 必須の有無 説明
prodSpecId Integer Optional Linuxサーバスペックコード
storageSize Integer Optional Linuxサーバブロックストレージ容量(GB)
userPassword String Optional Linuxサーバアカウントパスワード
  • 英数字、記号を組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、₩、/、&、`、スペース

nasList

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

フィールド タイプ 必須の有無 説明
count Integer Optional NAS数
nasSize Integer Optional NASボリュームサイズ(GB)
  • actionTypeCREATEの場合、有効

tensorFlowCpuServerList

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

フィールド タイプ 必須の有無 説明
prodSpecId Integer Optional TensorFlow CPUサーバスペックコード
storageSize Integer Optional TensorFlow CPUサーバブロックストレージ容量(GB)
userPassword String Conditional TensorFlow CPUサーバアカウントパスワード
  • 英数字、記号を組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、₩、/、&、`、スペース
  • actionTypeCREATEの場合、必ず入力

tensorFlowGpuServerList

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

フィールド タイプ 必須の有無 説明
prodSpecId Integer Optional TensorFlow GPUサーバスペックコード
storageSize Integer Optional TensorFlow GPUサーバブロックストレージ容量(GB)
userPassword String Conditional TensorFlow GPUサーバアカウントパスワード
  • 英数字、記号を組み合わせて8~14文字以内で入力
  • 使用できない記号: '、"、₩、/、&、`、スペース
  • actionTypeCREATEの場合、必ず入力

リクエスト例

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

curl --location --request POST 'https://databoxframe.apigw.ntruss.com/api/v1/data-box/create-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": {
        "connectServerList": [
            {
                "prodSpecId": 4003,
                "storageSize": 500,
                "userPassword1": "********",
                "userPassword2": "********",
                "adminPassword": "********"
            }
        ],
        "hadoopList": [
            {
                "edgeNodeProdSpecId": 5001,
                "masterNodeProdSpecId": 5101,
                "masterNodeStorageSize": 500,
                "workerNodeProdSpecId": 5201,
                "workerNodeCount": 2,
                "workerNodeStorageSize": 500,
                "userPassword": "********"
            }
        ],
        "linuxServerList": [
            {
                "prodSpecId": 6001,
                "storageSize": 500,
                "userPassword": "********"
            }
        ],
        "memo": "about data box frame",
        "nasList": [
            {
                "count": 1,
                "nasSize": 500
            }
        ],
        "sslVpnCount": 1,
        "tensorFlowCpuServerList": [
            {
                "prodSpecId": 7001,
                "storageSize": 500,
                "userPassword": "********"
            }
        ],
        "tensorFlowGpuServerList": [
            {
                "prodSpecId": 7101,
                "storageSize": 500,
                "userPassword": "********"
            }
        ]
    }
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "returnMessage": "A Data Box creation has been requested."
}