查看polarfs信息
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。 |
cn-beijing |
| PageSize |
integer |
否 |
每页记录数，取值如下：
|
30 |
| PageNumber |
integer |
否 |
页码，取值范围为大于 0 但不超过 Integer 最大值的整数。 |
1 |
| PolarFsInstanceIds |
string |
否 |
PolarFs 实例 ID 列表，用 |
pfs-ins1******* |
| PolarFsInstanceDescription |
string |
否 |
PolarFs 实例描述 |
pfs-ins1******** |
| RelativeDbClusterId |
string |
否 |
关联的 PolarDB 集群 ID |
pc-2zejpr41d9xk***** |
| PolarFsType |
string |
否 |
PolarFs 类型 |
all |
| DBClusterId |
string |
否 |
应用依赖的 PolarDB 实例 ID |
pc-2ze8u21s03****** |
| Tag |
array<object> |
否 |
标签 |
|
|
object |
否 |
标签 |
||
| Key |
string |
否 |
标签键 |
testKey |
| Value |
string |
否 |
标签值 |
testValue |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
8CD1852F-8176-55E4-891C-4478DC00CC7A |
| Items |
object |
||
| PolarFsPaths |
array<object> |
PolarFs 文件系统列表 |
|
|
array<object> |
|||
| PolarFsPath |
string |
PolarFs 文件系统路径 |
pfs-ins1******* |
| PolarFsStatus |
string |
PolarFs 实例状态 |
Running |
| CreateTime |
string |
创建时间。 |
2021-09-13T15:45:35Z |
| ExpireTime |
string |
集群到期时间。 说明
仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。 |
2026-03-16T16:00:00Z |
| PayType |
string |
付费类型，取值范围如下：
|
Prepaid |
| RegionId |
string |
地域 ID。 |
cn-beijing |
| ZoneId |
string |
可用区 ID。 |
cn-beijing-k |
| StorageSpace |
integer |
存储空间。 |
100 |
| StorageType |
string |
高性能版存储类型取值如下：
基础版存储类型取值如下：
|
city_redundancy |
| PolarFsInstanceId |
string |
PolarFs 实例 ID |
pfs-2ze0i74ka607***** |
| PolarFsInstanceDescription |
string |
PolarFs 实例名称 |
pfs-2ze0i74ka607***** |
| MountedAIDBClusters |
object |
||
| MountedAIDBClusters |
array<object> |
挂载的集群列表 |
|
|
object |
|||
| DBClusterId |
string |
集群 ID。 |
pc-uf6ts058spfqlczw1 |
| MountedTime |
string |
数据库文件系统挂载时间。用时间戳表示，单位毫秒。 |
17********* |
| MountDir |
string |
本地挂载目录。 |
/mnt/pfs-xxx******** |
| MountStatus |
string |
挂载状态 |
Mounting |
| Expired |
string |
集群是否到期。取值范围：
说明
仅付费方式为 Prepaid（包年包月）的集群支持返该参数。 |
False |
| Bandwidth |
integer |
节点的带宽限制，单位为 MB/s。 |
200 |
| PolarFsType |
string |
实例版本，取值说明：
|
PolarFS 2.0 |
| MountInfo |
object |
挂载配置。 |
|
| Token |
string |
token |
*** |
| PolarFsCluster |
string |
文件系统名 |
pfs-******* |
| PolarDbProxy |
string |
集群管理地址 |
TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000 |
| VPCId |
string |
VPC ID。 |
vpc-uf653ibw32whvnplrnzz4 |
| VSwitchId |
string |
虚拟交换机 ID。 |
vsw-uf6xz71d3a3mpmqtpljuz |
| SecurityGroupId |
string |
托管安全组 ID。 |
sg-8vbdy5mn2we1glzs31pm |
| RelativeDbClusterId |
string |
关联的 PolarDB 集群 ID |
pc-bp18096c109yt52nz |
| Category |
string |
PolarFs 系列，目前支持如下系列：
|
high_performance |
| AcceleratingEnable |
string |
开启加速缓存，取值如下：
|
ON |
| AcceleratedStorageSpace |
string |
加速空间，单位 GB |
10.0 |
| Tags |
object |
||
| Tag |
array<object> |
标签列表 |
|
|
object |
标签 |
||
| Key |
string |
标签键。 |
testKey |
| Value |
string |
标签键对应的标签值。 说明
最多支持 64 个字符，不能以 |
testValue |
| AccelerateType |
string |
加速类型 |
juice |
| TotalRecordCount |
integer |
总记录数。 |
16 |
| PageRecordCount |
integer |
本页记录数。 |
13 |
| PageNumber |
integer |
页码。 |
1 |
示例
正常返回示例
JSON格式
{
"RequestId": "8CD1852F-8176-55E4-891C-4478DC00CC7A",
"Items": {
"PolarFsPaths": [
{
"PolarFsPath": "pfs-ins1*******",
"PolarFsStatus": "Running",
"CreateTime": "2021-09-13T15:45:35Z",
"ExpireTime": "2026-03-16T16:00:00Z",
"PayType": "Prepaid",
"RegionId": "cn-beijing",
"ZoneId": "cn-beijing-k",
"StorageSpace": 100,
"StorageType": "city_redundancy",
"PolarFsInstanceId": "pfs-2ze0i74ka607*****",
"PolarFsInstanceDescription": "pfs-2ze0i74ka607*****",
"MountedAIDBClusters": {
"MountedAIDBClusters": [
{
"DBClusterId": "pc-uf6ts058spfqlczw1",
"MountedTime": "17*********",
"MountDir": "/mnt/pfs-xxx********",
"MountStatus": "Mounting"
}
]
},
"Expired": "False",
"Bandwidth": 200,
"PolarFsType": "PolarFS 2.0",
"MountInfo": {
"Token": "***",
"PolarFsCluster": "pfs-*******",
"PolarDbProxy": "TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000"
},
"VPCId": "vpc-uf653ibw32whvnplrnzz4",
"VSwitchId": "vsw-uf6xz71d3a3mpmqtpljuz",
"SecurityGroupId": "sg-8vbdy5mn2we1glzs31pm",
"RelativeDbClusterId": "pc-bp18096c109yt52nz",
"Category": "high_performance",
"AcceleratingEnable": "ON",
"AcceleratedStorageSpace": "10.0",
"Tags": {
"Tag": [
{
"Key": "testKey",
"Value": "testValue"
}
]
},
"AccelerateType": "juice"
}
]
},
"TotalRecordCount": 16,
"PageRecordCount": 13,
"PageNumber": 1
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。