modify-data-box-frame-admin-infra

インフラの作成/返却/変更に時間がかかり、非同期方式に動作します。
リクエストが正常に送信された場合、固定メッセージを返します。

リクエスト

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
dataBoxFrameNo	Yes	Integer		Data Box Frame番号
memo	Yes	String		Data Box Frameメモ
adminServerList.actionType	Yes	String	CREATE: 作成 UPDATE: 修正 DELETE: 返却	処理タイプ
adminServerList.adminServerInstanceNo	No	Integer	actionTypeが CREATEの場合、無効	Adminサーバの Instance番号
adminServerList.userPassword	Yes	String	- 最小8文字、最大14文字 - アルファベットの小文字と大文字、特殊文字、数字のうち4種類を1文字以上含む - 以下の特殊文字は使用不可('、"、`、₩、/、&、$、Space)	Adminサーバに適用するパスワード
adminServerList.prodSpecId	No	Integer	actionTypeが DELETEの場合、無効	Product Spec Code
nasList.actionType	Yes	String	CREATE: 作成 DELETE: 返却	処理タイプ
nasList.nasInstanceNo	No	Integer	actionTypeが CREATEの場合、無効	NAS Instance番号
nasList.nasSize	No	Integer	actionTypeが DELETEの場合、無効	NASの容量
nasList.count	No	Integer	actionTypeが DELETEの場合、無効	NASの数量

パラメータ名

要否

タイプ

制約事項

説明

dataBoxFrameNo

Yes

Integer

Data Box Frame番号

memo

Yes

String

Data Box Frameメモ

adminServerList.actionType

Yes

String

CREATE: 作成
UPDATE: 修正
DELETE: 返却

処理タイプ

adminServerList.adminServerInstanceNo

Integer

actionTypeが CREATEの場合、無効

Adminサーバの Instance番号

adminServerList.userPassword

Yes

String

- 最小8文字、最大14文字
- アルファベットの小文字と大文字、特殊文字、数字のうち4種類を1文字以上含む
- 以下の特殊文字は使用不可('、"、`、₩、/、&、$、Space)

Adminサーバに適用するパスワード

adminServerList.prodSpecId

Integer

actionTypeが DELETEの場合、無効

Product Spec Code

nasList.actionType

Yes

String

CREATE: 作成
DELETE: 返却

処理タイプ

nasList.nasInstanceNo

Integer

actionTypeが CREATEの場合、無効

NAS Instance番号

nasList.nasSize

Integer

actionTypeが DELETEの場合、無効

NASの容量

nasList.count

Integer

actionTypeが DELETEの場合、無効

NASの数量

HTTPステータスコード	説明
200	成功
400	リクエスト情報エラー
401	認証失敗
403	リクエスト情報に対する権限なし
404	リソースが存在しない
500	サーバエラー

HTTPステータスコード

説明

200

成功

400

リクエスト情報エラー

401

認証失敗

403

リクエスト情報に対する権限なし

404

リソースが存在しない

500

サーバエラー

例

リクエスト例

{ "adminServerList": [ { "actionType": "CREATE", "adminServerInstanceNo": -, "prodSpecId": 1004, "userPassword": "-" } ], "dataBoxSetNo": "1046", "memo": "テスト", "nasList": [ { "actionType": "CREATE", "count": 1, "nasInstanceNo": -, "nasSize": 600 } ] }

レスポンス例

{ "returnMessage" : "Modification of the Data Box Frame infrastructure has been requested." }

プロパティ

項目	要否	タイプ	説明
totalCount	Yes	Integer	Data Boxのインフラ総数量
productCode	Yes	String	Product Code
productType	Yes	String	Productの詳細タイプ
prodSpecId	Yes	Integer	Product Spec Code
instanceNo	Yes	String	サーバの Instance No
instanceName	Yes	String	サーバの Instance Name
blockStorageInstanceNo	No	String	サーバに mountされた Block Storage Instance No
privateIp	No	String	サーバのプライベート IPアドレス(NASは非表示)
specName	Yes	String	サーバの Spec名(NASは容量)
connectionInfo1	No	String	サーバのアクセスアカウント名(NASはマウントパス)
connectionInfo2	No	String	Connectサーバの2番目のアカウント名
statusCode	Yes	String	インフラのステータスコード
statusName	Yes	String	インフラのステータス名
instanceStatusCode	No	String	サーバの現在のステータスコード(NASは非表示)

項目

要否

タイプ

制約事項

説明

totalCount

Yes

Integer

Data Boxのインフラ総数量

productCode

Yes

String

Product Code

productType

Yes

String

Productの詳細タイプ

prodSpecId

Yes

Integer

Product Spec Code

instanceNo

Yes

String

サーバの Instance No

instanceName

Yes

String

サーバの Instance Name

blockStorageInstanceNo

String

サーバに mountされた Block Storage Instance No

privateIp

String

サーバのプライベート IPアドレス(NASは非表示)

specName

Yes

String

サーバの Spec名(NASは容量)

connectionInfo1

String

サーバのアクセスアカウント名(NASはマウントパス)

connectionInfo2

String

Connectサーバの2番目のアカウント名

statusCode

Yes

String

インフラのステータスコード

statusName

Yes

String

インフラのステータス名

instanceStatusCode

String

サーバの現在のステータスコード(NASは非表示)

エラーコード

HTTP Status Code	リターンコード	説明
200	-	一般的なリクエスト成功
400	10001, 130***	リクエスト情報とパラメータエラー
403	10002	リクエスト情報に対する権限なし
404	10009	リソースが存在しない
500	130000	サービス内部エラー
500	139999	連携サービス APIの呼び出しエラー

HTTP Status Code

リターンコード

説明

200

一般的なリクエスト成功

400

10001,
130***

リクエスト情報とパラメータエラー

403

10002

リクエスト情報に対する権限なし

404

10009

リソースが存在しない

500

130000

サービス内部エラー

500

139999

連携サービス APIの呼び出しエラー

modify-data-box-frame-admin-infra

リクエスト

リクエストパラメータ

レスポンス

例

リクエスト例

レスポンス例

プロパティ

エラーコード

What's Next