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