Run data import

Prev Next

Available in VPC

Import data stored in an Object Storage bucket to the cluster.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v2/import/createDataImportJob/{serviceGroupInstanceNo} (Korea Region)
POST /api/sgn-v2/import/createDataImportJob/{serviceGroupInstanceNo} (Singapore Region)
POST /api/jpn-v2/import/createDataImportJob/{serviceGroupInstanceNo} (Japan Region)

Request headers

For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
serviceGroupInstanceNo Integer Required Cluster instance number

Request body

You can include the following data in the body of your request:

Field Type Required Description
bucketName String Required Bucket name
index String Required Index name
  • Enter 3 to 30 characters using a combination of lowercase English letters, numbers, and the special character "-".
  • The string must start with a lowercase English letter and end with a lowercase English letter or a number.
  • Special character "-" can't be used consecutively.
isBulkFormat Boolean Optional Bulk format status
objectKey String Required Import file path
  • Enter in the form of {Bucket internal folder}/{File name}.
  • Only JSON files are allowed.
dataSource String Required Data source storage
  • OBJECT_STORAGE: Object Storage (valid value)

Request example

The request example is as follows:

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"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
code Integer - Response code
message String - Response message
result Boolean - Response result
  • true | null
    • true: succeeded
    • null: failed
requestId String - ID for the request
  • UUID format

Response status codes

For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.

Response example

The response example is as follows:

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