GetUpsertCollectionDataJob を使用したベクトルデータアップロードジョブの進捗確認 - AnalyticDB

ジョブ ID を使用して、非同期ベクトルデータアップロードジョブの進捗と結果を照会します。

操作説明

この操作は UpsertCollectionDataAsync 操作に関連しています。UpsertCollectionDataAsync 操作を呼び出してアップロードジョブを作成し、ジョブ ID を取得した後、GetUpsertCollectionDataJob 操作を呼び出してジョブの実行情報を照会できます。

説明

1 秒あたり 1,000 件のデータに基づいてアップロードジョブに必要な時間を見積もり、5 秒ごとにジョブの進捗を照会することを推奨します。タイムアウト期間は、見積もられた時間の 30 分後に設定できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gpdb:GetUpsertCollectionDataJob

create

*Collection

acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	任意	インスタンス ID。説明 DescribeDBInstances 操作を呼び出して、インスタンス ID を含む、リージョン内のすべての AnalyticDB for PostgreSQL インスタンスに関する情報を照会できます。	gp-xxxxxxxxx
RegionId	string	必須	インスタンスのリージョン ID。	cn-hangzhou
Collection	string	必須	コレクションの名前。説明 ListCollections 操作を呼び出して、コレクションのリストを照会できます。	document
Namespace	string	任意	名前空間の名前。デフォルト値：public。説明 CreateNamespace 操作を呼び出して名前空間を作成し、ListNamespaces 操作を呼び出して名前空間のリストを照会できます。	mynamespace
NamespacePassword	string	必須	名前空間のパスワード。説明このパラメーターの値は、CreateNamespace 操作を呼び出すときに指定します。	testpassword
JobId	string	必須	ベクトルデータアップロードジョブの ID。`UpsertCollectionDataAsync` 操作を呼び出してジョブ ID を照会できます。	231460f8-75dc-405e-a669-0c5204887e91
WorkspaceId	string	任意	複数の AnalyticDB for PostgreSQL インスタンスで構成されるワークスペースの ID。WorkspaceId と DBInstanceId のいずれかのパラメーターを指定する必要があります。両方のパラメーターを指定した場合、WorkspaceId パラメーターが有効になります。	gp-ws-*****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Status	string	操作のステータス。有効な値： success fail	success
Message	string	返されたメッセージ。	success
Job	object	ベクトルデータアップロードジョブに関する情報。
Id	string	ジョブ ID。	231460f8-75dc-405e-a669-0c5204887e91
Completed	boolean	操作が完了したかどうかを示します。	false
CreateTime	string	ジョブが作成された時刻。	2024-01-08 16:52:04.864664
UpdateTime	string	ジョブが更新された時刻。	2024-01-08 16:53:04.864664
Status	string	ジョブのステータス。説明有効な値： Success Failed (失敗理由については Error パラメーターをご参照ください。) Cancelling Cancelled Start Running	Success
Error	string	エラーメッセージ。	Failed to connect database.
Progress	integer	ベクトルデータアップロードジョブの進捗。このパラメーターの値は、アップロードされたデータ件数を示します。	1600

例

成功レスポンス

JSONJSON

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": "success",
  "Message": "success",
  "Job": {
    "Id": "231460f8-75dc-405e-a669-0c5204887e91",
    "Completed": false,
    "CreateTime": "2024-01-08 16:52:04.864664",
    "UpdateTime": "2024-01-08 16:53:04.864664",
    "Status": "Success",
    "Error": "Failed to connect database.",
    "Progress": 1600
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。