get-export-list

Prev Next

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
fenceId Integer Required Datafence番号
boxId Integer Required Box番号
status String Optional 持ち出し申請の状態コード
from String Optional 照会開始日時
  • yyyyMMddHHmmss形式
to String Optional 照会終了日時
  • yyyyMMddHHmmss形式
page Integer Optional ページ番号
  • 0~100 (デフォルト: 0)
size Integer Optional ページごとの項目数
  • 1~100 (デフォルト: 10)

リクエスト例

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/export/get-export-list?fenceId=26&boxId=74&status=IMPORTED&from=20250401000000&to=20250430000000' \
--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の説明は次の通りです。

フィールド タイプ 必須の有無 説明
fileId Integer - 持ち出し申請番号
fenceId Integer - Datafence番号
boxId Integer - Box番号
boxName String - Box名
requesterId String - 持ち出し申請者 ID
sourceNasName String - Source NAS名
sourceFilePath String - 持ち出し申請対象のファイル名
targetBucketName String - Targetバケット名
statusCode String - 持ち出し申請の状態コード
statusName String - 持ち出し申請の状態名
rejectReason String - 持ち出し申請却下の理由
  • 持ち出し審査で却下された場合に表示
description String - 持ち出し申請に関する説明
createDate String - 持ち出しの申請日時
  • ISO 8601形式(UTC+9を含む)
resultDate String - 持ち出し審査日時
  • ISO 8601形式(UTC+9を含む)
  • 持ち出し審査を完了した場合、表示

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

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

レスポンス例

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

{
    "totalCount": 6,
    "content": [
        {
            "fileId": 102,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "requesterId": "nb********@navercorp.com",
            "sourceNasName": "74box1",
            "sourceFilePath": "117_datafence001.csv",
            "targetBucketName": "defence001",
            "statusCode": "UPLOADED",
            "statusName": "審査のリクエスト(ファイル転送完了)",
            "description": "ファイル持ち出しテスト",
            "createDate": "2025-04-25T16:26:09+09:00"
        },
        {
            "fileId": 100,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "requesterId": "nb********@navercorp.com",
            "sourceNasName": "74box1",
            "sourceFilePath": "117_datafence001.csv",
            "targetBucketName": "defence001",
            "statusCode": "REJECTED",
            "statusName": "却下",
            "rejectReason": "-",
            "description": "ファイル持ち出しテスト",
            "createDate": "2025-04-25T16:00:25+09:00",
            "resultDate": "2025-04-25T16:22:03+09:00"
        },
        {
            "fileId": 99,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "requesterId": "nb********@navercorp.com",
            "sourceNasName": "74box1",
            "sourceFilePath": "116_sample.xlsx",
            "targetBucketName": "defence001",
            "statusCode": "EXPORTED",
            "statusName": "承認(バケット保存完了)",
            "description": "ファイル持ち出しテスト",
            "createDate": "2025-04-25T16:00:25+09:00",
            "resultDate": "2025-04-25T16:07:20+09:00"
        }
    ]
}