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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribePolarFsAttribute

get

*LakeCache

acs:polardb:{#regionId}:{#accountId}:lakecache/{#PolarFsInstanceId}

None

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 whose billing method is Prepaid (subscription). 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 whose billing method is Prepaid (subscription).	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, in GB.	1000
StorageUsed	number	The storage usage, in bytes.	3012558848
Bandwidth	number	The bandwidth, in MB/s.	100
BandwidthBaseLine	number	The bandwidth baseline, in 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: cross-zone redundancy.	essdpl1
AcceleratingEnable	string	Indicates whether the acceleration cache is enabled. Valid values: ON: Enabled. OFF: Disabled.	ON
AcceleratedStorageSpace	number	The acceleration storage space, in 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 metadata address for Fuse mount (encrypted).	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	The metadata instance name.	pc-xxxxxxxxxxxxxxxxx
DBEndpointId	string	The endpoint ID.	pe-zo1z5qw5nb39s699n
MaxscaleEndpointId	string	The proxy endpoint ID.	pe-cz9inwqec7ifd98c3
MetaConnString	string	The metadata service cluster endpoint.	pc-x67w12d2d5t13mt88.pg.polardb.rds.aliyuncs.com
MetaMxsConnString	string	The metadata proxy service cluster endpoint.	pc-y3610mp168p3bb740.rwlb.rds.aliyuncs.com
EndpointItems	array<object>	The list of endpoints, including endpoint information for NAS, S3Gateway, and other types.
	array<object>
DBEndpointId	string	The endpoint ID.	ep-xxxxxxxxx
EndpointType	string	The endpoint type. Valid values: Nas, S3Gateway, and others.	S3Gateway
AddressItems	array<object>	The list of addresses.
	object
ConnectionString	string		aclsh-prd-pdb12-rw.rwlb.rds.aliyuncs.com
IPAddress	string		47.116.9.224
Port	string		3306
VPCId	string		vpc-**********
VSwitchId	string		vsw-**************
NetType	string		Public
UserDefaultAccName	string	The default user account name for S3 Gateway.	lakebase_acc
UserDefaultAccSk	string	The default user account key for S3 Gateway (encrypted ciphertext).	EncryptedSecretKey==
AuthorizedUserIds	string	The list of authorized UIDs, separated by commas.	1234567890,9876543210
AuthorizedUserArnIds	string	The list of authorized RAM role ARNs, separated by commas.	arn:sts::123456:assumed-role/myrole/*

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": "pe-zo1z5qw5nb39s699n",
  "MaxscaleEndpointId": "pe-cz9inwqec7ifd98c3",
  "MetaConnString": "pc-x67w12d2d5t13mt88.pg.polardb.rds.aliyuncs.com",
  "MetaMxsConnString": "pc-y3610mp168p3bb740.rwlb.rds.aliyuncs.com",
  "EndpointItems": [
    {
      "DBEndpointId": "ep-xxxxxxxxx",
      "EndpointType": "S3Gateway",
      "AddressItems": [
        {
          "ConnectionString": "aclsh-prd-pdb12-rw.rwlb.rds.aliyuncs.com",
          "IPAddress": "47.116.9.224",
          "Port": "3306",
          "VPCId": "vpc-**********",
          "VSwitchId": "vsw-**************",
          "NetType": "Public"
        }
      ]
    }
  ],
  "UserDefaultAccName": "lakebase_acc",
  "UserDefaultAccSk": "EncryptedSecretKey==",
  "AuthorizedUserIds": "1234567890,9876543210",
  "AuthorizedUserArnIds": "arn:sts::123456:assumed-role/myrole/*"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.