get-export-apply-list

Prev Next

VPC環境で利用できます。

Data Boxからのファイル持ち出し申請リストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
dataBoxFrameNo Integer Required Data Box Frame番号
dataBoxNo Integer Required Data Box番号
applyStartDate String Optional 照会開始日時
  • yyyyMMddHHmmss形式
applyEndDate String Optional 照会終了日時
  • yyyyMMddHHmmss形式
pageNo Integer Optional ページ番号
  • 1~1000 (デフォルト: 1)
pageSize Integer Optional ページの出力数
  • 1~1000 (デフォルト: 10)
status String Optional 持ち出し申請の状態コード

リクエスト例

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

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/export/get-export-apply-list?dataBoxFrameNo=83&dataBoxNo=381&applyStartDate=20250325000000&applyEndDate=20250329000000&pageNo=1&pageSize=1000&status=REQ_CMPL' \
--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 - 持ち出し申請の状態コード
rejectReason 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"
        }
    ]
}