PolarFS Instance Attributes Reference via DescribePolarFsAttribute - PolarDB - Alibaba Cloud - PolarDB

Retrieves the details of a PolarLakebase instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PolarFsInstanceId	string	Yes	The PolarLakebase instance ID.	pfs-2ze0i74ka607*****
QueryFuseMountInfo	boolean	No	Specifies whether to query Fuse mount information. Valid values: true: Yes. false: No. This is the default value.	false
DBClusterId	string	No	The cluster ID. Note You can call the DescribeDBClusters operation to query the details of all clusters under your account, including cluster IDs.	pc-bp1q76364ird*****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	3F9E6A3B-C13E-4064-A010-18582A******
RelativeDbClusterId	string	The ID of the associated PolarDB cluster.	pc-2zejpr41d9xk3uk34
PolarFsInstanceId	string	The PolarLakebase instance ID.	pfs-2ze0i74ka607*****
PolarFsStatus	string	The PolarLakebase instance status.	Running
PolarFsVersion	string	The version.	1.0.1-1.0.3
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
DBType	string	The database ecosystem type. Valid values: MySQL PostgreSQL	MySQL
PolarFsInstanceDescription	string	The description of the PolarLakebase instance.	pfs-xxx
RegionId	string	The region ID.	cn-beijing
ZoneId	string	The zone ID of the vSwitch.	cn-beijing-k
VPCId	string	The VPC ID.	vpc-**********
VSwitchId	string	The vSwitch ID.	vsw-**************
SecurityGroupId	string	The managed security group ID.	sg-bp**************
CreateTime	string	The creation time.	2021-08-02T05:57:10Z
ExpireTime	string	The expiration time of the cluster. Note This parameter is returned only for clusters that use the Prepaid (subscription) billing method. An empty value is returned for Postpaid (pay-as-you-go) clusters.	2025-10-10T16:00:00Z
Expired	string	Indicates whether the cluster has expired. Note This parameter is returned only for clusters that use the Prepaid (subscription) billing method.	false
PolarFsType	string	The instance version. Valid values: PolarFS 2.0: 2.0. PolarFS 1.0: 1.0.	PolarFS 2.0
StorageSpace	number	The storage space. Unit: GB.	1000
StorageUsed	number	The used storage space. Unit: bytes.	3012558848
Bandwidth	number	The bandwidth. Unit: MB/s.	100
BandwidthBaseLine	number	The bandwidth baseline. Unit: MB/s/TiB.	100
Category	string	The PolarLakebase edition. Valid values: high_performance: High-performance Edition. basic: Basic Edition. cold: Cold Storage Edition.	high_performance
LockMode	string	The lock mode. Valid values: Unlock: Not locked. ManualLock: Manually locked. LockByExpiration: Automatically locked due to cluster expiration.	Unlock
StorageType	string	The storage type for the High-performance Edition. Valid values: ESSDPL1 ESSDPL0 The storage type for the Basic Edition. Valid values: city_redundancy: zone-redundant storage.	essdpl1
AcceleratingEnable	string	Specifies whether the acceleration cache is enabled. Valid values: ON: Enabled. OFF: Disabled.	ON
AcceleratedStorageSpace	number	The acceleration storage space. Unit: GB.	1000
MountInfo	object	The mount configuration.
PolarFsCluster	string	The file system name.	pfs-**********
Token	string	The token value.	a734298c391cb9ebd05e2ee85feb624
PolarDbProxy	string	The cluster management endpoint.	TCP://...:3000,TCP://...:3000,TCP://...:3000
MinorVersion	string	The minor version of the instance.	v1.3.0-v1.1.1
ClientDownloadPath	string	The client download URL.	oss://*
MetaUrl	string	The encrypted metadata URL for Fuse mounting.	e6cc1d2e2a6fa292038d999fda6501*****
RelativePfsClusterId	string	The instance ID of the associated PolarLakebase instance.	pfs-**********
BucketId	string	The bucket ID.	xxx
FileSystemId	string	The file system ID.	xxx
CustomBucketPath	string	The custom bucket path.	xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com
AccelerateType	string	The acceleration type.	alluxio
CustomBucketPathList	array<object>	The list of custom storage paths.
	object	The custom storage information.
Bucket	string	The custom storage bucket.	pfs-xxx.oss-[regionId]-internal.aliyuncs.com
Path	string	The custom storage path.	/data
MetaInstanceName	string		pc-xxxxxxxxxxxxxxxxx
DBEndpointId	string
MaxscaleEndpointId	string
MetaConnString	string
MetaMxsConnString	string
EndpointItems	array<object>
	array<object>
DBEndpointId	string		ep-xxxxxxxxx
EndpointType	string		S3Gateway
AddressItems	array<object>
	object
ConnectionString	string
IPAddress	string
Port	string
VPCId	string
VSwitchId	string
NetType	string
UserDefaultAccName	string		lakebase_acc
UserDefaultAccSk	string		EncryptedSecretKey==

Examples

Success response

JSON format

{
  "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*****",
  "RelativePfsClusterId": "pfs-**********",
  "BucketId": "xxx",
  "FileSystemId": "xxx",
  "CustomBucketPath": "xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com",
  "AccelerateType": "alluxio",
  "CustomBucketPathList": [
    {
      "Bucket": "pfs-xxx.oss-[regionId]-internal.aliyuncs.com",
      "Path": "/data"
    }
  ],
  "MetaInstanceName": "pc-xxxxxxxxxxxxxxxxx",
  "DBEndpointId": "",
  "MaxscaleEndpointId": "",
  "MetaConnString": "",
  "MetaMxsConnString": "",
  "EndpointItems": [
    {
      "DBEndpointId": "ep-xxxxxxxxx",
      "EndpointType": "S3Gateway",
      "AddressItems": [
        {
          "ConnectionString": "",
          "IPAddress": "",
          "Port": "",
          "VPCId": "",
          "VSwitchId": "",
          "NetType": ""
        }
      ]
    }
  ],
  "UserDefaultAccName": "lakebase_acc",
  "UserDefaultAccSk": "EncryptedSecretKey=="
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.