查询文件系统
更新时间:2025-03-31
描述
- 查询用户账户下的所有FileSystem信息
 - 支持按fsId、userId,匹配规则支持部分包含
 - 返回结果是多重查询条件的交集
 - 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定
 
请求
请求结构
                Bash
                
            
            1GET /v{version}/cfs?fsId={fsId}&userId={userId}&marker={marker}&maxKeys={maxKeys}&filterTag={filterTag} HTTP/1.1
2Host: cfs.bj.baidubce.com
3Authorization: authorization string
            请求头域:除公共头域外,无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 | 
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号,当前取值1 | 
| userId | String | 是 | Query参数 | 要查询文件系统所属的用户ID | 
| fsId | String | 否 | Query参数 | 要查询的FileSystem ID,支持批量查询,格式为fsId=fsIdA,fsIdB,fsIdC, 批量查询数量上限为100个。 | 
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置,是一个由系统生成的字符串 | 
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量,最大数量不超过1000。缺省值为1000 | 
| filterTag | String | 否 | Query参数 | {key}:{value}格式  查询key下所有值为 {key}:@@@  | 
响应
返回状态码:成功返回200,失败返回见错误码
返回头域:除公共头域外,无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| fileSystemList | List<FileSystemModel> | 包含查询结果的列表 | 
| marker | String | 标记查询的起始位置,若结果列表为空,此项不存在 | 
| isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 | 
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 | 
| maxKeys | int | 每页结果包含的数量 | 
示例
请求:
                Bash
                
            
            1GET /v1/cfs?fsId=cfs-jVDkWrBBoj&maxKeys=2 HTTP/1.1
2Host: cfs.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
            响应
                Bash
                
            
            1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9  "isTruncated": false,
10  "maxKeys": 1,
11  "fileSystemList": [
12    {
13      "fsId": "cfs-jVDkWrBBoj",
14      "fsName": "test-cfs",
15      "vpcId": "",
16      "type": "ssd",
17      "protocol": "nfs",
18      "fsUsage": "0",
19      "zone": "zoneB",
20      "status": "available",
21      "KMSKeyId": "xxxxxxx", 
22      "createTime": "2023-11-29T11:19:43Z", 
23      "capacityQuota": 0,
24      "mountTargetList": [
25        {
26          "accessGroupName": "DEFAULT_ACCESS_GROUP_NAME",
27          "mountId": "664d336f357447706c794d48304f5a306a5369317a413d3d",
28          "ovip": "192.168.5.242",
29          "domain": "cfs-Y1uZ26QOoh.lb-f02bb5da.cfs.bce.sandbox.baidu.com",
30          "subnetId": "sbn-2ge2ucwhf8ut",
31          "vpcId": "vpc-vjf1mdpq9pkf"
32        }
33      ],
34      "tags": [
35        {
36          "tagKey": "默认项目",
37          "tagValue": "123"
38        }
39      ]
40    }
41  ]
42}
            