查询RapidFS实例列表
更新时间：2026-06-17
描述
本接口用于查询 RapidFS 实例列表，提供分页查询功能，支持按指定关键字过滤。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v{version}/instance?action=DescribeInstances HTTP/1.1
2Host: rapidfs.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "filters": [
7 {
8 "name": "instanceId",
9 "values": ["rapidfs-KffjPuGy1ySv"]
10 }
11 ],
12 "maxKeys": 100,
13 "marker": ""
14}请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| filters | List |
否 | RequestBody参数 | 条件筛选，见附录 Filter，多组 filter 之间为条件与关系，多个 value 之间为条件或关系。当前支持字段: • name=instanceId，例如 value=["rapidfs-wKEltVDfQwgO", "rapidfs-Lp1yaDO582fz"]； • name=instanceName，例如 value=["filter-name", "test-name"]； • name=status, 状态枚举值参考附录 InstanceStatus，例如 value=["RUNNING", "CREATING"]； • name=aihcResourcePoolId/cceClusterId/k8sControllerId，例如 value=["aihc-hk25ilq7xcfd", "cce-gv45s2cp"] |
| maxKeys | Int | 否 | RequestBody参数 | 返回实例列表长度，有效范围 [1, 1000]，默认 100 |
| marker | String | 否 | RequestBody参数 | 批量获取列表的查询的起始位置，返回列表按 instanceId 字典序排列，取值为上一次返回的 nextMarker |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceInfos | List |
RapidFS 实例信息列表，见附录 InstanceInfo |
| marker | String | 当前查询起始位置 |
| isTruncated | Boolean | true 表示后面还有数据，false 表示已经是最后一页 |
| nextMarker | String | 下一页起始位置，为 null 表示后面没有数据了 |
| maxKeys | Int | 返回的列表元素个数 |
请求示例
Plain Text
1POST /v2/instance?action=DescribeInstances HTTP/1.1
2Host: rapidfs.bj.baidubce.com
3Authorization: authorization string
4{
5 "filters": [
6 {
7 "name": "instanceId",
8 "values": [
9 "rapidfs-KffjPuGy1ySv",
10 "rapidfs-LYwLcVeS1AbJ"
11 ]
12 }
13 ]
14}返回示例
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 "instanceInfos": [
9 {
10 "instanceName": "demo-instance1",
11 "instanceId": "rapidfs-KffjPuGy1ySv",
12 "description": "demo-description",
13 "status": "RUNNING",
14 "region": "bd",
15 "zone": "zoneB",
16 "capacityMiB": 3145728,
17 "capacityUsedMiB": 0,
18 "capacityUsedPercentage": 0.0,
19 "vpcId": "vpc-znt4cwv6z817",
20 "subnetId": "sbn-p69syq5etyp5",
21 "managedMode": "FullyManaged",
22 "metaSpec": "",
23 "dataSpec": "Basic",
24 "type": "BCC",
25 "resizeStatus": "NORMAL",
26 "allocatedQuotaMiB": 0,
27 "tags": [
28 {
29 "tagKey": "demo-key",
30 "tagValue": "demo-value"
31 }
32 ],
33 "createTime": "2026-05-18T06:21:03Z"
34 },
35 {
36 "instanceName": "demo-instance2",
37 "instanceId": "rapidfs-KffjPuGy1ySv",
38 "description": "demo-description",
39 "status": "RUNNING",
40 "region": "bd",
41 "zone": "zoneB",
42 "capacityMiB": 3145728,
43 "capacityUsedMiB": 0,
44 "capacityUsedPercentage": 0.0,
45 "vpcId": "vpc-znt4cwv6z817",
46 "subnetId": "sbn-p69syq5etyp5",
47 "managedMode": "FullyManaged",
48 "metaSpec": "",
49 "dataSpec": "Basic",
50 "type": "BCC",
51 "resizeStatus": "NORMAL",
52 "allocatedQuotaMiB": 0,
53 "tags": [
54 {
55 "tagKey": "demo-key",
56 "tagValue": "demo-value"
57 }
58 ],
59 "createTime": "2026-05-18T06:21:03Z"
60 }
61 ],
62 "isTruncated": false
63}评价此篇文章