get-data-box-frame-detail

VPC環境で利用できます。

Data Box Frameの詳細情報を照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/data-box-frame/get-data-box-frame-detail

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`dataBoxFrameNo`	Integer	Required	Data Box Frame番号 get-data-box-frame-listを参照

リクエスト例

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

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/get-data-box-frame-detail?dataBoxFrameNo=83' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`dataBoxFrameNo`	String	-	Data Box Frame番号
`dataBoxFrameName`	String	-	Data Box Frame名
`dataBoxCount`	String	-	Data Box数
`createDate`	String	-	Data Box Frameの作成日時 YYYY-MM-DD HH:mm:ss形式
`statusCode`	String	-	Data Box Frameの状態コード `SET_READY` \| `SET_INIT` \| `SET_USE` \| `SET_ING` \| `SET_RTN` \| `SET_TERMT` `SET_READY`: 申し込み中 `SET_INIT`: 作成中 `SET_USE`: 利用中 `SET_ING`: 変更中 `SET_RTN`: 返却中 `SET_TERMT`: 返却完了
`statusName`	String	-	Data Box Frameの状態名 `Request for creating` \| `Initial State` \| `Using` \| `Changing` \| `Returning` \| `Terminated` `Request for creating`: 申し込み中 `Initial State`: 作成中 `Using`: 利用中 `Changing`: 変更中 `Returning`: 返却中 `Terminated`: 返却完了
`memo`	String	-	Data Box Frameに関する説明
`exportBucketName`	String	-	持ち出し審査用 Object Storageバケット名
`usePseudonymInfo`	String	-	インフラ管理権限を拡大するかどうか `Y` \| `N`

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

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

レスポンス例

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

{
    "dataBoxFrameNo": "83",
    "dataBoxFrameName": "dbf001",
    "dataBoxCount": "1",
    "createDate": "2025-03-25 11:20:11",
    "statusCode": "SET_USE",
    "statusName": "Using",
    "memo": "dbf001",
    "exportBucketName": "export_bucket",
    "usePseudonymInfo": "N"
}