データ持ち込みの実行

Prev Next

VPC環境で利用できます。

Object Storageバケットに保存されているデータをクラスタに持ち込みます。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo Integer Required クラスタインスタンス番号

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
bucketName String Required バケット名
index String Required Index名
  • 英字の小文字、数字、記号の「-」を組み合わせて3~30文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 記号の「-」は連続使用不可
isBulkFormat Boolean Optional Bulkフォーマットするかどうか
objectKey String Required 持ち込みファイルのパス
  • {バケット内部フォルダ}/{ファイル名}形式で入力
  • JSONファイルのみ対応
dataSource String Required データソースの保存場所
  • OBJECT_STORAGE: Object Storage (有効値)

リクエスト例

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

curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/import/createDataImportJob/1037*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "bucketName": "bk.c",
    "index": "my-index",
    "isBulkFormat": false,
    "objectKey": "data/sample_data.json",
    "dataSource": "OBJECT_STORAGE"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Boolean - レスポンス結果
  • true | null
    • true: 成功
    • null: 失敗
requestId String - リクエスト ID
  • UUID形式

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "d5a8159b-****-****-****-72e429c57dd6"
}