取得指定 PolarDB 執行個體應用程式的詳細資訊。
介面說明
此 API 用於查詢特定 PolarDB 應用程式的所有相關資訊,包括但不限於元件詳情、連線位址等。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
polardb:DescribeApplicationAttribute |
get |
*Application
|
無 | 無 |
請求文法
POST HTTP/1.1
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ApplicationId |
string |
是 |
應用程式 ID。 |
pa-************** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF |
| ApplicationId |
string |
應用程式 ID。 |
pa-************** |
| DBClusterId |
string |
應用程式相依的 PolarDB 執行個體 ID。 |
pc-************** |
| Architecture |
string |
CPU 架構。取值範圍如下:
|
x86 |
| Description |
string |
應用程式備註。 |
myapp |
| SecurityGroups |
array<object> |
應用程式層級的安全性群組清單。 |
|
|
object |
應用程式層級的安全性群組。 |
||
| SecurityGroupName |
string |
安全性群組名稱。 |
MyGroupName |
| SecurityGroupId |
string |
安全性群組 ID。 |
sg-************** |
| RegionId |
string |
地域 ID。 |
cn-beijing |
| NetType |
string |
網路類型,取值範圍如下:
|
vpc |
| SecurityIPArrays |
array<object> |
應用程式層級的白名單清單。 |
|
|
object |
應用程式層級的白名單。 |
||
| SecurityIPArrayTag |
string |
IP 位址群的標籤。 |
mytag |
| SecurityIPType |
string |
IP 位址的類型。 |
ipv4 |
| SecurityIPList |
string |
白名單 IP 位址,以英文逗號分隔。 |
127.0.0.1 |
| SecurityIPArrayName |
string |
該 IP 位址群的名稱,預設為 |
default |
| SecurityIPNetType |
string |
白名單 IP 的網路類型,預設為 |
mix |
| Status |
string |
應用程式狀態,取值範圍
|
Activated |
| LockMode |
string |
鎖定模式,取值範圍:
|
Unlock |
| ApplicationType |
string |
應用程式類型。 |
supabase |
| Version |
string |
應用程式版本。 |
1.0.0 |
| UpgradeAvailable |
string |
升級是否可用。 |
false |
| MaintainStartTime |
string |
維護開始時間。 |
18:00Z |
| MaintainEndTime |
string |
維護結束時間。 |
19:00Z |
| PayType |
string |
付費類型。 |
Postpaid |
| Expired |
boolean |
是否過期。 |
false |
| VPCId |
string |
VPC ID |
vpc-******************* |
| VSwitchId |
string |
VSwitch ID |
vsw-******************* |
| Components |
array<object> |
子元件清單。 |
|
|
array<object> |
子元件資訊。 |
||
| Status |
string |
元件狀態,取值範圍同應用程式狀態。 |
Activated |
| SecurityGroups |
array<object> |
子元件層級的安全性群組清單。 若子元件層級的安全性群組與應用程式層級相同,則省略此回傳值 |
|
|
object |
子元件層級的安全性群組。 |
||
| SecurityGroupName |
string |
安全性群組名稱 |
MyGroupName |
| SecurityGroupId |
string |
安全性群組 ID |
sg-******************* |
| RegionId |
string |
地區 ID |
cn-beijing |
| NetType |
string |
網路類型,取值範圍如下:
|
vpc |
| ComponentType |
string |
應用程式子元件的類型。 |
gateway |
| Topology |
object |
應用程式子元件的拓撲資訊。 |
|
| Parents |
array |
當前應用子組件的拓撲父節點 ID 列表,或者父節點的子組件類型列表 |
|
|
string |
當前應用子組件的拓撲父節點 ID,或者父節點的子組件類型 |
pac-************** |
|
| Children |
array |
當前應用子組件的拓撲子節點 ID 列表,或者子節點的子組件類型列表 |
|
|
string |
當前應用子組件的拓撲子節點 ID,或者子節點的子組件類型 |
pac-************** |
|
| Layer |
string |
當前應用子組件的拓撲資訊的拓撲層級 |
0 |
| SecurityIPArrays |
array<object> |
子元件層級的白名單位址清單。 若子元件層級的白名單與應用程式層級相同,則省略此回傳值 |
|
|
object |
子元件層級的白名單位址。 |
||
| SecurityIPArrayTag |
string |
IP 位址組的標籤 |
mytag |
| SecurityIPType |
string |
IP 位址的類型 |
ipv4 |
| SecurityIPList |
string |
白名單 IP 位址,英文逗號分隔 |
127.0.0.1 |
| SecurityIPArrayName |
string |
該 IP 位址組的名稱,預設為 |
default |
| SecurityIPNetType |
string |
白名單 IP 的網路類型,預設為 |
mix |
| ComponentClassDescription |
string |
應用程式子元件的規格描述。 |
2C4GB |
| ComponentId |
string |
子元件 ID。 |
pac-******************* |
| ComponentClass |
string |
應用程式子元件的規格。 |
polar.app.g2.medium |
| ComponentReplica |
integer |
應用程式子元件的複本數量。 |
1 |
| ComponentMaxReplica |
integer |
應用程式子元件的最大複本數量。 |
1 |
| ComponentReplicaGroupName |
string |
應用程式子元件的複本的群組名稱。 |
default |
| Endpoints |
array<object> |
應用程式的連線位址清單。 |
|
|
object |
應用程式的連線位址。 |
||
| Description |
string |
連線位址的 Endpoint 備註。 |
myendpoint |
| PortDescription |
string |
連接埠描述。 |
kong_http |
| EndpointId |
string |
連線位址的 Endpoint ID。 |
pa-************** |
| IP |
string |
IP 位址。 |
172.31.95.252 |
| Port |
string |
連接埠。 |
8080 |
| NetType |
string |
連線位址類型
|
Private |
| Domain |
string |
||
| Storages |
array<object> |
儲存資源說明。 |
|
|
object |
|||
| StoragePerformanceLevel |
string |
儲存效能等級。 |
PL0 |
| StorageInstanceId |
string |
儲存執行個體 ID。 |
pa-************** |
| StorageType |
string |
儲存類型。 |
essd |
| StorageCapacity |
string |
儲存容量。 |
20Gi |
| CreationTime |
string |
建立時間。 |
2025-03-25T09:37:10Z |
| ExpireTime |
string |
過期時間。 付費類型為 Postpaid 時為空 |
2025-06-25T09:37:10Z |
| RegionId |
string |
地域。 |
cn-beijing |
| ZoneId |
string |
可用區。 |
cn-beijing-l |
| PolarFSInstanceId |
string |
PolarFS 冷存版/高效能版的執行個體 ID。 |
pfs-************** |
| ServerlessType |
string |
Serverless 類型
|
2 |
| MemApplicationAttribute |
object |
Mem0 應用程式屬性。 |
|
| GraphLlmModelName |
string |
qwen3-max |
|
| LlmModelName |
string |
llm 模型名稱。 |
qwen3-max |
| EmbedderModelName |
string |
Embedder 模型名稱。 |
text-embedding-v4 |
| RerankerModelName |
string |
Reranker 模型名稱。 |
qwen3-rerank |
| ProjectName |
string |
專案名稱,對應資料庫存放專案資料的 schema。 |
test-project-name |
| DbName |
string |
資料庫名稱。 |
test-database-name |
| UserName |
string |
使用者名稱。 |
test-user |
| PolarClawSaaSApplicationAttribute |
object |
PolarClaw SaaS 應用程式屬性。 |
|
| AuthCallbackURL |
string |
認證回呼位址。 |
http://8.xxx.xxx.xxx.xxx/xxx |
| SupabaseClusterId |
string |
Supabase 叢集識別碼。 |
pa-************** |
| AuthProviders |
array |
||
|
string |
|||
| MinorVersion |
string |
小版本號碼。 |
v2026.3.13-1#20260320 |
| LatestVersion |
string |
最新版本號碼。 |
v2026.3.13-1#20260320 |
| IsLatestVersion |
boolean |
是否是最新版本。 |
true |
| NatGatewayId |
string |
pc-xxx |
|
| SnatStatus |
string |
off |
|
| CanDisableSnat |
boolean |
樣本
正常返回樣本
JSON格式
{
"RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
"ApplicationId": "pa-**************",
"DBClusterId": "pc-**************",
"Architecture": "x86",
"Description": "myapp",
"SecurityGroups": [
{
"SecurityGroupName": "MyGroupName",
"SecurityGroupId": "sg-**************",
"RegionId": "cn-beijing",
"NetType": "vpc"
}
],
"SecurityIPArrays": [
{
"SecurityIPArrayTag": "mytag",
"SecurityIPType": "ipv4",
"SecurityIPList": "127.0.0.1",
"SecurityIPArrayName": "default",
"SecurityIPNetType": "mix"
}
],
"Status": "Activated",
"LockMode": "Unlock",
"ApplicationType": "supabase",
"Version": "1.0.0",
"UpgradeAvailable": "false",
"MaintainStartTime": "18:00Z",
"MaintainEndTime": "19:00Z",
"PayType": "Postpaid",
"Expired": false,
"VPCId": "vpc-*******************",
"VSwitchId": "vsw-*******************",
"Components": [
{
"Status": "Activated",
"SecurityGroups": [
{
"SecurityGroupName": "MyGroupName",
"SecurityGroupId": "sg-*******************\n",
"RegionId": "cn-beijing",
"NetType": "vpc"
}
],
"ComponentType": "gateway",
"Topology": {
"Parents": [
"pac-**************"
],
"Children": [
"pac-**************"
],
"Layer": "0"
},
"SecurityIPArrays": [
{
"SecurityIPArrayTag": "mytag",
"SecurityIPType": "ipv4",
"SecurityIPList": "127.0.0.1",
"SecurityIPArrayName": "default",
"SecurityIPNetType": "mix"
}
],
"ComponentClassDescription": "2C4GB",
"ComponentId": "pac-*******************",
"ComponentClass": "polar.app.g2.medium",
"ComponentReplica": 1,
"ComponentMaxReplica": 1,
"ComponentReplicaGroupName": "default"
}
],
"Endpoints": [
{
"Description": "myendpoint",
"PortDescription": "kong_http",
"EndpointId": "pa-**************",
"IP": "172.31.95.252",
"Port": "8080",
"NetType": "Private",
"Domain": ""
}
],
"Storages": [
{
"StoragePerformanceLevel": "PL0",
"StorageInstanceId": "pa-**************",
"StorageType": "essd",
"StorageCapacity": "20Gi"
}
],
"CreationTime": "2025-03-25T09:37:10Z",
"ExpireTime": "2025-06-25T09:37:10Z",
"RegionId": "cn-beijing",
"ZoneId": "cn-beijing-l",
"PolarFSInstanceId": "pfs-**************",
"ServerlessType": "2",
"MemApplicationAttribute": {
"GraphLlmModelName": "qwen3-max",
"LlmModelName": "qwen3-max\n",
"EmbedderModelName": "text-embedding-v4\n",
"RerankerModelName": "qwen3-rerank\n",
"ProjectName": " test-project-name\n",
"DbName": "test-database-name\n",
"UserName": "test-user\n"
},
"PolarClawSaaSApplicationAttribute": {
"AuthCallbackURL": "http://8.xxx.xxx.xxx.xxx/xxx",
"SupabaseClusterId": "pa-**************",
"AuthProviders": [
""
]
},
"MinorVersion": "v2026.3.13-1#20260320",
"LatestVersion": "v2026.3.13-1#20260320",
"IsLatestVersion": true,
"NatGatewayId": "pc-xxx",
"SnatStatus": "off",
"CanDisableSnat": false
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。