DescribeApplications API Reference for PolarDB - PolarDB - Alibaba Cloud - PolarDB

Retrieves the list of applications for all PolarDB instances in a specified region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeApplications

get

*Application

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

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-beijing
ApplicationIds	string	No	The list of application IDs. If specified, only information about these applications is returned.	pa-**************
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100 Default value: 30.	30
PageNumber	integer	No	The page number. Default value: 1.	1
DBClusterId	string	No	The PolarDB instance ID. If specified, only application information related to this PolarDB instance is returned.	pc-**************
ApplicationTypes	string	No	The application engine filter.
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key.	testKey
Value	string	No	The tag value.	testValue

Response elements

Element	Type	Description	Example
	object	Schema of Response
Items	object
Applications	array<object>	The list of applications.
	array<object>	The application information.
ApplicationId	string	The application ID.	pa-**************
ApplicationType	string	The application type.	supabase
BranchId	string	The AgenticDB branch ID.	br-1db52a73dc8545f19a47a3f1d8
CreationTime	string	The creation time.	2025-03-25T09:37:10Z
DBClusterId	string	The instance ID of the associated PolarDB instance.	pc-xxxxxx
Description	string	The application description or remarks.	myapp
Endpoints	object
endpoint	array<object>	The list of application endpoints.
	object	The application endpoint.
IP	string	The IP address.	192.168.0.3
NetType	string	The endpoint type. Valid values: Private: VPC endpoint. Public: public endpoint.	Public
Port	string	The port.	8080
EngineVersion	string	The DPI engine version.	1.0.0
ExpireTime	string	The expiration time.	2025-06-25T09:37:10Z
Expired	string	Indicates whether the application has expired.	false
PayType	string	The billing type. This value is empty if the application is not billed.	Postpaid
PolarFSInstanceId	string	The ID of the PolarFS instance associated with the application.	pcs-**************
RegionId	string	The region.	cn-hangzhou
Status	string	The application status. Valid values: Creating: being created. Activated: running. Maintaining: under maintenance. ClassChanging: configuration being changed. Transing: being migrated. MinorVersionUpgrading: minor version being upgraded. NetCreating: endpoint being created. NetDeleting: endpoint being deleted. NetModifying: endpoint being modified. Restarting: being restarted. Locking: being locked. Locked: locked. Unlocking: being unlocked. Deleting: being deleted.	Activated
Tags	object
Tag	array<object>	The tags.
	object	The tags.
Key	string	The tag key.	testKey
Value	string	The tag value.	testValue
ZoneId	string	The zone.	cn-hangzhou-b
PageNumber	integer	The current page number.	1
PageRecordCount	integer	The number of entries on the current page.	1
RequestId	string	The request ID.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
TotalRecordCount	integer	The total number of entries.	1

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.