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

Create Import Jobs (V2)

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

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

https://api.cloud.zilliz.com

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

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

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

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

注
これは、Zilliz Cloud 上のサービングクラスターにのみ適用されます。
値の例： inxx-xxxxxxxxxxxxxxxx
dbNamestring

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

collectionNamestring必要

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

partitionNamestring

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

volumeNamestring

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

dataPathsarray

アップロードするデータファイルのパスです。パスは、指定したボリュームのルートを基準とした相対パスである必要があります。

[]dataPathsarray

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

projectIdstring

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

注
これは、Zilliz Cloud 上のオンデマンドコンピュートクラスターとデータベースにのみ適用されます。
値の例： proj-xxxxxxxxxxxxxxxx
regionIdstring

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

注
これは、Zilliz Cloud 上のオンデマンドコンピュートクラスターとデータベースにのみ適用されます。
値の例： aws-us-west-2
dbNamestring

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

collectionNamestring必要

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

partitionNamestring

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

volumeNamestring

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

dataPathsarray

アップロードするデータファイルのパスです。パスは、指定したボリュームのルートを基準とした相対パスである必要があります。

[]dataPathsarray

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

clusterIdstring

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

注
これは、Zilliz Cloud 上のサービングクラスターにのみ適用されます。
値の例： inxx-xxxxxxxxxxxxxxxx
dbNamestring

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

collectionNamestring必要

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

partitionNamestring

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

objectUrlstring

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

objectUrlsarray

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

[]objectUrlsarray

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

accessKeystring

オブジェクトストレージサービスのアクセスキーです。

secretKeystring

オブジェクトストレージサービスのシークレットアクセスキーです。

tokenstring

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

projectIdstring

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

注
これは、Zilliz Cloud 上のオンデマンドコンピュートクラスターとデータベースにのみ適用されます。
値の例： proj-xxxxxxxxxxxxxxxx
regionIdstring

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

注
これは、Zilliz Cloud 上のオンデマンドコンピュートクラスターとデータベースにのみ適用されます。
値の例： aws-us-west-2
dbNamestring

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

collectionNamestring必要

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

partitionNamestring

ターゲットパーティションの名前。 存在しないパーティションを指定するとエラーになります。

objectUrlstring

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

objectUrlsarray

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

[]objectUrlsarray

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

accessKeystring

オブジェクトストレージサービスのアクセスキー。

secretKeystring

オブジェクトストレージサービスのシークレットアクセスキー。

tokenstring

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

レスポンス200 OK - application/json

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

codeinteger

レスポンスコード。

値の例： 0
dataarray

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

[]dataobject

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

jobIdstring

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

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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