查询一个CPFS文件系统的数据流动信息。
接口说明
- 仅 CPFS 2.2.0 及以上版本、CPFS 智算版 2.4.0 及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。
- 筛选键(Filters)中,FsetIds、DataFlowlds、SourceStorage、ThroughputList、Status 需要做全字匹配,FileSystemPath、Description、SourceStoragePath 支持模糊匹配。
- 支持组合查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
nas:DescribeDataFlows | list | *DataFlow acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
FileSystemId | string | 是 | 文件系统 ID。
说明
国际站不支持 CPFS。
| cpfs-099394bd928c**** |
Filters | array<object> | 否 | 查询数据流动的筛选键。 | |
object | 否 | |||
Key | string | 否 | 筛选键的名称。取值:
| FsetIds |
Value | string | 否 | 筛选键的值。该参数不支持通配符。
| FsetIds |
NextToken | string | 否 | 当请求的返回结果被截断时,您可以使用 NextToken 再次发起请求,获取从当前截断位置之后的内容。 | TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0= |
MaxResults | long | 否 | 每次查询结果的个数。 取值范围:10~100。默认值:20。 | 20 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
"NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
"DataFlowInfo": {
"DataFlow": [
{
"FileSystemId": "cpfs-099394bd928c****",
"DataFlowId": "df-194433a5be31****",
"FsetId": "fset-1902718ea0ae****",
"Status": "Running",
"ErrorMessage": "SourceStorageUnreachable",
"SourceStorage": "oss://178321033379****:bucket-01",
"SourceSecurityType": "SSL",
"Throughput": 600,
"Description": "Bucket01数据流动",
"CreateTime": "2021-09-30T10:08:08Z",
"UpdateTime": "2021-09-30T10:08:08Z",
"AutoRefresh": {
"AutoRefresh": [
{
"RefreshPath": "/prefix1/prefix2/"
}
]
},
"FileSystemPath": "/a/b/c/",
"FsetDescription": "自动更新01",
"AutoRefreshInterval": 10,
"AutoRefreshPolicy": "None",
"SourceStoragePath": "/prefix/\n"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalCharacters | The parameter contains illegal characters. | 参数非法。 |
400 | MissingFileSystemId | FileSystemId is mandatory for this action. | 未指定FileSystemId参数。 |
400 | InvalidFilesystemVersion.NotSupport | This Api does not support this fileSystem version. | 当前接口不支持该版本文件系统。 |
403 | OperationDenied.DataFlowNotSupported | The operation is not supported. | 该文件系统不支持数据流动。 |
404 | InvalidFilterValue | The specified parameter Filter.1.Value is invalid. | Filter.1.Value值非法。 |
404 | InvalidFileSystem.NotFound | The specified file system does not exist. | 指定的文件系统不存在。 |
404 | InvalidFilterParam | The specified Filter.N.Key is invalid. | 指定的Filter.N.Key参数非法。 |
404 | InvalidParameter.InvalidMaxResults | The specified MaxResults is invalid. | 指定的MaxResults非法。 |
404 | InvalidParameter.InvalidNextToken | The specified NextToken is invalid. | 指定的NextToken非法。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-14 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-09-05 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-02-29 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |