Use CancelUploadDocumentJob to cancel an asynchronous document upload job - AnalyticDB - Alibaba Cloud - AnalyticDB

Operation description

This is a companion operation to UploadDocumentAsync for canceling document upload jobs.

Note

You cannot cancel a job that has already succeeded, failed, or been canceled. Canceling only interrupts the upload job. To remove already-uploaded data, delete it manually, call the DeleteCollectionData operation, or call the upload operation again with the same FileName to overwrite it.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gpdb:CancelUploadDocumentJob

update

*Document

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance for which vector engine optimization is enabled. Note Call the DescribeDBInstances operation to query all AnalyticDB for PostgreSQL instances in a region, including instance IDs.	gp-xxxxxxxxx
Namespace	string	No	The name of the namespace. Default value: public. Note Call the CreateNamespace operation to create a namespace or the ListNamespaces operation to list existing namespaces.	mynamespace
Collection	string	Yes	The name of the document collection. Note Call the CreateDocumentCollection operation to create a document collection or the ListDocumentCollections operation to list existing document collections.	document
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
NamespacePassword	string	Yes	The password of the namespace. Note You specify this value when you call the CreateNamespace operation.	testpassword
JobId	string	Yes	The ID of the document upload job. Call the `UploadDocumentAsync` operation to obtain the job ID.	231460f8-75dc-405e-a669-0c5204887e91

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	The returned message.	success
Status	string	The status of the operation. Valid values: success fail	success

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.