change-box-infra

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
POST	/api/v1/box/change-box-infra

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`fenceId`	Integer	Required	Datafence番号 get-datafenceを参照
`updateBoxInfo`	Object	Required	Boxの更新情報
`updateBoxInfo.boxId`	Integer	Required	Box番号 get-box-listを参照
`updateBoxInfo.description`	String	Optional	Boxの説明
`updateBoxInfo.connectServerList`	Array	Optional	Connectサーバリスト 1~4台以内に設定
`updateBoxInfo.linuxServerList`	Array	Optional	Linuxサーバリスト 1~4台以内に設定
`updateBoxInfo.windowsServerList`	Array	Optional	Windows Serverリスト 0~4台以内に設定
`updateBoxInfo.boxNasList`	Array	Optional	NASリスト 1台以上に設定
`updateBoxInfo.hadoopList`	Array	Optional	Hadoopクラスタリスト最大2つのクラスタに設定
`updateBoxInfo.tensorFlowCpuServerList`	Array	Optional	TensorFlow CPUサーバリスト最大4台まで設定
`updateBoxInfo.tensorFlowGpuServerList`	Array	Optional	TensorFlow GPUサーバリスト最大2台まで設定

`connectServerList`

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

フィールド	タイプ	必須の有無	説明
`actionType`	String	Required	処理タイプ `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 作成 `UPDATE`: 更新 `DELETE`: 返却
`serverInstanceNo`	String	Conditional	Connectサーバインスタンス番号 get-box-infra-listを参照 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`blockStorageInstanceNo`	String	Conditional	Connectサーバブロックストレージインスタンス番号 get-box-infra-listを参照 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`specCode`	String	Conditional	Connectサーバスペックコード `actionType`が`CREATE`または`UPDATE`の場合、必ず入力 get-product-specを参照
`storageSize`	Integer	Conditional	Connectサーバブロックストレージ容量(GB) `actionType`が`CREATE`または`UPDATE`の場合、必ず入力 10~2000 10GB単位で設定
`userPassword1`	String	Conditional	Connectサーバの ncp1アカウントパスワード英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力使用できない記号: '、"、`、₩、/、&、$、スペース
`userPassword2`	String	Conditional	Connectサーバの ncp2アカウントパスワード英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力使用できない記号: '、"、`、₩、/、&、$、スペース

`linuxServerList`

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

フィールド	タイプ	必須の有無	説明
`actionType`	String	Required	処理タイプ `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 作成 `UPDATE`: 更新 `DELETE`: 返却
`serverInstanceNo`	String	Conditional	Linuxサーバインスタンス番号 get-box-infra-listを参照 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`blockStorageInstanceNo`	String	Conditional	Linuxサーバブロックストレージインスタンス番号 get-box-infra-listを参照 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`specCode`	String	Conditional	Linuxサーバスペックコード `actionType`が`CREATE`または`UPDATE`の場合、必ず入力 get-product-specを参照
`softwareCode`	String	Conditional	Linuxサーバソフトウェアコード `actionType`が`CREATE`または`UPDATE`の場合、必ず入力
`storageSize`	Integer	Conditional	Linuxサーバブロックストレージ容量(GB) `actionType`が`CREATE`または`UPDATE`の場合、必ず入力 10~2000 10GB単位で設定
`userPassword`	String	Conditional	Linuxサーバアカウントのパスワード英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力使用できない記号: '、"、`、₩、/、&、$、スペース

`windowsServerList`

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

フィールド	タイプ	必須の有無	説明
`actionType`	String	Required	処理タイプ `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 作成 `UPDATE`: 更新 `DELETE`: 返却
`serverInstanceNo`	String	Conditional	Windows Serverインスタンス番号 get-box-infra-listを参照 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`blockStorageInstanceNo`	String	Conditional	Windows Serverブロックストレージインスタンス番号 get-box-infra-listを参照 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`specCode`	String	Conditional	Windows Serverスペックコード `actionType`が`CREATE`または`UPDATE`の場合、必ず入力 get-product-specを参照
`softwareCode`	String	Conditional	Windows Serverソフトウェアコード `actionType`が`CREATE`または`UPDATE`の場合、必ず入力
`storageSize`	Integer	Conditional	Windows Serverブロックストレージ容量(GB) `actionType`が`CREATE`または`UPDATE`の場合、必ず入力 10~2000 10GB単位で設定
`userPassword`	String	Conditional	Windows Serverアカウントのパスワード英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力使用できない記号: '、"、`、₩、/、&、$、スペース

`boxNasList`

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

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

`hadoopList`

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

参考

Hadoopクラスタのハードウェアスペックやワーカー(データ)ノード数を変更する際は、既存のクラスタ情報と変更後情報を一緒に入力します。詳細は、リクエスト例のコメントをご参照ください。

