modify-data-box

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番号 get-data-box-frame-listを参照
`dataBoxInfo`	Object	Required	Data Box情報
`dataBoxInfo.dataBoxNo`	String	Required	Data Box番号 get-data-box-listを参照
`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サーバにア追加されているブロックストレージのインスタンス番号 get-data-box-infra-listを参照 `actionType`が`UPDATE`の場合
`prodSpecId`	Integer	Conditional	Connectサーバスペックコード Product Spec Codeを参照 `actionType`が`CREATE`、`UPDATE`の場合、必ず入力
`serverInstanceNo`	Integer	Conditional	Connectサーバインスタンス番号 get-data-box-infra-listを参照 `actionType`が`UPDATE`の場合、必ず入力
`storageSize`	Integer	Optional	Connectサーバブロックストレージ容量(GB) `actionType`が`CREATE`、`UPDATE`の場合
`adminPassword`	String	Conditional	Connectサーバアドミンアカウントパスワード英数字、記号を組み合わせて8~14文字以内で入力使用できない記号: '、"、₩、/、&、`、スペース `actionType`が`CREATE`の場合、必ず入力
`userPassword1`	String	Conditional	Connectサーバ ncp1アカウントパスワード英数字、記号を組み合わせて8~14文字以内で入力使用できない記号: '、"、₩、/、&、`、スペース `actionType`が`CREATE`の場合、必ず入力
`userPassword2`	String	Conditional	Connectサーバ ncp2アカウントパスワード英数字、記号を組み合わせて8~14文字以内で入力使用できない記号: '、"、₩、/、&、`、スペース `actionType`が`CREATE`の場合、必ず入力

`hadoopList`

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

フィールド	タイプ	必須の有無	説明
`actionType`	String	Optional	処理タイプ `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 作成 `UPDATE`: 更新 `DELETE`: 返却
`hadoopInstanceNo`	Integer	Conditional	Hadoopクラスタインスタンス番号 get-data-box-infra-listを参照 `actionType`が`UPDATE`の場合、必ず入力
`EdgeNodeProdSpecId`	Integer	Conditional	エッジノードサーバスペックコード Product Spec Codeを参照 `actionType`が`CREATE`、`UPDATE`の場合、必ず入力
`masterNodeProdSpecId`	Integer	Conditional	マスターノードサーバスペックコード Product Spec Codeを参照 `actionType`が`CREATE`、`UPDATE`の場合、必ず入力
`masterNodeStorageSize`	Integer	Optional	マスターノードブロックストレージ容量(GB) `actionType`が`CREATE`の場合
`workerNodeCount`	Integer	Optional	ワーカーノード数 `actionType`が`CREATE`の場合
`workerNodeProdSpecId`	Integer	Conditional	ワーカーノードサーバスペックコード Product Spec Codeを参照 `actionType`が`CREATE`、`UPDATE`の場合、必ず入力
`workerNodeStorageSize`	Integer	Optional	ワーカーノードブロックストレージ容量(GB) `actionType`が`CREATE`の場合
`userPassword`	String	Conditional	Hadoopクラスタアカウントパスワード英数字、記号を組み合わせて8~14文字以内で入力使用できない記号: '、"、₩、/、&、`、スペース `actionType`が`CREATE`の場合、必ず入力

`linuxServerList`

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

フィールド	タイプ	必須の有無	説明
`actionType`	String	Optional	処理タイプ `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 作成 `UPDATE`: 更新 `DELETE`: 返却
`blockStorageInstanceNo`	Integer	Optional	Linuxサーバに追加されているブロックストレージのインスタンス番号 get-data-box-infra-listを参照 `actionType`が`UPDATE`の場合
`prodSpecId`	Integer	Optional	Linuxサーバスペックコード Product Spec Codeを参照 `actionType`が`CREATE`、`UPDATE`の場合、必ず入力
`serverInstanceNo`	Integer	Conditional	Linuxサーバインスタンス番号 get-data-box-infra-listを参照 `actionType`が`UPDATE`の場合、必ず入力
`storageSize`	Integer	Optional	Linuxサーバブロックストレージ容量(GB) `actionType`が`CREATE`、`UPDATE`の場合
`userPassword`	String	Conditional	Linuxサーバアカウントパスワード英数字、記号を組み合わせて8~14文字以内で入力使用できない記号: '、"、₩、/、&、`、スペース `actionType`が`CREATE`の場合、必ず入力

`nasList`

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

フィールド	タイプ	必須の有無	説明
`actionType`	String	Required	処理タイプ `CREATE` \| `DELETE` `CREATE`: 作成 `DELETE`: 返却
`count`	Integer	Optional	NAS数 `actionType`が`CREATE`の場合
`nasInstanceNo`	Integer	Conditional	NASインスタンス番号 get-data-box-infra-listを参照 `actionType`が`DELETE`の場合、必ず入力
`nasSize`	Integer	Optional	NASボリュームサイズ(GB) `actionType`が`CREATE`の場合

`tensorFlowCpuServerList`

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

フィールド	タイプ	必須の有無	説明
`actionType`	String	Optional	処理タイプ `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 作成 `UPDATE`: 更新 `DELETE`: 返却
`blockStorageInstanceNo`	Integer	Optional	TensorFlow CPUサーバに追加されているブロックストレージのインスタンス番号 get-data-box-infra-listを参照 `actionType`が`UPDATE`の場合
`prodSpecId`	Integer	Optional	TensorFlow CPUサーバスペックコード Product Spec Codeを参照 `actionType`が`CREATE`、`UPDATE`の場合、必ず入力
`serverInstanceNo`	Integer	Conditional	TensorFlow CPUサーバインスタンス番号 get-data-box-infra-listを参照 `actionType`が`UPDATE`の場合、必ず入力
`storageSize`	Integer	Optional	TensorFlow CPUサーバのブロックストレージ容量(GB) `actionType`が`CREATE`、`UPDATE`の場合
`userPassword`	String	Conditional	TensorFlow CPUサーバアカウントパスワード英数字、記号を組み合わせて8~14文字以内で入力使用できない記号: '、"、₩、/、&、`、スペース `actionType`が`CREATE`の場合、必ず入力

`tensorFlowGpuServerList`

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

フィールド	タイプ	必須の有無	説明
`actionType`	String	Optional	処理タイプ `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 作成 `UPDATE`: 更新 `DELETE`: 返却
`blockStorageInstanceNo`	Integer	Optional	TensorFlow GPUサーバに追加されているブロックストレージのインスタンス番号 get-data-box-infra-listを参照 `actionType`が`UPDATE`の場合
`prodSpecId`	Integer	Optional	TensorFlow GPUサーバスペックコード Product Spec Codeを参照 `actionType`が`CREATE`、`UPDATE`の場合、必ず入力
`serverInstanceNo`	Integer	Conditional	TensorFlow GPUサーバインスタンス番号 get-data-box-infra-listを参照 `actionType`が`UPDATE`の場合、必ず入力
`storageSize`	Integer	Optional	TensorFlow GPUサーバのブロックストレージ容量(GB) `actionType`が`CREATE`、`UPDATE`の場合
`userPassword`	String	Conditional	TensorFlow GPUサーバアカウントパスワード英数字、記号を組み合わせて8~14文字以内で入力使用できない記号: '、"、₩、/、&、`、スペース `actionType`が`CREATE`の場合、必ず入力

リクエスト例

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

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."
}