get-import-list

Prev Next

VPC環境で利用できます。

Boxへのファイル持ち込み申請リストを照会します。

リクエスト

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

メソッド URI
GET /api/v1/import/get-import-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/import/get-import-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名
description String - 持ち込み申請に関する説明
sourceBucketName String - Sourceバケット名
sourceFilePath String - 持ち込み申請対象のファイル名
targetNasName String - Target NAS名
statusCode String - 持ち込み申請の状態コード
statusName String - 持ち込み申請の状態名
createDate String - 持ち込みの申請日時
  • ISO 8601形式(UTC+9を含む)
completeDate String - 持ち込みの完了日時
  • ISO 8601形式(UTC+9を含む)

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

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

レスポンス例

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

{
    "totalCount": 3,
    "content": [
        {
            "fileId": 113,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "sourceBucketName": "test-bucket-for-fence",
            "sourceFilePath": "archive3.zip",
            "targetNasName": "74box1",
            "description": "ファイル持ち込みの申請",
            "statusCode": "INITIALIZED",
            "statusName": "持ち込みの申請(ファイル転送前)",
            "createDate": "2025-04-25T11:22:07+09:00"
        },
        {
            "fileId": 112,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "sourceBucketName": "test-bucket-for-fence",
            "sourceFilePath": "archive2.zip",
            "targetNasName": "74box1",
            "description": "ファイル持ち込みの申請",
            "statusCode": "UPLOADING",
            "statusName": "持ち込みの申請(ファイル転送中)",
            "createDate": "2025-04-25T11:22:07+09:00"
        },
        {
            "fileId": 111,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "sourceBucketName": "test-bucket-for-fence",
            "sourceFilePath": "archive.zip",
            "targetNasName": "74box1",
            "description": "ファイル持ち込みの申請",
            "statusCode": "IMPORTED",
            "statusName": "持ち込み完了",
            "createDate": "2025-04-25T11:22:07+09:00",
            "completeDate": "2025-04-25T11:22:44+09:00"
        }
    ]
}