查询缓存管理规则列表
更新时间:2026-06-18
描述
本接口用于分页查询缓存管理规则列表,支持关键字筛选。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v{version}/cacherule?action=DescribeCacheRules HTTP/1.1
2Host: rapidfs.bj.baidubce.com
3Authorization: authorization string
4{}
请求头域
除公共头域外,无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| instanceId | String | 是 | RequestBody参数 | RapidFS 实例 ID |
| filters | List<Filter> | 否 | RequestBody参数 | 条件筛选,见数据类型 Filter,多组 filter 之间为条件与关系,多个 value 之间为条件或关系。当前支持字段: • name=dataSrcId,按数据源 ID 筛选,例如 value=["ds-AOLmxozuEqas", "ds-kykIYfOmY9ZU"]; • name=cacheRuleId,例如 value=["cr-HljnqUtZBazs", "cr-3LwVtPjGYPij"]; |
| maxKeys | Int | 否 | RequestBody参数 | 返回列表长度,有效范围 [1, 1000],默认 100 |
| marker | String | 否 | RequestBody参数 | 批量获取列表的查询的起始位置,返回列表按 cacheRuleId 字典序排序,取值为上一次返回的 nextMarker |
返回头域
除公共头域外,无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| cacheRuleInfos | List<CacheRuleInfo> | 缓存管理策略信息列表,见数据类型 CacheRuleInfo |
| marker | String | 当前查询起始位置 |
| isTruncated | Boolean | true 表示后面还有数据,false 表示已经是最后一页 |
| nextMarker | String | 下一页起始位置,为 null 表示后面没有数据了 |
| maxKeys | Int | 返回的列表元素个数 |
请求示例
Plain Text
1POST /v2/cacherule?action=DescribeCacheRules HTTP/1.1
2Host: rapidfs.bj.baidubce.com
3Authorization: authorization string
4{
5 "instanceId": "rapidfs-pNQrtEdPBr78"
6}
返回示例
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 "marker": null,
6 "nextMarker": null,
7 "maxKeys": 100,
8 "cacheRuleInfos": [
9 {
10 "cacheRuleId": "cr-41AieJL8qb8a",
11 "cacheRuleName": "demo-cacheRule",
12 "instanceId": "rapidfs-cWVO8tOu3Uzd",
13 "instanceName": "demo-instalce",
14 "dataSrcId": "ds-KZ7hUmCjods2",
15 "dataSrcName": "demo-ds-1",
16 "type": "WARMUP",
17 "directory": "bos://demo-bucket/demo-path/",
18 "status": "NORMAL",
19 "createTime": "2026-06-11T09:52:53Z",
20 "description": "import data from bos",
21 "lastJobStatus": "FAILED",
22 "lastJobSize": 0,
23 "lastJobStartTime": "2026-06-11T09:52:53Z",
24 "lastJobEndTime": "2026-06-11T09:53:02Z"
25 }
26 ],
27 "isTruncated": false
28}
评价此篇文章
