メインコンテンツまでスキップ

インポートジョブを作成 (V2)

この操作では、準備済みのデータファイルを Zilliz Cloud cluster にインポートします。データファイルの準備方法については、Prepare Data Import を参照してください。

POST/v2/vectordb/jobs/import/create
接続エンドポイント

https://api.cloud.zilliz.com

shell
export BASE_URL="https://api.cloud.zilliz.com"
パラメータ
Authorizationstringheader必要

認証トークンには、適切な権限を持つ API key を使用する必要があります。

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
clusterIdstring

コレクションが属する serving cluster の ID です。 存在しない cluster を指定するとエラーになります。cluster ID は /v2/clusters エンドポイントを呼び出して取得するか、Zilliz Cloud console からコピーできます。

注
これは Zilliz Cloud 上の serving cluster にのみ適用されます。
値の例： inxx-xxxxxxxxxxxxxxxx
dbNamestring

コレクションが属するデータベースの名前です。 存在しないデータベースを指定するとエラーになります。

collectionNamestring必要

対象のコレクション名です。 存在しないコレクションを指定するとエラーになります。

partitionNamestring

対象のパーティション名です。 存在しないパーティションを指定するとエラーになります。

volumeNamestring

データファイルのアップロード元となる volume の名前です。volume は事前に作成されている必要があります。詳細は Create Volume を参照してください

dataPathsarray

アップロードするデータファイルのパスです。パスは指定した volume のルートからの相対パスである必要があります。

[]dataPathsarray

アップロードするデータファイルのパスのリストです。各リストには 1 つのパスのみを含めます。

projectIdstring

データベースおよびコレクションが属する project の ID です。 存在しない project を指定するとエラーになります。project ID は /v2/projects エンドポイントを呼び出して取得するか、Zilliz Cloud console からコピーできます。

注
これは Zilliz Cloud 上の on-demand compute cluster およびデータベースにのみ適用されます。
値の例： proj-xxxxxxxxxxxxxxxx
regionIdstring

データベースおよびコレクションが属する region の ID です。 存在しない region を指定するとエラーになります。region ID は /v2/regions エンドポイントを呼び出して取得するか、Zilliz Cloud console からコピーできます。

注
これは Zilliz Cloud 上の on-demand compute cluster およびデータベースにのみ適用されます。
値の例： aws-us-west-2
dbNamestring

コレクションが属するデータベースの名前です。 存在しないデータベースを指定するとエラーになります。

collectionNamestring必要

対象のコレクション名です。 存在しないコレクションを指定するとエラーになります。

partitionNamestring

対象のパーティション名です。 存在しないパーティションを指定するとエラーになります。

volumeNamestring

データファイルのアップロード元となる volume の名前です。volume は事前に作成されている必要があります。詳細は Create Volume を参照してください

dataPathsarray

アップロードするデータファイルのパスです。パスは指定した volume のルートからの相対パスである必要があります。

[]dataPathsarray

アップロードするデータファイルのパスのリストです。各リストには 1 つのパスのみを含めます。

clusterIdstring

コレクションが属する serving cluster の ID です。 存在しない cluster を指定するとエラーになります。cluster ID は /v2/clusters エンドポイントを呼び出して取得するか、Zilliz Cloud console からコピーできます。

注
これは Zilliz Cloud 上の serving cluster にのみ適用されます。
値の例： inxx-xxxxxxxxxxxxxxxx
dbNamestring

コレクションが属するデータベースの名前です。 存在しないデータベースを指定するとエラーになります。

collectionNamestring必要

対象のコレクション名です。 存在しないコレクションを指定するとエラーになります。

partitionNamestring

対象のパーティション名です。 存在しないパーティションを指定するとエラーになります。

objectUrlstring

インポートするオブジェクトの URL です。この URL は、AWS S3、GCS、Azure blob storage などの S3 互換オブジェクトストレージサービスからアクセス可能である必要があります。

objectUrlsarray

インポートするオブジェクトの URL です。
適用可能な形式と、1 つのジョブで複数オブジェクトをインポートする方法は次のとおりです。

[]objectUrlsarray

インポートする Entity のバッチを含むデータファイルの URL のリストです。
各リストには 1 つの URL のみを含めます。

accessKeystring

オブジェクトストレージサービスの access key です。

secretKeystring

オブジェクトストレージサービスの secret access key です。

tokenstring

オブジェクトストレージサービスにアクセスするための一時トークンです。トークン名と取得方法は cloud provider によって異なる場合があります。詳細は the FAQ を参照してください。

projectIdstring

データベースおよびコレクションが属する project の ID です。 存在しない project を指定するとエラーになります。project ID は /v2/projects エンドポイントを呼び出して取得するか、Zilliz Cloud console からコピーできます。

注
これは Zilliz Cloud 上の on-demand compute cluster およびデータベースにのみ適用されます。
値の例： proj-xxxxxxxxxxxxxxxx
regionIdstring

データベースおよびコレクションが属する region の ID です。 存在しない region を指定するとエラーになります。region ID は /v2/regions エンドポイントを呼び出して取得するか、Zilliz Cloud console からコピーできます。

注
これは Zilliz Cloud 上の on-demand compute cluster およびデータベースにのみ適用されます。
値の例： aws-us-west-2
dbNamestring

コレクションが属するデータベースの名前です。 存在しないデータベースを指定するとエラーになります。

collectionNamestring必要

対象のコレクション名です。 存在しないコレクションを指定するとエラーになります。

partitionNamestring

対象パーティションの名前です。 存在しないパーティションを指定するとエラーになります。

objectUrlstring

インポートするオブジェクトの URL です。この URL は、AWS S3、GCS、Azure blob storage などの S3 互換オブジェクトストレージサービスからアクセス可能である必要があります。

objectUrlsarray

インポートするオブジェクトの URL です。
適用可能な形式と、1 つのジョブで複数のオブジェクトをインポートする方法は次のとおりです。

[]objectUrlsarray

インポートするエンティティのバッチを含むデータファイルへの URL のリストです。
各リストには 1 つの URL のみを含めます。

accessKeystring

オブジェクトストレージサービスの access key です。

secretKeystring

オブジェクトストレージサービスの secret access key です。

tokenstring

オブジェクトストレージサービスにアクセスするための一時トークンです。トークン名と取得方法はクラウドプロバイダーによって異なる場合があります。詳細は、the FAQ を参照してください。

レスポンス200 OK - application/json

一括インポートジョブの ID です。

codeinteger

レスポンスコードです。

値の例： 0
dataarray

作成された一括インポートジョブの ID を含むレスポンスペイロードです。

[]dataobject

作成された一括インポートジョブです。

jobIdstring

現在の一括インポートジョブの ID です。

エラーメッセージを返します。

codeinteger

レスポンスコードです。

messagestring

エラーメッセージです。

Successjson
{
    "code": 0,
    "data": {
        "jobId": "job-xxxxxxxxxxxxxxxxxxxxx"
    }
}
Ctrl I