ModifyDataFlow - 修改数据流动

更新时间: 2024-12-19 18:09:30

修改数据流动的属性。

接口说明

  • CPFS 2.2.0 及以上版本、CPFS 智算版 2.4.0 及以上版本支持数据流动。

  • 仅支持状态为Running(正常)状态的数据流动修改属性。

  • 修改数据流动一般耗时 2~5 分钟,您可以通过 DescribeDataFlows 查询修改数据流动的状态。

  • CPFS 数据流动规格:

    • 数据流动带宽(Throughput)支持 600 MB/s、1200 MB/s 和 1500 MB/s 三种规格。数据流动带宽是指该数据流动进行导入或导出数据时能达到的最大传输带宽。
    • 库存查询:当设置 DryRun 为 true 时,可校验修改该规格的数据流动的资源是否满足。
  • CPFS 计费

    修改数据流动带宽(Throughput)涉及数据流动带宽计费,建议您提前了解 CPFS 的计费方式。更多详情,请参见 CPFS 计费说明

调试

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

授权信息

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

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

请求参数

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

文件系统 ID。

  • CPFS:必须以cpfs-开头,例如 cpfs-125487****。

  • CPFS 智算版:必须以bmcpfs-开头,例如 bmcpfs-0015****。

说明 国际站不支持 CPFS。
cpfs-099394bd928c****
DataFlowIdstring

数据流动 ID。

df-194433a5be31****
Descriptionstring

数据流动的描述。

限制:

  • 长度为 2~128 个英文或中文字符。
  • 必须以大小写字母或中文开头,不能以 http://和 https://开头。
  • 可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。
Bucket01数据流动
Throughputlong

数据流动的传输带宽上限,单位:MB/s 。 取值:

  • 600
  • 1200
  • 1500
说明 数据流动的传输带宽必须小于文件系统的 IO 带宽。当文件系统类型为 CPFS 时,该参数必填。
600
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.DependencyViolationThe operation is denied due to dependancy violation.进行该操作的条件不满足。
403OperationDenied.NoStockThe operation is denied due to no stock.文件系统无库存。
403OperationDenied.ConflictOperationThe operation is denied due to a conflict with an ongoing operation.与当前的文件系统操作冲突导致无法创建数据流动。
403OperationDenied.InvalidStateThe operation is not permitted when the status is processing.状态处理中不允许此操作。
403OperationDenied.DataFlowNotSupportedThe operation is not supported.该文件系统不支持数据流动。
404InvalidFileSystem.NotFoundThe specified file system does not exist.指定的文件系统不存在。
404InvalidDataFlow.NotFoundThe specified data flow does not exist.指定的数据流动不存在。
404InvalidThroughput.OutOfBoundsThroughput is out of bounds.指定的Throughput不在合法范围中。
404InvalidDescription.InvalidFormatDescription format is invalid.指定的描述格式非法。

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

变更历史

变更时间变更内容概要操作
2024-06-03OpenAPI 错误码发生变更查看变更详情
上一篇: DeleteDataFlow - 删除数据流动 下一篇: DescribeDataFlows - 查询数据流动列表