接口功能介绍
查询资源池 ID 下，所有的数据流动策略详情
接口约束
无
URI
GET /v4/hpfs/list-dataflow
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 否 | String | 多可用区下的可用区名字，不传为查询全部 | az2 | |
| sfsUID | 否 | String | 数据流动策略所属并行文件UID | a2d4b927-9511-5a9b-b1de-cfe55779c1ea | |
| pageSize | 否 | Integer | 每页包含的元素个数范围(1-50)，默认值为10 | 10 | |
| pageNo | 否 | Integer | 列表的分页页码，默认值为1 | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800 为成功，900 为失败) | 800 | |
| message | String | 响应描述 | SUCCESS | |
| description | String | 响应描述 | 成功 | |
| returnObj | Object | 返回对象 | 参考returnObj | |
| errorCode | String | 业务细分码，为 product.module.code 三段式码 | sfs.parameter.sfsUID | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Sfs.Parameter.SfsUID |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| dataflowList | Array of Objects | 返回的数据流动策略列表 | 参考dataflowList | |
| totalCount | Integer | 资源池下用户数据流动策略总数 | 1 | |
| currentCount | Integer | 当前页码下查询回来的用户数据流动策略数 | 10 | |
| pageSize | Integer | 每页包含的元素个数范围(1-50) | 10 | |
| pageNo | Integer | 列表的分页页码 | 1 |
表 dataflowList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源池id | b73e3ad4-417f-11ed-bad1-525400cc3b79 | |
| dataflowID | String | 数据流动策略id | dataflow-j9Knd12B | |
| sfsUID | String | 并行文件唯一id | a2d4b927-9511-5a9b-b1de-cfe55779c1ea | |
| sfsDirectory | String | 并行文件下目录 | /test01 | |
| bucketName | String | 对象存储的桶名称 | bucket-test | |
| bucketPrefix | String | 对象存储桶的前缀 | prefix | |
| autoImport | Boolean | 是否打开自动导入 | true | |
| autoExport | Boolean | 是否打开自动导出 | false | |
| importDataType | String | 导入的数据类型 | metadata | |
| exportDataType | String | 导出的数据类型 | data | |
| importTrigger | String | 导入的触发条件，多个条件用英文逗号隔开 | new | |
| exportTrigger | String | 导出的触发条件，多个条件用英文逗号隔开 | new,changed | |
| dataflowDescription | String | 数据流动策略的描述 | this is the test dataflow strategy | |
| createTime | Long | 数据流动策略创建时间 | 1692259481000 | |
| dataflowStatus | String | 数据流动策略的状态，creating/updating/available/syncing/deleting/fail | fail | |
| dataflowFailTime | Long | 数据流动策略异常发生时间，当数据流动策略状态dataflowStatus为fail才有此字段 | 1692259481000 | |
| dataflowFailMsg | String | 数据流动策略异常原因，当数据流动策略状态dataflowStatus为fail才有此字段 | 桶不存在 | |
| azName | String | 多可用区下的可用区名字 | az2 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"pageSize": 1,
"pageNo": 1
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"dataflowList": [
{
"regionID": "b73e3ad4-417f-11ed-bad1-525400cc3b79",
"dataflowID": "dataflow-j9Knd12B",
"sfsUID": "a2d4b927-9511-5a9b-b1de-cfe55779c1ea",
"sfsDirectory": "/test01",
"bucketName": "bucket-test",
"bucketPrefix": "prefix",
"autoImport": true,
"autoExport": false,
"importDataType": "metadata",
"exportDataType": "data",
"importTrigger": "new",
"exportTrigger": "new,changed",
"bucketDescription": "this is the test dataflow strategy",
"createTime": 1692259481000,
"dataflowStatus": "fail",
"dataflowFailTime": 1692259481000,
"dataflowFailMsg": "桶不存在",
"azName": "az2"
}
],
"pageSize": 1,
"pageNo": 1
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
