取消一个Pending(等待)或Executing(运行中)状态的数据流动批式任务或流式任务。
接口说明
- 仅 CPFS 2.2.0 及以上版本、CPFS 智算版 2.4.0 及以上版本支持数据流动任务。您可以在控制台文件系统详情页面查看版本信息。
- 仅支持取消
Pending(等待)
和Executing(运行中)
状态的数据流动任务。 - 取消数据流动任务一般耗时 5~10 分钟,您可通过 DescribeDataFlowTasks 查询任务执行状态。
- 如果数据流动流式任务中有正在运行的流式子任务,则不支持取消流式任务。否则会返回 InvalidStatus.ResourceMismatch 报错信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
nas:CancelDataFlowTask | delete | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
FileSystemId | string | 是 | 文件系统 ID。
说明
国际站不支持 CPFS。
| cpfs-099394bd928c**** |
DataFlowId | string | 是 | 数据流动 ID。 | df-194433a5be31**** |
TaskId | string | 是 | 数据流动任务 ID。 | task-38aa8e890f45**** |
DryRun | boolean | 否 | 是否对此次创建请求执行预检。 预检操作会帮助您检查参数有效性、校验库存等,并不会实际创建实例,也不会产生费用。 取值:
| false |
ClientToken | string | 否 | 保证请求幂等性,从您的客户端生成一个参数值,确保不同的请求间该参数值唯一。 ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 说明
若用户未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
| 123e4567-e89b-12d3-a456-42665544**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalCharacters | The parameter contains illegal characters. | 参数非法。 |
400 | MissingFileSystemId | FileSystemId is mandatory for this action. | 未指定FileSystemId参数。 |
400 | MissingDataFlowId | DataFlowId is mandatory for this action. | 未指定DataFlowId参数。 |
400 | MissingTaskId | TaskId is mandatory for this action. | 未指定TaskId参数。 |
403 | OperationDenied.ConflictOperation | The operation is denied due to a conflict with an ongoing operation. | 与当前的文件系统操作冲突导致无法创建数据流动。 |
403 | OperationDenied.DependencyViolation | The operation is denied due to dependancy violation. | 进行该操作的条件不满足。 |
403 | OperationDenied.DataFlowNotSupported | The operation is not supported. | 该文件系统不支持数据流动。 |
404 | InvalidFileSystem.NotFound | The specified file system does not exist. | 指定的文件系统不存在。 |
404 | InvalidDataFlow.NotFound | The specified data flow does not exist. | 指定的数据流动不存在。 |
404 | InvalidTaskId.NotFound | The specified task ID does not exist. | 指定的数据流动TaskId不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-05 | OpenAPI 错误码发生变更 | 查看变更详情 |