查詢PolarFS執行個體屬性 - 雲原生資料庫 PolarDB - 阿里雲 - PolarDB

取得 Polarlakebase 執行個體詳細資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribePolarFsAttribute

get

*LakeCache

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

無

請求文法

GET  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
PolarFsInstanceId	string	是	Polarlakebase 執行個體 ID。	pfs-2ze0i74ka607*****
QueryFuseMountInfo	boolean	否	是否查詢 Fuse 掛載資訊，取值如下： true：是。 false：否（預設值）。	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	Polarlakebase 執行個體 ID。	pfs-2ze0i74ka607*****
PolarFsStatus	string	Polarlakebase 執行個體狀態。	Running
PolarFsVersion	string	版本。	1.0.1-1.0.3
PayType	string	付費類型。取值範圍如下： Postpaid：按量付費。 Prepaid：預付費（包年包月）。	Prepaid
DBType	string	所屬資料庫生態類型，取值範圍如下： MySQL PostgreSQL	MySQL
PolarFsInstanceDescription	string	Polarlakebase 執行個體描述。	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：2.0 PolarFS 1.0：1.0	PolarFS 2.0
StorageSpace	number	儲存空間，單位 GB。	1000
StorageUsed	number	儲存空間的使用量，單位為位元組。	3012558848
Bandwidth	number	頻寬，單位 MB/s。	100
BandwidthBaseLine	number	頻寬基線，單位 MB/s/TiB。	100
Category	string	Polarlakebase 系列，目前支援如下系列： high_performance：高效能版 basic：基礎版 cold：冷存版	high_performance
LockMode	string	鎖定模式。取值範圍如下： Unlock：未鎖定。 ManualLock：手動觸發鎖定。 LockByExpiration：叢集過期自動鎖定。	Unlock
StorageType	string	高效能版儲存類型取值如下： ESSDPL1 ESSDPL0 基礎版儲存類型取值如下： city_redundancy：同城冗餘	essdpl1
AcceleratingEnable	string	啟用加速快取，取值如下： ON：啟用。 OFF：關閉。	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*****
RelativePfsClusterId	string	關聯的 Polarlakebase 執行個體 ID。	pfs-**********
BucketId	string	儲存桶 ID。	xxx
FileSystemId	string	檔案系統 ID。	xxx
CustomBucketPath	string	自訂 bucket 路徑。	xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com
AccelerateType	string	加速類型。	alluxio
CustomBucketPathList	array<object>	自訂儲存路徑清單。
	object	自訂儲存資訊。
Bucket	string	自訂儲存 bucket。	pfs-xxx.oss-[regionId]-internal.aliyuncs.com
Path	string	自訂儲存 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==

樣本

正常返回樣本

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*****",
  "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=="
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。