CancelUploadDocumentJob を使用した非同期ドキュメントアップロードジョブのキャンセル - AnalyticDB

操作説明

この操作は UploadDocumentAsync 操作に関連しています。ドキュメントアップロードタスクをキャンセルする場合に、本操作を呼び出してください。

説明

キャンセル操作が完了済み、失敗した、または既にキャンセル済みの場合は、再度本操作を呼び出すことはできません。キャンセル操作は、ドキュメントアップロードタスクの実行を中断するのみであり、アップロード済みのデータを削除するものではありません。アップロード済みデータを削除するには、手動で削除するか、DeleteCollectionData 操作を呼び出してください。また、同じ FileName パラメーターを指定してドキュメントアップロード操作を再実行することで、既存データを上書きすることも可能です。

今すぐお試しください

この 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:CancelUploadDocumentJob

update

*Document

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	ベクトルエンジン最適化が有効化されているインスタンスの ID です。説明すべての AnalyticDB for PostgreSQL インスタンス（インスタンス ID を含む）の情報をリージョン単位で照会するには、DescribeDBInstances 操作を呼び出してください。	gp-xxxxxxxxx
Namespace	string	任意	名前空間の名称です。デフォルト値：public。説明名前空間を作成するには CreateNamespace 操作を呼び出し、名前空間の一覧を照会するには ListNamespaces 操作を呼び出してください。	mynamespace
Collection	string	必須	ドキュメントコレクションの名称です。説明ドキュメントコレクションを作成するには CreateDocumentCollection 操作を呼び出し、ドキュメントコレクションの一覧を照会するには ListDocumentCollections 操作を呼び出してください。	document
RegionId	string	必須	インスタンスのリージョン ID です。	cn-hangzhou
NamespacePassword	string	必須	名前空間のパスワードです。説明このパラメーターの値は、CreateNamespace 操作呼び出し時に指定します。	testpassword
JobId	string	必須	ドキュメントアップロードタスクの ID です。`UploadDocumentAsync` 操作を呼び出して、ジョブ ID を照会できます。	231460f8-75dc-405e-a669-0c5204887e91

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	応答メッセージです。	success
Status	string	操作のステータスです。有効な値は以下のとおりです。 success fail	success

例

成功レスポンス

JSONJSON

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success"
}

エラーコード

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

変更履歴

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