DescribeApplications查詢PolarDB應用列表的API參考-雲原生資料庫 PolarDB-阿里雲 - PolarDB

擷取指定地區內所有PolarDB執行個體的應用列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeApplications

get

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID	cn-beijing
ApplicationIds	string	否	應用 ID 列表，若傳入則只返回這些應用的資訊	pa-**************
PageSize	integer	否	每頁記錄數，取值範圍： 30 50 100 預設值為 30。	30
PageNumber	integer	否	查詢頁碼，預設值為 1。	1
DBClusterId	string	否	PolarDB 執行個體 ID，若傳入則只返回改 PolarDB 執行個體相關的應用資訊	pc-**************
ApplicationTypes	string	否
Tag	array<object>	否
	object	否
Key	string	否		testKey
Value	string	否		testValue

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
TotalRecordCount	integer	總記錄數	1
PageRecordCount	integer	當前頁的記錄數	1
PageNumber	integer	當前頁碼	1
Items	object
Applications	array<object>	應用列表
	array<object>	應用資訊
Status	string	應用狀態，取值範圍 Creating: 建立中 Activated: 運行中 Maintaining: 維護中 ClassChanging: 變更配置中 Transing: 遷移中 MinorVersionUpgrading: 小版本升級中 NetCreating: 訪問地址建立中 NetDeleting: 訪問地址刪除中 NetModifying: 訪問地址修改中 Restarting: 重啟中 Locking: 鎖定中 Locked: 鎖定 Unlocking: 解鎖中 Deleting: 刪除中	Activated
Description	string	應用描述/備忘	myapp
EngineVersion	string	引擎版本	1.0.0
ZoneId	string	可用性區域	cn-hangzhou-b
Expired	string	是否到期	false
PayType	string	付費類型，若應用不計費則為空白	Postpaid
PolarFSInstanceId	string	應用相關的 PolarFS 執行個體的 ID	pcs-**************
Endpoints	object
endpoint	array<object>	應用串連地址清單
	object	應用串連地址
IP	string	IP 位址	192.168.0.3
Port	string	連接埠	8080
NetType	string	串連地址類型 Private: VPC 地址 Public: 公網地址	Public
ApplicationType	string	應用類型	supabase
CreationTime	string	建立時間	2025-03-25T09:37:10Z
RegionId	string	地區	cn-hangzhou
ApplicationId	string	應用 ID	pa-**************
ExpireTime	string	到期時間	2025-06-25T09:37:10Z
DBClusterId	string		pc-xxxxxx
Tags	object
Tag	array<object>
	object
Key	string		testKey
Value	string		testValue

樣本

正常返回樣本

JSON格式

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "Items": {
    "Applications": [
      {
        "Status": "Activated",
        "Description": "myapp",
        "EngineVersion": "1.0.0",
        "ZoneId": "cn-hangzhou-b",
        "Expired": "false",
        "PayType": "Postpaid",
        "PolarFSInstanceId": "pcs-**************\n",
        "Endpoints": {
          "endpoint": [
            {
              "IP": "192.168.0.3",
              "Port": "8080",
              "NetType": "Public"
            }
          ]
        },
        "ApplicationType": "supabase",
        "CreationTime": "2025-03-25T09:37:10Z",
        "RegionId": "cn-hangzhou",
        "ApplicationId": "pa-**************",
        "ExpireTime": "2025-06-25T09:37:10Z",
        "DBClusterId": "pc-xxxxxx",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValue"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

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

變更歷史

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