AI 助理
备案控制台
文档
输入文档关键字查找
首页 文件存储 CPFS 文件存储CPFS通用版 开发参考 API参考 API目录 数据流动 StopDataFlow - 停用数据流动

StopDataFlow - 停用数据流动

更新时间：
我的收藏

停用一个数据流动。

接口说明

  • 该接口仅适用于中国站 CPFS 文件系统。
  • 仅 CPFS 2.2.0 及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。
  • 只能停用Running（正常）状态的数据流动。
  • 停用后，不可在数据流动上创建数据流动任务。如果配置了自动更新，源端发生的数据更新也不会同步到 CPFS 上。
  • 停用后，由于资源被回收，数据流动带宽将不再计费，但重新启动数据流动可能因为库存不足导致启动失败。
  • 停用数据流动一般耗时 2～5 分钟，您可通过 DescribeDataFlows 查询数据流动状态。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
nas:StopDataFlowupdate
  • 全部资源
    *
    无
无

请求参数

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

文件系统 ID。

cpfs-099394bd928c****
DataFlowIdstring是

数据流动 ID。

df-194433a5be31****
DryRunboolean否

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

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

取值：

  • true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和 NAS 库存。如果检查不通过，则返回对应错误。如果检查通过，则返回 200 HttpCode，但 FileSystemId 为空。
  • 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.InvalidStateThe operation is not permitted when the status is processing.状态处理中不允许此操作。
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.指定的数据流动不存在。

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

变更历史

变更时间变更内容概要操作
2024-09-05OpenAPI 错误码发生变更查看变更详情
上一篇：DescribeDataFlows - 查询数据流动列表下一篇：StartDataFlow - 启用数据流动
文档推荐