get-data-box-frame-detail
- 印刷する
- PDF
get-data-box-frame-detail
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
作成した Data Box Frameの詳細情報を照会します。
GET https://{endpoint}/data-box-frame/data-box-frame/get-data-box-frame-detail
リクエスト
リクエストパラメータ
| パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| dataBoxFrameNo | No | Integer | Data Box Frame番号 |
レスポンス
| HTTPステータスコード | 説明 |
|---|---|
| 200 | 成功 |
| 400 | リクエスト情報エラー |
| 401 | 認証失敗 |
| 403 | リクエスト情報に対する権限なし |
| 404 | リソースが存在しない |
| 500 | サーバエラー |
例
リクエスト例
GET https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/get-data-box-frame-detail?dataBoxFrameNo=1046
レスポンス例
{
"dataBoxFrameNo": "1046",
"dataBoxFrameName": "frame-sample",
"dataBoxCount": "1",
"createDate": "2023-03-15 10:53:10",
"statusCode": "SET_USE",
"statusName": "Using",
"memo": "memo sample",
"exportBucketName": "011",
"usePseudonymInfo": "Y"
}
プロパティ
| 項目 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| dataBoxFrameNo | Yes | String | Data Box Frame番号 | |
| dataBoxFrameName | Yes | String | Data Box Frame名 | |
| dataBoxCount | Yes | String | Data Box Frame内の Data Boxの数 | |
| createDate | Yes | String | Data Box Frameの作成日時 | |
| statusCode | Yes | String | Data Box Frameのステータスコード | |
| statusName | Yes | String | Data Box Frameのステータス名 | |
| memo | No | String | Data Box Frameメモ | |
| exportBucketName | Yes | String | 持ち出し審査用 Object Storage Bucket名 | |
| usePseudonymInfo | Yes | String | インフラ管理権限の強化有無(Y、N) |
エラーコード
| HTTP Status Code | リターンコード | 説明 |
|---|---|---|
| 200 | - | 一般的なリクエスト成功 |
| 400 | 10001, 130*** | リクエスト情報とパラメータエラー |
| 403 | 10002 | リクエスト情報に対する権限なし |
| 404 | 10009 | リソースが存在しない |
| 500 | 130000 | サービス内部エラー |
| 500 | 139999 | 連携サービス APIの呼び出しエラー |
この記事は役に立ちましたか?