创建元数据同步规则
更新时间：2026-06-18
描述
本接口用于在指定 RapidFS 实例的数据源下创建元数据同步规则。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v{version}/metasyncrule?action=CreateMetaSyncRule&clientToken={clientToken} HTTP/1.1
2Host: rapidfs.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "instanceId": "rapidfs-pNQrtEdPBr78",
7 "dataSrcId": "ds-kBMPnIOwGLgp",
8 "metaSyncRuleName": "my-metasync",
9 "type": "PERIODIC",
10 "directory": "/data/",
11 "intervalMinutes": 10,
12 "executeOnCreate": false,
13 "enableOnCreate": true,
14 "description": "sync metadata periodically"
15}请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | Query参数 | 保证API调用的幂等性 |
| instanceId | String | 是 | RequestBody参数 | RapidFS 实例 ID |
| dataSrcId | String | 是 | RequestBody参数 | 数据源 ID |
| metaSyncRuleName | String | 是 | RequestBody参数 | 元数据同步规则名称 |
| type | String | 是 | RequestBody参数 | 元数据同步规则类型，枚举值： • MANUAL：单次同步，手动执行； • PERIODIC：周期同步，自动执行 |
| directory | String | 否 | RequestBody参数 | RapidFS 目录前缀，默认值为 / |
| intervalMinutes | Int | 否 | RequestBody参数 | 同步间隔时间，单位 min，默认 5min。有效范围 [1, 28800(20 天)] |
| executeOnCreate | Boolean | 否 | RequestBody参数 | 单次同步创建之后是否立即执行，默认 false |
| enableOnCreate | Boolean | 否 | RequestBody参数 | 周期同步创建之后是否默认开启，默认 true |
| description | String | 否 | RequestBody参数 | 元数据同步描述信息 |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| metaSyncRuleId | String | 元数据同步规则唯一 ID |
请求示例
Plain Text
1POST /v2/metasyncrule?action=CreateMetaSyncRule&clientToken=62b942bd-3a6f-4831-b39e-eb9109e66b5 HTTP/1.1
2Host: rapidfs.bj.baidubce.com
3Authorization: authorization string
4{
5 "instanceId": "rapidfs-pNQrtEdPBr78",
6 "dataSrcId": "ds-kBMPnIOwGLgp",
7 "metaSyncRuleName": "my-metasync",
8 "type": "PERIODIC",
9 "directory": "/data/",
10 "intervalMinutes": 10,
11 "enableOnCreate": true,
12 "description": "sync metadata periodically"
13}返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
4{
5 "metaSyncRuleId": "ms-aBcDeFgHiJ"
6}评价此篇文章