文档

CancelUploadDocumentJob - 取消上传文档任务

更新时间:

通过JobId取消异步上传文档的任务。

接口说明

此接口为 UploadDocumentAsync 的相关接口。用于取消上传任务。

说明 当任务已经处理成功、失败、已取消时,不能再次调用取消接口。调用取消接口仅中断上传任务,已经写的数据,需要用户自行或者调用 DeleteCollectionData 接口删除,或者再次使用相同 FileName 调用上传覆盖。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DBInstanceIdstring

已经开启向量引擎优化实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-xxxxxxxxx
Namespacestring

命名空间,默认为 public。

说明 您可以通过 CreateNamespace 接口创建,通过 ListNamespaces 接口查看列表。
mynamespace
Collectionstring

文档库名称。

说明 CreateDocumentCollection 接口创建。您可以调用 ListDocumentCollections 接口查看已经创建的文档库。
document
RegionIdstring

实例所在 Region ID。

cn-hangzhou
NamespacePasswordstring

命名空间对应的密码。

说明 本值为 CreateNamespace 接口指定。
testpassword
JobIdstring

上传文档的任务 ID,由UploadDocumentAsync接口获得。

231460f8-75dc-405e-a669-0c5204887e91

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring

返回信息。

success
Statusstring

API 执行状态,取值如下:

  • success:执行成功。
  • fail:执行失败。
success

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

  • 本页导读