通过JobId取消异步上传文档的任务。
接口说明
此接口为 UploadDocumentAsync 的相关接口。用于取消上传任务。
说明
当任务已经处理成功、失败、已取消时，不能再次调用取消接口。调用取消接口仅中断上传任务，已经写的数据，需要用户自行或者调用 DeleteCollectionData 接口删除，或者再次使用相同 FileName 调用上传覆盖。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| gpdb:CancelUploadDocumentJob | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 已经开启向量引擎优化实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。
| gp-xxxxxxxxx |
| Namespace | string | 否 | 命名空间，默认为 public。 说明
您可以通过 CreateNamespace 接口创建，通过 ListNamespaces 接口查看列表。
| mynamespace |
| Collection | string | 是 | 文档库名称。 说明
由 CreateDocumentCollection 接口创建。您可以调用 ListDocumentCollections 接口查看已经创建的文档库。
| document |
| RegionId | string | 是 | 实例所在 Region ID。 | cn-hangzhou |
| NamespacePassword | string | 是 | 命名空间对应的密码。 说明
本值为 CreateNamespace 接口指定。
| testpassword |
| JobId | string | 是 | 上传文档的任务 ID，由 | 231460f8-75dc-405e-a669-0c5204887e91 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "success",
"Status": "success"
}错误码
访问错误中心查看更多错误码。