调用StopDataFlow停用一个数据流动。
接口说明
- 该接口仅适用于中国站。
- 仅CPFS 2.2.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。
- 只能停用
Running(正常)
状态的数据流动。 - 停用后,不可在数据流动上创建数据流动任务。如果配置了自动更新,源端发生的数据更新也不会同步到CPFS上。
- 停用后,由于资源被回收,数据流动带宽将不再计费,但重新启动数据流动可能因为库存不足导致启动失败。
- 停用数据流动一般耗时2~5分钟,您可通过DescribeDataFlows查询数据流动状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | StopDataFlow | 接口名称。固定取值:StopDataFlow。 |
FileSystemId | String | 是 | cpfs-099394bd928c**** | 文件系统ID。 |
DataFlowId | String | 是 | dfid-194433a5be31**** | 数据流动ID。 |
DryRun | Boolean | 否 | false | 是否对此次创建请求执行预检。 预检操作会帮助您检查参数有效性、校验库存等,并不会实际创建实例,也不会产生费用。 取值:
|
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-42665544**** | 保证请求幂等性,从您的客户端生成一个参数值,确保不同请求间该参数值唯一。 ClientToken只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性。 说明 若用户未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 98696EF0-1607-4E9D-B01D-F20930B6**** | 请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=StopDataFlow
&FileSystemId=cpfs-099394bd928c****
&DataFlowId=dfid-194433a5be31****
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<StopDataFlowResponse>
<RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>
</StopDataFlowResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "98696EF0-1607-4E9D-B01D-F20930B6****"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 | OperationDenied.DependencyViolation | The operation is denied due to dependancy violation. | 进行该操作的条件不满足。 |
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. | 指定的数据流动不存在。 |
访问错误中心查看更多错误码。