DescribeApplications查询PolarDB应用列表的API参考-云原生数据库 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-**************

返回参数

名称	类型	描述	示例值
	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>	应用列表
	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

示例

正常返回示例

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"
      }
    ]
  }
}

错误码

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

变更历史

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