为指定数据流动配置自动更新。
接口说明
-
该接口仅适用于中国站 CPFS 文件系统。
-
仅 CPFS 2.2.0 及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。
-
仅支持状态为
Running（正常）状态的数据流动添加自动更新配置。 -
一个数据流动最多可以添加 5 个自动更新配置。
-
创建自动更新配置一般耗时 2～5 分钟，您可以通过 DescribeDataFlows 查询数据流动状态。
-
自动更新依赖 EventBridge 收集源端 OSS 存储的对象修改事件。需要先开通 EventBridge 服务。
说明 CPFS 在 EventBridge 创建的事件总线、事件规则带有Create for cpfs auto refresh的描述，事件总线、事件规则都不能修改和删除，否则自动更新无法正常工作。 -
自动更新的作用对象是 prefix，由参数 RefreshPath 指定。在 CPFS 数据流动对 prefix 配置自动更新时，会在用户侧创建事件总线，并创建源端 OSS Bucket 的 prefix 的事件规则。当源端 OSS Bucket 的 prefix 内发生对象修改后，会在 EventBridge 中产生 OSS 事件，由 CPFS 数据流动处理。
-
配置自动更新（AutoRefresh）后，当源端存储数据发生变化时，变化的元数据会自动同步到 CPFS 文件系统，变化的数据会在用户访问文件时按需加载，或者启动数据流动任务加载数据。
-
自动更新间隔（AutoRefreshInterval）指 CPFS 每隔该时间间隔，检查源端 OSS Bucket 该 prefix 内是否存在数据更新，如果有数据更新则启动自动更新任务。当 OSS 源端的对象修改事件频率超过 CPFS 数据流动处理能力时，自动更新任务会堆积，元数据更新会延迟，数据流动的状态为 Misconfigured，您可以提升数据流动规格，或者降低 OSS 修改频率来解决。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| nas:ApplyDataFlowAutoRefresh | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FileSystemId | string | 是 | 文件系统 ID。 | cpfs-099394bd928c**** |
| DataFlowId | string | 是 | 数据流动 ID。 | df-194433a5be31**** |
| AutoRefreshs | array<object> | 是 | 自动更新配置信息集合。 | |
| object | 是 | |||
| RefreshPath | string | 是 | 自动更新目录，CPFS 仅自动检查该目录下的源端数据是否发生更新并自动导入更新的数据。 限制：
说明
该目录必须是 CPFS 上的已有目录，且必须位于开启了数据流动的 Fileset 中。
| /prefix1/prefix2/ |
| AutoRefreshPolicy | string | 否 | 自动更新策略，源端数据更新以后，数据更新导入到 CPFS 的策略。包括：
| None |
| AutoRefreshInterval | long | 否 | 自动更新的间隔时间。每隔该时间间隔，CPFS 会检查目录内是否存在数据更新，如果有数据更新，启动自动更新任务。单位为分钟。 取值范围：10~525600。默认值：10。 | 10 |
| DryRun | boolean | 否 | 是否对此次创建请求执行预检。 预检操作会帮助您检查参数有效性、校验库存等，并不会实际创建实例，也不会产生费用。 取值：
| false |
| ClientToken | string | 否 | 保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。 ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。 说明
若用户未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
| 123e4567-e89b-12d3-a456-42665544**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****"
}错误码
| 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参数。 |
| 403 | OperationDenied.InvalidState | The operation is not permitted when the status is processing. | 状态处理中不允许此操作。 |
| 403 | InvalidFileSystem.AlreadyExisted | The specified file system already exists. | 指定的文件系统已存在。 |
| 403 | OperationDenied.DependencyViolation | The operation is denied due to dependancy violation. | 进行该操作的条件不满足。 |
| 403 | OperationDenied.NestedDir | The operation is denied due to nested directory. | 目录存在嵌套导致无法创建自动更新配置。 |
| 403 | OperationDenied.ConflictOperation | The operation is denied due to a conflict with an ongoing operation. | 与当前的文件系统操作冲突导致无法创建数据流动。 |
| 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 | InvalidRefreshPath.InvalidParameter | Refresh path is invalid. | 指定的自动更新目录的路径非法。 |
| 404 | InvalidRefreshPath.NotFound | Refresh path does not exist. | 指定的自动更新目录不存在。 |
| 404 | InvalidRefreshPolicy.InvalidParameter | Refresh policy is invalid. | 自动更新策略非法。 |
| 404 | InvalidRefreshInterval.OutOfBounds | Refresh interval is out of bounds. | 指定的RefreshInterval不在合法范围中。 |
| 404 | InvalidRefreshPath.AlreadyExist | The refresh path already exists. | 指定的自动更新目录已存在。 |
| 404 | InvalidRefreshPath.TooManyPaths | The number of refresh paths exceeds the limit. | 查询的自动更新目录数量超过限制。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-05 | OpenAPI 错误码发生变更 | 查看变更详情 |