Use CancelUpsertCollectionDataJob to cancel an asynchronous vector data upload job - AnalyticDB - Alibaba Cloud - AnalyticDB

Operation description

This operation is related to the UpsertCollectionDataAsync operation. You can call this operation to cancel an upload job.

Note

If the canceling operation is complete, failed, or is canceled, you cannot call the operation again. The canceling operation only interrupts the upload job. To remove the uploaded data, you must manually remove it or call the DeleteCollectionData operation.

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:CancelUpsertCollectionDataJob

create

*Document

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	No	The instance ID. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-xxxxxxxxx
Namespace	string	No	The name of the namespace. Default value: public. Note You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.	mynamespace
Collection	string	Yes	The name of the collection. Note You can call the ListCollections operation to query a list of collections.	document
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
NamespacePassword	string	Yes	The password of the namespace. Note The value of this parameter is specified when you call the CreateNamespace operation.	testpassword
JobId	string	Yes	The ID of the vector data upload job. You can call the `UpsertCollectionDataAsync` operation to query the job ID.	bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1
WorkspaceId	string	No	The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.	gp-ws-*****

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.