获取PolarFS实例详情
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PolarFsInstanceId |
string |
是 |
PolarFs 实例 ID |
pfs-2ze0i74ka607***** |
| QueryFuseMountInfo |
boolean |
否 |
是否查询 Fuse 挂载信息，取值如下
|
false |
| DBClusterId |
string |
否 |
集群 ID。 说明
您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息，包括集群 ID。 |
pc-bp1q76364ird***** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
3F9E6A3B-C13E-4064-A010-18582A****** |
| RelativeDbClusterId |
string |
关联的 PolarDB 集群 ID |
pc-2zejpr41d9xk3uk34 |
| PolarFsInstanceId |
string |
PolarFs 实例 ID |
pfs-2ze0i74ka607***** |
| PolarFsStatus |
string |
PolarFs 实例状态 |
Running |
| PolarFsVersion |
string |
版本 |
1.0.1-1.0.3 |
| PayType |
string |
付费类型。取值范围如下：
|
Prepaid |
| DBType |
string |
所属数据库生态类型，取值范围如下：
|
MySQL |
| PolarFsInstanceDescription |
string |
PolarFs 实例描述 |
pfs-xxx |
| RegionId |
string |
地域 ID。 |
cn-beijing |
| ZoneId |
string |
交换机所属可用区 ID。 |
cn-beijing-k |
| VPCId |
string |
专有网络 ID。 |
vpc-********** |
| VSwitchId |
string |
虚拟交换机 ID。 |
vsw-************** |
| SecurityGroupId |
string |
托管安全组 ID。 |
sg-bp************** |
| CreateTime |
string |
创建时间 |
2021-08-02T05:57:10Z |
| ExpireTime |
string |
集群到期时间。 说明
仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。 |
2025-10-10T16:00:00Z |
| Expired |
string |
集群是否到期。 说明
仅付费方式为 Prepaid（包年包月）的集群支持返回该参数。 |
false |
| PolarFsType |
string |
实例版本，取值说明：
|
PolarFS 2.0 |
| StorageSpace |
number |
存储空间，单位 GB。 |
1000 |
| StorageUsed |
number |
存储空间的使用量，单位为 Byte。 |
3012558848 |
| Bandwidth |
number |
带宽，单位 MB/s |
100 |
| BandwidthBaseLine |
number |
带宽基线，单位 MB/s/TiB |
100 |
| Category |
string |
PolarFs 系列，目前支持如下系列：
|
high_performance |
| LockMode |
string |
锁定模式。取值范围如下：
|
Unlock |
| StorageType |
string |
高性能版存储类型取值如下：
基础版存储类型取值如下：
|
essdpl1 |
| AcceleratingEnable |
string |
开启加速缓存，取值如下：
|
ON |
| AcceleratedStorageSpace |
number |
加速空间，单位 GB |
1000 |
| MountInfo |
object |
挂载配置。 |
|
| PolarFsCluster |
string |
文件系统名 |
pfs-********** |
| Token |
string |
Token 值。 |
a734298c391cb9ebd05e2ee85feb624 |
| PolarDbProxy |
string |
集群管理地址 |
TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000 |
| MinorVersion |
string |
实例的小版本号。 |
v1.3.0-v1.1.1 |
| ClientDownloadPath |
string |
客户端下载地址 |
oss://* |
| MetaUrl |
string |
Fuse 挂载的元数据地址（加密） |
e6cc1d2e2a6fa292038d999fda6501***** |
示例
正常返回示例
JSON格式
{
"RequestId": "3F9E6A3B-C13E-4064-A010-18582A******",
"RelativeDbClusterId": "pc-2zejpr41d9xk3uk34",
"PolarFsInstanceId": "pfs-2ze0i74ka607*****",
"PolarFsStatus": "Running",
"PolarFsVersion": "1.0.1-1.0.3",
"PayType": "Prepaid",
"DBType": "MySQL",
"PolarFsInstanceDescription": "pfs-xxx",
"RegionId": "cn-beijing",
"ZoneId": "cn-beijing-k",
"VPCId": "vpc-**********",
"VSwitchId": "vsw-**************",
"SecurityGroupId": "sg-bp**************",
"CreateTime": "2021-08-02T05:57:10Z",
"ExpireTime": "2025-10-10T16:00:00Z",
"Expired": "false",
"PolarFsType": "PolarFS 2.0",
"StorageSpace": 1000,
"StorageUsed": 3012558848,
"Bandwidth": 100,
"BandwidthBaseLine": 100,
"Category": "high_performance",
"LockMode": "Unlock",
"StorageType": "essdpl1",
"AcceleratingEnable": "ON",
"AcceleratedStorageSpace": 1000,
"MountInfo": {
"PolarFsCluster": "pfs-**********",
"Token": "a734298c391cb9ebd05e2ee85feb624",
"PolarDbProxy": "TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000"
},
"MinorVersion": "v1.3.0-v1.1.1",
"ClientDownloadPath": "oss://*",
"MetaUrl": "e6cc1d2e2a6fa292038d999fda6501*****"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。