最近更新时间：2025-02-06 10:14:42
本接口（DescribeFileSystemList）用于查询您的文件系统列表或特定文件系统的基本信息。
GET
请求参数包含公共请求参数和接口请求参数。其中，公共请求参数是每个接口都会用到的请求参数，具体参见公共参数及签名机制；接口请求参数是各个接口所特有的，具体参见下方说明：
请求头
名称 | 是否必须 | 值 |
|---|---|---|
Accept | 是 | application/json |
请求体
名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
Region | string | 否 | 文件系统所在地域，不传则返回所有地域下文件系统。有效值：
|
FileSystemName | string | 否 | 文件系统名称前缀，模糊查询。 |
FileSystemIds | string | 否 | 文件系统的实例ID清单，支持批量查询，FileSystemId 以逗号分隔。 |
StoreClasses | string | 否 | 文件系统的存储类型。 |
PageNum | number | 否 | 页码。默认为1。 |
PageSize | number | 否 | 分页大小。默认为10。 |
Action | string | 是 | 该参数为公共参数，取值：DescribeFileSystemList。 |
Version | string | 是 | 该参数为公共参数，取值：2024-09-30。 |
名称 | 类型 | 描述 |
|---|---|---|
RequestId | string | 唯一请求ID，每次请求都会返回。 |
Data | object[] | 文件系统的描述信息。 |
— Status | string | 文件系统的运行状态。有效值：
|
— ChargeInfo | object | 文件系统的购买信息。 |
— ChargeType | string | 计费类型。有效值：
|
— ExpiredTime | string | 到期时间，仅包年包月计费类型返回。 |
— FileSystemInfo | object | 文件系统的基本信息。 |
— FileSystemName | string | 名称。 |
— Capacity | number | 容量配额。 |
— Region | string | 所在Region。 |
— RegionName | string | 所在Region中文名称。 |
— AzRegion | string | 所在可用区。 |
— FileSystemId | string | 实例ID。 |
— CreateTime | string | 创建时间。 |
— UpdateTime | string | 更新时间。当做扩容或续费时，会改变更新时间。 |
— StoreClass | string | 存储类型。有效值：
|
— ClientMountCommand | string | 客户端下载指令以及挂载指令，仅容量Ⅰ型、容量Ⅱ型、标准型返回。 |
— ChunkSize | string | 条带块大小，仅性能Ⅰ型返回。单位：Byte。 |
— ClusterName | string | 存储池名称 |
— ClusterCode | string | 存储池Code，为专属集群的UUID，仅性能Ⅰ型返回。 |
— AccessRules | object | 文件系统的认证信息。 |
— Token | string | Token，用于挂载时的身份认证，仅容量Ⅰ型、容量Ⅱ型、标准型返回。 |
— VolumeInfo | object | 文件系统的用量信息。 |
— Inodes | number | 已用文件数。 |
— UseCapacity | number | 已用容量。单位：B。 |
PageSize | number | 页码。默认为1。 |
PageNum | number | 分页大小。默认为20。 |
TotalCount | number | 返回的文件系统总数。 |
请求示例
http://kpfs.api.ksyun.com?Region=cn-beijing-6&FileSystemName=fs&PageNum=1&PageSize=10&Action=DescribeFileSystemList&Version=2024-09-30返回示例
{
"RequestId": "ea82d72e-0169-4970-8beb-92d3a10964d7",
"Data":[
{
"Status": "using",
"ChargeInfo": {
"ChargeType": "monthly",
"ExpiredTime": "2024-12-04T23:59:59"
},
"FileSystemInfo": {
"FileSystemName": "train-fs",
"Capacity": 20,
"Region": "cn-beijing-6",
"RegionName": "华北1（北京）",
" AzRegion":"cn-beijing-6e",
"FileSystemId": "bb2edf97a37642a1af52533cc756f487",
"CreateTime": "2024-11-04T15:50:22",
"UpdateTime": "2024-11-04T15:51:10",
"StoreClass": "KPFS-capacity",
"ClientMountCommand": "sudo curl -L http://192.168.2.135:8080 -o /usr/local/bin/juicefs && sudo chmod +x /usr/local/bin/juicefs\r\nsudo /usr/local/bin/juicefs mount train-fs /juicefs"
},
"AccessRules": [
{
"Token": "2fdd2405ab06da543bf36606c6cf44bfb1412dd9"
}
],
"VolumeInfo": {
"Inodes": 0,
"UseCapacity": 0
}
}
]
"PageSize":1,
"PageNum":20,
"TotalCount":1
}纯净模式
