データ持ち込み履歴の照会

VPC環境で利用できます。

データ持ち込み履歴を照会します。

リクエスト

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

メソッド	URI
GET	/api/v2/import/getDataImportHistory/{serviceGroupInstanceNo} (韓国リージョン)
GET	/api/sgn-v2/import/getDataImportHistory/{serviceGroupInstanceNo} (シンガポールリージョン)
GET	/api/jpn-v2/import/getDataImportHistory/{serviceGroupInstanceNo} (日本リージョン)

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`serviceGroupInstanceNo`	Integer	Required	クラスタインスタンス番号クラスタリストの照会を参照

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Integer	Optional	ページの出力数 1~N (デフォルト: 10)

リクエスト例

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

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/import/getDataImportHistory/1037*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	Integer	-	レスポンスコード
`message`	String	-	レスポンスメッセージ
`result`	Object	-	レスポンス結果
`result.currentPage`	Integer	-	現在のページ番号
`result.isFirst`	Boolean	-	最初のページかどうか `true` \| `false` `true`: 最初のページ `false`: 最初のページではない
`result.isLast`	Boolean	-	最後のページかどうか `true` \| `false` `true`: 最後のページ `false`: 最後のページではない
`result.pageSize`	Integer	-	ページ表示数
`result.totalCount`	Integer	-	レスポンス結果数
`result.totalPage`	Integer	-	ページの総数
`result.importHistoryList`	Array	-	持ち込み履歴リスト
`requestId`	String	-	リクエスト ID UUID形式

`result.importHistoryList`

result.importHistoryListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`serviceGroupInstanceNo`	Integer	-	クラスタインスタンス番号
`clusterName`	String	-	クラスタ名
`importStatus`	String	-	持ち込みの進行状態 `complete` \| `processing` \| `stop` \| `fail` `complete`: 完了 `processing`: 進行中 `stop`: 停止 `fail`: 失敗(エラー)
`bucketName`	String	-	対象バケットの名前
`objectKey`	String	-	データファイルパス
`progress`	Integer	-	持ち込み進捗率
`actionStartDate`	String	-	作業開始日時 yyyy-MM-dd HH:mm:ss形式
`actionEndDate`	String	-	作業完了日時 yyyy-MM-dd HH:mm:ss形式

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 10,
        "totalCount": 2,
        "totalPage": 1,
        "importHistoryList": [
            {
                "serviceGroupInstanceNo": 1037*****,
                "clusterName": "cluster001",
                "importStatus": "complete",
                "bucketName": "bk.c",
                "objectKey": "data/sample_data.json",
                "progress": 100,
                "actionStartDate": "2025-03-26 08:49:35",
                "actionEndDate": "2025-03-26 08:50:47"
            },
            {
                "serviceGroupInstanceNo": 1037*****,
                "clusterName": "cluster001",
                "importStatus": "complete",
                "bucketName": "bk.c",
                "objectKey": "data/db_metadata.json",
                "progress": 100,
                "actionStartDate": "2025-03-26 08:42:51",
                "actionEndDate": "2025-03-26 08:42:53"
            }
        ]
    },
    "requestId": "48c5002e-****-****-****-6e43987f34c8"
}