get-export-apply-detail

Prev Next

VPC環境で利用できます。

Data Boxからのファイル持ち出し申請の詳細情報を照会します。

リクエスト

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

メソッド URI
GET /api/v1/export/get-export-apply-detail

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
dataBoxFrameNo Integer Required Data Box Frame番号
dataBoxNo Integer Required Data Box番号
exportApplyId Integer Required 持ち出し申請 ID

リクエスト例

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

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/export/get-export-apply-detail?dataBoxFrameNo=1046&dataBoxNo=194&exportApplyId=367' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
totalCount Integer - レスポンス結果数
content Array - 持ち出し申請リスト

content

contentの説明は次の通りです。

フィールド タイプ 必須の有無 説明
exportApplyId String - 持ち出し申請 ID
dataBoxName String - Data Box名
dataBoxNo String - Data Box番号
vpnId String - 持ち出し申請した SSL VPN ID
sourceNasName String - Source NAS名
sourceFileName String - 持ち出しファイル名
targetBucketName String - Targetバケット名
status String - 持ち出し申請の状態コード
applyDate String - 持ち出し申請日時
  • YYYY-MM-DD HH:mm:ss形式
resultDate String - 持ち出し審査日時
  • 持ち出し審査を完了した場合、表示
memo String - 持ち出し申請に関するメモ

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

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

レスポンス例

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

{
    "totalCount": 1,
    "content": [
        {
            "exportApplyId": "1543",
            "dataBoxName": "BOX#1",
            "dataBoxNo": "381",
            "vpnId": "***_******",
            "sourceNasName": "nasw381n1",
            "sourceFileName": "sample.xlsx",
            "targetBucketName": "testddfdas",
            "status": "REQ_CMPL",
            "applyDate": "2025-03-27 17:11:54",
            "memo": "export001"
        }
    ]
}