AI 助理
文档备案控制台
官方文档
首页 云原生数据库 PolarDB 开发参考 PolarDB MySQL版/PostgreSQL版API参考 API参考指南 API目录 PolarDB应用 DescribeApplicationAttribute - 查询PolarDB应用属性

DescribeApplicationAttribute - 查询PolarDB应用属性

更新时间：
复制 MD 格式
产品详情
我的收藏

获取指定PolarDB实例应用的详细信息。

接口说明

该 API 用于查询特定 PolarDB 应用的所有相关信息，包括但不限于组件详情、连接地址等。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeApplicationAttribute

get

*Application

acs:polardb:{#regionId}:{#accountId}:application/{#ApplicationId}

 无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值
ApplicationId

string

是

应用 ID

pa-**************

返回参数

名称

类型

描述

示例值

object

Schema of Response

ApplicationId

string

应用 ID

pa-**************
ApplicationType

string

应用类型

supabase
Architecture

string

CPU 架构。取值范围如下：

  • x86

x86
CanDisableSnat

boolean

是否支持关闭 SNAT

Components

array<object>

子组件列表

array<object>

子组件信息

ComponentClass

string

应用子组件的规格

polar.app.g2.medium
ComponentClassDescription

string

应用子组件的规格描述

2C4GB
ComponentId

string

子组件 ID

pac-*******************
ComponentMaxReplica

integer

应用子组件的最大副本数量

1
ComponentReplica

integer

应用子组件的副本数量

1
ComponentReplicaGroupName

string

应用子组件的副本的组名称

default
ComponentType

string

应用子组件的类型

gateway
SecurityGroups

array<object>

子组件级别的安全组列表。

若子组件级别的安全组与应用级别相同，则改返回值省略

object

子组件级别的安全组

NetType

string

网络类型，取值范围如下：

  • vpc

vpc
RegionId

string

地域 ID

cn-beijing
SecurityGroupId

string

安全组 ID

sg-*******************

SecurityGroupName

string

安全组名称

MyGroupName
SecurityIPArrays

array<object>

子组件级别的白名单地址列表。

若子组件级别的白名单与应用级别相同，则该返回值省略

object

子组件级别的白名单地址

SecurityIPArrayName

string

该 IP 地址组的名称，默认为default

default
SecurityIPArrayTag

string

IP 地址组的标签

mytag
SecurityIPList

string

白名单 IP 地址，英文逗号分隔

127.0.0.1
SecurityIPNetType

string

白名单 IP 的网络类型，默认为mix

mix
SecurityIPType

string

IP 地址的类型

ipv4
Status

string

组件状态，取值范围同应用状态

Activated
Topology

object

应用子组件的拓扑信息

Children

array

当前应用子组件的拓扑子节点 ID 列表，或者子节点的子组件类型列表

string

当前应用子组件的拓扑子节点 ID，或者子节点的子组件类型

pac-**************
Layer

string

当前应用子组件的拓扑信息的拓扑层级

0
Parents

array

当前应用子组件的拓扑父节点 ID 列表，或者父节点的子组件类型列表

string

当前应用子组件的拓扑父节点 ID，或者父节点的子组件类型

pac-**************
CreationTime

string

创建时间

时间采用 ISO 8601 格式，时区为 UTC（格式：YYYY-MM-DDTHH:mm:ssZ）。

2025-03-25T09:37:10Z
DBClusterId

string

应用依赖的 PolarDB 实例 ID

pc-**************
Description

string

应用备注

myapp
DnatMappings

array<object>

NAT 映射：DNAT 映射条目列表

object

DNAT 映射条目

AccessAddress

string

访问地址，格式为 NatIp:FrontPort，办公网可直接使用

10.64.0.10:10001
BackendPort

integer

后端服务端口

8787
EntryId

string

DNAT 条目 ID

fwd-xxx
FrontPort

integer

前端端口

10001
PortName

string

端口名称，取值：webui | hermesagent | dashboard | ssh

webui
Status

string

条目状态

Available
Endpoints

array<object>

应用的连接地址列表

object

应用的连接地址

Description

string

连接地址的 Endpoint 备注

myendpoint
Domain

string

应用连接地址的域名。

EndpointId

string

连接地址的 Endpoint ID

pa-**************
IP

string

IP 地址

172.31.95.252
NetType

string

连接地址类型

  • Private: VPC 地址

  • Public: 公网地址

Private
Port

string

端口

8080
PortDescription

string

端口描述

kong_http
ExpireTime

string

过期时间。

付费类型为 Postpaid 时为空

时间采用 ISO 8601 格式，时区为 UTC（格式：YYYY-MM-DDTHH:mm:ssZ）。

2025-06-25T09:37:10Z
Expired

boolean

是否过期

false
IsLatestVersion

boolean

是否是最新版本。

true
LatestVersion

string

最新版本号。

v2026.3.13-1#20260320
LockMode

string

锁定模式，取值范围：

  • Unlock: 未锁定

  • Lock: 已锁定

Unlock
MaintainEndTime

string

维护结束时间

时间为 UTC 时间，格式为 HH:mmZ。

19:00Z
MaintainStartTime

string

维护开始时间

时间为 UTC 时间，格式为 HH:mmZ。

18:00Z
MemApplicationAttribute

object

Mem0 应用属性

DbName

string

数据库名称。

test-database-name

EmbedderModelName

string

Embedder 模型名称。

text-embedding-v4

GraphLlmModelName

string

图 LLM 模型支持

qwen3-max
LlmModelName

string

llm 模型名称。

qwen3-max

MemoryType

string

当前生效的记忆类型

MULTIMODAL_TEXT
MultimodalEnabled

boolean

当前是否已开启多模态

true
ProjectName

string

项目名称，对应数据库存放项目数据的 schema。

test-project-name

RerankerModelName

string

Reranker 模型名称。

qwen3-rerank

SessionStore

object

Mem0 全量会话信息存储配置

AccountMode

string

账号来源：reuse_vector 或 existing，仅 ENABLED 时返回

existing
DBClusterId

string

会话存储使用的 PolarDB 集群 ID，仅 ENABLED 时返回

pc-xxx
DBName

string

会话数据库名，仅 ENABLED 时返回

contextdb_example
Status

string

会话存储状态：DISABLED、ENABLING、ENABLED 或 DISABLING

ENABLED
UserName

string

用户名。

test-user

VisualEmbedderDimensions

integer

当前 VisualEmbedder 维度

2560
VisualEmbedderModelName

string

当前 VisualEmbedder 模型

qwen3.7-text-embedding
VisualLlmModalities

array

当前已开启的理解模态

string

当前已开启的理解模态

image
VisualLlmModelName

string

当前 VisualLLM 模型

qwen3.6-flash
MinorVersion

string

小版本号。

v2026.3.13-1#20260320
NatGatewayId

string

NAT 网关 ID

pc-xxx
NatMappingSnatIpAddress

string

NAT 映射：应用所在交换机绑定的 SNAT IP 地址（客户自管 SNAT 条目，管控实时发现并返回；与公网 NAT 网关 SNAT 无关）

10.64.0.20
PayType

string

付费类型

Postpaid
PolarClawApplicationAttribute

object

PolarClaw 应用属性

LangfuseBinding

object

Langfuse 绑定信息

ActivatedAt

integer

绑定生效时间（Unix 时间戳）

1788771141
ApiKeyId

string

Langfuse API Key ID

api-key-xxx
BindingTaskId

integer

绑定任务 ID

387
LangfuseApplicationId

string

Langfuse 应用 ID

pa-xxx
Phase

string

绑定阶段

ACTIVE
ProjectId

string

Langfuse 项目 ID

project-xxx
PolarClawSaaSApplicationAttribute

object

PolarClaw SaaS 应用属性

AuthCallbackURL

string

认证回调地址

http://8.xxx.xxx.xxx.xxx/xxx
AuthProviders

array

应用认证提供方列表。

string

认证提供方名称。

SupabaseClusterId

string

Supabase 集群标识

pa-**************
PolarFSInstanceId

string

PolarFS 冷存版/高性能版的实例 ID

pfs-**************
RegionId

string

地域

cn-beijing
RequestId

string

请求 ID

3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
SecurityGroups

array<object>

应用级别的安全组列表

object

应用级别的安全组

NetType

string

网络类型，取值范围如下：

  • vpc

vpc
RegionId

string

地域 ID

cn-beijing
SecurityGroupId

string

安全组 ID

sg-**************
SecurityGroupName

string

安全组名称

MyGroupName
SecurityIPArrays

array<object>

应用级别的白名单列表

object

应用级别的白名单

SecurityIPArrayName

string

该 IP 地址组的名称，默认为default

default
SecurityIPArrayTag

string

IP 地址组的标签

mytag
SecurityIPList

string

白名单 IP 地址，英文逗号分隔

127.0.0.1
SecurityIPNetType

string

白名单 IP 的网络类型，默认为mix

mix
SecurityIPType

string

IP 地址的类型

ipv4
ServerlessType

string

Serverless 类型

  • 2：敏态

  • 3：稳态

2
SnatStatus

string

on、off SNAT 状态

off
Status

string

应用状态，取值范围

  • Creating: 创建中

  • Activated: 运行中

  • Maintaining: 维护中

  • ClassChanging: 变更配置中

  • Transing: 迁移中

  • MinorVersionUpgrading: 小版本升级中

  • NetCreating: 访问地址创建中

  • NetDeleting: 访问地址删除中

  • NetModifying: 访问地址修改中

  • Restarting: 重启中

  • Locking: 锁定中

  • Locked: 已锁定

  • Unlocking: 解锁中

  • Deleting: 删除中

Activated
Storages

array<object>

存储资源说明

object

StorageCapacity

string

存储容量。

20Gi
StorageInstanceId

string

存储实例 ID。

pa-**************
StoragePerformanceLevel

string

存储性能级别。

PL0
StorageType

string

存储类型

essd
UpgradeAvailable

string

升级是否可用

false
VPCId

string

VPC ID

vpc-*******************
VSwitchId

string

VSwitch ID

vsw-*******************
Version

string

应用版本

1.0.0
VpcNatGatewayId

string

NAT 映射：客户自建的 VPC NAT 网关 ID

ngw-xxx
ZoneId

string

可用区

cn-beijing-l

示例

正常返回示例

JSON格式

{
  "ApplicationId": "pa-**************",
  "ApplicationType": "supabase",
  "Architecture": "x86",
  "CanDisableSnat": true,
  "Components": [
    {
      "ComponentClass": "polar.app.g2.medium",
      "ComponentClassDescription": "2C4GB",
      "ComponentId": "pac-*******************",
      "ComponentMaxReplica": 1,
      "ComponentReplica": 1,
      "ComponentReplicaGroupName": "default",
      "ComponentType": "gateway",
      "SecurityGroups": [
        {
          "NetType": "vpc",
          "RegionId": "cn-beijing",
          "SecurityGroupId": "sg-*******************\n",
          "SecurityGroupName": "MyGroupName"
        }
      ],
      "SecurityIPArrays": [
        {
          "SecurityIPArrayName": "default",
          "SecurityIPArrayTag": "mytag",
          "SecurityIPList": "127.0.0.1",
          "SecurityIPNetType": "mix",
          "SecurityIPType": "ipv4"
        }
      ],
      "Status": "Activated",
      "Topology": {
        "Children": [
          "pac-**************"
        ],
        "Layer": "0",
        "Parents": [
          "pac-**************"
        ]
      }
    }
  ],
  "CreationTime": "2025-03-25T09:37:10Z",
  "DBClusterId": "pc-**************",
  "Description": "myapp",
  "DnatMappings": [
    {
      "AccessAddress": "10.64.0.10:10001",
      "BackendPort": 8787,
      "EntryId": "fwd-xxx",
      "FrontPort": 10001,
      "PortName": "webui",
      "Status": "Available"
    }
  ],
  "Endpoints": [
    {
      "Description": "myendpoint",
      "Domain": "",
      "EndpointId": "pa-**************",
      "IP": "172.31.95.252",
      "NetType": "Private",
      "Port": "8080",
      "PortDescription": "kong_http"
    }
  ],
  "ExpireTime": "2025-06-25T09:37:10Z",
  "Expired": false,
  "IsLatestVersion": true,
  "LatestVersion": "v2026.3.13-1#20260320",
  "LockMode": "Unlock",
  "MaintainEndTime": "19:00Z",
  "MaintainStartTime": "18:00Z",
  "MemApplicationAttribute": {
    "DbName": "test-database-name\n",
    "EmbedderModelName": "text-embedding-v4\n",
    "GraphLlmModelName": "qwen3-max",
    "LlmModelName": "qwen3-max\n",
    "MemoryType": "MULTIMODAL_TEXT",
    "MultimodalEnabled": true,
    "ProjectName": " test-project-name\n",
    "RerankerModelName": "qwen3-rerank\n",
    "SessionStore": {
      "AccountMode": "existing",
      "DBClusterId": "pc-xxx",
      "DBName": "contextdb_example",
      "Status": "ENABLED"
    },
    "UserName": "test-user\n",
    "VisualEmbedderDimensions": 2560,
    "VisualEmbedderModelName": "qwen3.7-text-embedding",
    "VisualLlmModalities": [
      "image"
    ],
    "VisualLlmModelName": "qwen3.6-flash"
  },
  "MinorVersion": "v2026.3.13-1#20260320",
  "NatGatewayId": "pc-xxx",
  "NatMappingSnatIpAddress": "10.64.0.20",
  "PayType": "Postpaid",
  "PolarClawApplicationAttribute": {
    "LangfuseBinding": {
      "ActivatedAt": 1788771141,
      "ApiKeyId": "api-key-xxx",
      "BindingTaskId": 387,
      "LangfuseApplicationId": "pa-xxx",
      "Phase": "ACTIVE",
      "ProjectId": "project-xxx"
    }
  },
  "PolarClawSaaSApplicationAttribute": {
    "AuthCallbackURL": "http://8.xxx.xxx.xxx.xxx/xxx",
    "AuthProviders": [
      ""
    ],
    "SupabaseClusterId": "pa-**************"
  },
  "PolarFSInstanceId": "pfs-**************",
  "RegionId": "cn-beijing",
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "SecurityGroups": [
    {
      "NetType": "vpc",
      "RegionId": "cn-beijing",
      "SecurityGroupId": "sg-**************",
      "SecurityGroupName": "MyGroupName"
    }
  ],
  "SecurityIPArrays": [
    {
      "SecurityIPArrayName": "default",
      "SecurityIPArrayTag": "mytag",
      "SecurityIPList": "127.0.0.1",
      "SecurityIPNetType": "mix",
      "SecurityIPType": "ipv4"
    }
  ],
  "ServerlessType": "2",
  "SnatStatus": "off",
  "Status": "Activated",
  "Storages": [
    {
      "StorageCapacity": "20Gi",
      "StorageInstanceId": "pa-**************",
      "StoragePerformanceLevel": "PL0",
      "StorageType": "essd"
    }
  ],
  "UpgradeAvailable": "false",
  "VPCId": "vpc-*******************",
  "VSwitchId": "vsw-*******************",
  "Version": "1.0.0",
  "VpcNatGatewayId": "ngw-xxx",
  "ZoneId": "cn-beijing-l"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：CreateApplication - 创建PolarDB应用下一篇：DescribeApplicationParameters - 获取PolarDB应用组件参数