VPC環境で利用できます。
Data Box Frameを返却します。インフラの返却に一定時間がかかりますので、非同期で処理されます。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /api/v1/data-box-frame/return-data-box-frame |
リクエストヘッダ
Data Box Frame APIで共通して使用されるヘッダの詳細は、Data Box Frameのリクエストヘッダをご参照ください。
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
dataBoxFrameNo |
Integer | Required | Data Box Frame番号 |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/return-data-box-frame' \
--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
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
returnMessage |
String | - | API処理結果メッセージ |
レスポンスステータスコード
Data Box Frame APIで共通して使用されるレスポンスステータスコードの詳細は、Data Box Frame APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"returnMessage": "A Data Box Frame return has been requested."
}