文档

CancelDataFlowAutoRefresh - 取消数据流动自动更新配置

更新时间:
一键部署

取消指定数据流动上的自动更新配置。

接口说明

  • 该接口仅适用于中国站 CPFS 文件系统。
  • 仅 CPFS 2.2.0 及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。
  • 仅支持取消Running(正常)Stopped(停止)状态数据流动的自动更新配置。
  • 取消自动更新配置一般耗时 2~5 分钟,您可以通过 DescribeDataFlows 查询取消自动更新任务的状态。

调试

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

授权信息

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

请求参数

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

文件系统 ID。

cpfs-099394bd928c****
DataFlowIdstring

数据流动 ID。

dfid-194433a5be31****
RefreshPathstring

需要取消自动更新配置的目录。

限制:

  • 长度为 2~1024 个字符。
  • 使用 UTF-8 编码。
  • 必须以正斜线(/)开头和结尾。
说明 该目录必须是 CPFS 上的已有目录,且必须位于开启了数据流动的 Fileset 中。
/prefix1/prefix2/
DryRunboolean

是否对此次创建请求执行预检。

预检操作会帮助您检查参数有效性、校验库存等,并不会实际创建实例,也不会产生费用。

取值:

  • true:发送检查请求,不会创建数据流动。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过,则返回对应错误。如果检查通过,则返回 200 HttpCode,但 DataFlowld 为空。
  • false(默认值):发送正常请求,通过检查后直接创建实例。
false
ClientTokenstring

保证请求幂等性,从您的客户端生成一个参数值,确保不同的请求间该参数值唯一。

ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-42665544****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

98696EF0-1607-4E9D-B01D-F20930B6****

示例

正常返回示例

JSON格式

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****"
}

错误码

HTTP status code错误码错误信息描述
400IllegalCharactersThe parameter contains illegal characters.参数非法。
400MissingFileSystemIdFileSystemId is mandatory for this action.未指定FileSystemId参数。
400MissingDataFlowIdDataFlowId is mandatory for this action.未指定DataFlowId参数。
403OperationDenied.DependencyViolationThe operation is denied due to dependancy violation.进行该操作的条件不满足。
403OperationDenied.ConflictOperationThe operation is denied due to a conflict with an ongoing operation.与当前的文件系统操作冲突导致无法创建数据流动。
403OperationDenied.DataFlowNotSupportedThe operation is not supported.该文件系统不支持数据流动。
404InvalidFileSystem.NotFoundThe specified file system does not exist.指定的文件系统不存在。
404InvalidDataFlow.NotFoundThe specified data flow does not exist.指定的数据流动不存在。
404InvalidRefreshPath.InvalidParameterRefresh path is invalid.指定的自动更新目录的路径非法。
404InvalidRefreshPath.NotFoundRefresh path does not exist.指定的自动更新目录不存在。

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

变更历史

变更时间变更内容概要操作
2024-09-05OpenAPI 错误码发生变更查看变更详情