フィールド	タイプ	必須の有無	説明
`actionType`	String	Required	処理タイプ `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 作成 `UPDATE`: 更新 `DELETE`: 返却
`hadoopClusterNo`	String	Conditional	Hadoopクラスタ番号 get-box-infra-listを参照 `infraType`が`HD`のインフラの`instanceNo`を入力 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`edgeNodeSpecCode`	String	Conditional	エッジノードスペックコード get-product-specを参照 `actionType`が`CREATE`または`UPDATE`の場合、必ず入力
`masterNodeSpecCode`	String	Conditional	マスターノードスペックコード get-product-specを参照 `actionType`が`CREATE`または`UPDATE`の場合、必ず入力
`masterNodeStorageSize`	Integer	Conditional	マスターノードブロックストレージ容量(GB) `actionType`が`CREATE`の場合、必ず入力 100~2000 10GB単位で設定 4000GB、6000GBも使用可能
`workerNodeSpecCode`	String	Conditional	ワーカーノードスペックコード get-product-specを参照 `actionType`が`CREATE`または`UPDATE`の場合、必ず入力
`workerNodeStorageSize`	Integer	Conditional	ワーカーノードブロックストレージ容量(GB) `actionType`が`CREATE`の場合、必ず入力 100~2000 10GB単位で設定 4000GB、6000GBも使用可能
`workerNodeCount`	Integer	Conditional	ワーカーノード数 `actionType`が`CREATE`または`UPDATE`の場合、必ず入力
`userPassword`	String	Conditional	Hadoopクラスタアカウントのパスワード英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力使用できない記号: '、"、`、₩、/、&、$、スペース

`tensorFlowCpuServerList`

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

フィールド	タイプ	必須の有無	説明
`actionType`	String	Required	処理タイプ `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 作成 `UPDATE`: 更新 `DELETE`: 返却
`serverInstanceNo`	String	Conditional	TensorFlow CPUサーバインスタンス番号 get-box-infra-listを参照 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`blockStorageInstanceNo`	String	Conditional	TensorFlow CPUサーバブロックストレージインスタンス番号 get-box-infra-listを参照 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`specCode`	String	Conditional	TensorFlow CPUサーバスペックコード get-product-specを参照 `actionType`が`CREATE`または`UPDATE`の場合、必ず入力
`softwareCode`	String	Conditional	TensorFlow CPUサーバソフトウェアコード get-product-specを参照 `actionType`が`CREATE`または`UPDATE`の場合、必ず入力
`storageSize`	Integer	Conditional	TensorFlow CPUサーバブロックストレージ容量(GB) `actionType`が`CREATE`または`UPDATE`の場合、必ず入力 100~2000 10GB単位で設定
`userPassword`	String	Conditional	TensorFlow CPUサーバアカウントのパスワード英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力使用できない記号: '、"、`、₩、/、&、$、スペース

`tensorFlowGpuServerList`

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

フィールド	タイプ	必須の有無	説明
`actionType`	String	Required	処理タイプ `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 作成 `UPDATE`: 更新 `DELETE`: 返却
`serverInstanceNo`	String	Conditional	TensorFlow GPUサーバインスタンス番号 get-box-infra-listを参照 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`blockStorageInstanceNo`	String	Conditional	TensorFlow GPUサーバブロックストレージインスタンス番号 get-box-infra-listを参照 `actionType`が`UPDATE`または`DELETE`の場合、必ず入力
`specCode`	String	Conditional	TensorFlow GPUサーバスペックコード get-product-specを参照 `actionType`が`CREATE`または`UPDATE`の場合、必ず入力
`softwareCode`	String	Conditional	TensorFlow GPUサーバソフトウェアコード get-product-specを参照 `actionType`が`CREATE`または`UPDATE`の場合、必ず入力
`storageSize`	Integer	Conditional	TensorFlow GPUサーバブロックストレージ容量(GB) `actionType`が`CREATE`または`UPDATE`の場合、必ず入力 100~2000 10GB単位で設定
`userPassword`	String	Conditional	TensorFlow GPUサーバアカウントのパスワード英字の大文字、小文字、数字、記号をそれぞれ1文字以上組み合わせて8~14文字以内で入力使用できない記号: '、"、`、₩、/、&、$、スペース

リクエスト例

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

curl --location --request POST 'https://datafence.apigw.ntruss.com/api/v1/box/change-box-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 '{
  "fenceId": 1,
  "boxId": 1,
  "connectServerList": [
    {
      "actionType": "UPDATE",
      "serverInstanceNo": *********,
      "specCode": "SVR.VSVR.STAND.C004.M016.NET.SSD.B100.G002",
      "storageSize": 500
    }
  ],
  "hadoopList": [
      {
        "actionType": "UPDATE",
        "hadoopClusterNo": *********,
        "edgeNodeSpecCode": "SVR.VCHDP.EDGND.HICPU.C008.M016.NET.HDD.B050.G002",      // 変更後スペックコードを入力
        "masterNodeSpecCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",    // 現在のスペックコードを入力
        "dataNodeSpecCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",      // 現在のスペックコードを入力
        "dataNodeCount": 2                                                            // 現在の数を入力
      }
    ]
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

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