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

DescribeApplicationAttribute - 查询PolarDB应用属性

更新时间：
产品详情
我的收藏

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

接口说明

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

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeApplicationAttribute

get

*全部资源

*

 无 无

请求语法

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

x86
Description

string

应用备注

myapp
SecurityGroups

array<object>

应用级别的安全组列表

object

应用级别的安全组

SecurityGroupName

string

安全组名称

MyGroupName
SecurityGroupId

string

安全组 ID

sg-**************
RegionId

string

地域 ID

cn-beijing
NetType

string

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

  • vpc

vpc
SecurityIPArrays

array<object>

应用级别的白名单列表

object

应用级别的白名单

SecurityIPArrayTag

string

IP 地址组的标签

mytag
SecurityIPType

string

IP 地址的类型

ipv4
SecurityIPList

string

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

127.0.0.1
SecurityIPArrayName

string

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

default
SecurityIPNetType

string

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

mix
Status

string

应用状态，取值范围

  • Creating: 创建中

  • Activated: 运行中

  • Maintaining: 维护中

  • ClassChanging: 变更配置中

  • Transing: 迁移中

  • MinorVersionUpgrading: 小版本升级中

  • NetCreating: 访问地址创建中

  • NetDeleting: 访问地址删除中

  • NetModifying: 访问地址修改中

  • Restarting: 重启中

  • Locking: 锁定中

  • Locked: 已锁定

  • Unlocking: 解锁中

  • Deleting: 删除中

Activated
LockMode

string

锁定模式，取值范围：

  • Unlock: 未锁定

  • Lock: 已锁定

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>

子组件列表

object

子组件信息

Status

string

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

Activated
SecurityGroups

array<object>

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

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

object

子组件级别的安全组

SecurityGroupName

string

安全组名称

MyGroupName
SecurityGroupId

string

安全组 ID

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

RegionId

string

地域 ID

cn-beijing
NetType

string

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

  • vpc

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

default
SecurityIPNetType

string

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

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
EndpointId

string

连接地址的 Endpoint ID

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

string

IP 地址

172.31.95.252
Port

string

端口

8080
NetType

string

连接地址类型

  • Private: VPC 地址

  • Public: 公网地址

Private
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-**************

示例

正常返回示例

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",
      "EndpointId": "pa-**************",
      "IP": "172.31.95.252",
      "Port": "8080",
      "NetType": "Private"
    }
  ],
  "CreationTime": "2025-03-25T09:37:10Z",
  "ExpireTime": "2025-06-25T09:37:10Z",
  "RegionId": "cn-beijing",
  "ZoneId": "cn-beijing-l",
  "PolarFSInstanceId": "pfs-**************"
}

错误码

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

变更历史

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

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