DescribeApplicationAttribute API Reference - PolarDB - Alibaba Cloud - PolarDB

Gets the details of a specified application on a PolarDB instance.

Operation description

Retrieves all information about a specific PolarDB application, including component details and endpoints.

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:DescribeApplicationAttribute

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	The application ID.	pa-**************

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
ApplicationId	string	The application ID.	pa-**************
DBClusterId	string	The ID of the PolarDB cluster that the application depends on.	pc-**************
Architecture	string	The CPU architecture. The value is: `x86`	x86
Description	string	The application description.	myapp
SecurityGroups	array<object>	The security groups for the application.
	object	A security group for the application.
SecurityGroupName	string	The name of the security group.	MyGroupName
SecurityGroupId	string	The ID of the security group.	sg-**************
RegionId	string	The region ID.	cn-beijing
NetType	string	The network type. The value is: vpc	vpc
SecurityIPArrays	array<object>	The whitelists for the application.
	object	An application-level whitelist.
SecurityIPArrayTag	string	The tag of the IP address group.	mytag
SecurityIPType	string	The type of the IP address.	ipv4
SecurityIPList	string	A comma-separated string of IP addresses in the whitelist.	127.0.0.1
SecurityIPArrayName	string	The name of the IP address group. By default, the value is `default`.	default
SecurityIPNetType	string	The network type of the IP addresses in the whitelist. By default, the value is `mix`.	mix
Status	string	The application status. Valid values: `Creating`: The application is being created. `Activated`: The application is running. `Maintaining`: The application is under maintenance. `ClassChanging`: The application specifications are being changed. `Transing`: The application is being migrated. `MinorVersionUpgrading`: The minor version of the application is being upgraded. `NetCreating`: The endpoint is being created. `NetDeleting`: The endpoint is being deleted. `NetModifying`: The endpoint is being modified. `Restarting`: The application is being restarted. `Locking`: The application is being locked. `Locked`: The application is locked. `Unlocking`: The application is being unlocked. `Deleting`: The application is being deleted.	Activated
LockMode	string	The lock mode. Valid values: `Unlock`: The application is not locked. `Lock`: The application is locked.	Unlock
ApplicationType	string	The application type.	supabase
Version	string	The application version.	1.0.0
UpgradeAvailable	string	Indicates whether an upgrade is available.	false
MaintainStartTime	string	The start time of the maintenance window.	18:00Z
MaintainEndTime	string	The end time of the maintenance window.	19:00Z
PayType	string	The billing method.	Postpaid
Expired	boolean	Indicates whether the application has expired.	false
VPCId	string	The ID of the VPC.	vpc-*******************
VSwitchId	string	The ID of the VSwitch.	vsw-*******************
Components	array<object>	The child components.
	array<object>	Information about a child component.
Status	string	The status of the component. The valid values are the same as those for the application status.	Activated
SecurityGroups	array<object>	The security groups for the component. This parameter is omitted if the component and application security groups are identical.
	object	A component-level security group.
SecurityGroupName	string	The name of the security group.	MyGroupName
SecurityGroupId	string	The ID of the security group.	sg-*******************
RegionId	string	The region ID.	cn-beijing
NetType	string	The network type. Valid value: vpc	vpc
ComponentType	string	The type of the child component.	gateway
Topology	object	The topology information of the child component.
Parents	array	The IDs or component types of the parent nodes for the child component in the topology.
	string	The ID or type of a parent node for the child component in the topology.	pac-**************
Children	array	The IDs or component types of the child nodes of the component in the topology.
	string	The ID or component type of a child node of the component in the topology.	pac-**************
Layer	string	The layer of the component in the topology.	0
SecurityIPArrays	array<object>	The whitelists for the component. This parameter is omitted if the component-level whitelists are the same as the application-level whitelists.
	object	A component-level whitelist.
SecurityIPArrayTag	string	The tag of the IP address group.	mytag
SecurityIPType	string	The type of the IP address.	ipv4
SecurityIPList	string	The IP addresses in the whitelist, separated by commas.	127.0.0.1
SecurityIPArrayName	string	The name of the IP address group. By default, the value is `default`.	default
SecurityIPNetType	string	The network type of the IP addresses in the whitelist. By default, the value is `mix`.	mix
ComponentClassDescription	string	The description of the component's specifications.	2C4GB
ComponentId	string	The ID of the component.	pac-*******************
ComponentClass	string	The specifications of the component.	polar.app.g2.medium
ComponentReplica	integer	The number of replicas for the component.	1
ComponentMaxReplica	integer	The maximum number of replicas for the component.	1
ComponentReplicaGroupName	string	The name of the replica group for the component.	default
Endpoints	array<object>	The application endpoints.
	object	An application endpoint.
Description	string	The description of the endpoint.	myendpoint
PortDescription	string	The port description.	kong_http
EndpointId	string	The ID of the endpoint.	pa-**************
IP	string	The IP address.	172.31.95.252
Port	string	The port number.	8080
NetType	string	The endpoint type. Valid values: `Private`: Indicates a VPC endpoint. `Public`: Indicates a public endpoint.	Private
Storages	array<object>
	object
StoragePerformanceLevel	string
StorageInstanceId	string
StorageType	string
StorageCapacity	string
CreationTime	string	The time when the application was created.	2025-03-25T09:37:10Z
ExpireTime	string	The time when the application expires. This parameter is returned as an empty string for pay-as-you-go applications.	2025-06-25T09:37:10Z
RegionId	string	The region ID.	cn-beijing
ZoneId	string	The zone ID.	cn-beijing-l
PolarFSInstanceId	string	The ID of the PolarFS instance.	pfs-**************
ServerlessType	string	The Serverless type. Valid values: `2`: Agile `3`: Stable	2
MemApplicationAttribute	object
LlmModelName	string
EmbedderModelName	string
RerankerModelName	string
ProjectName	string
DbName	string
UserName	string
PolarClawSaaSApplicationAttribute	object
AuthCallbackURL	string
MinorVersion	string
LatestVersion	string
IsLatestVersion	boolean

Examples

Success response

JSON format

{
  "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"
    }
  ],
  "Storages": [
    {
      "StoragePerformanceLevel": "",
      "StorageInstanceId": "",
      "StorageType": "",
      "StorageCapacity": ""
    }
  ],
  "CreationTime": "2025-03-25T09:37:10Z",
  "ExpireTime": "2025-06-25T09:37:10Z",
  "RegionId": "cn-beijing",
  "ZoneId": "cn-beijing-l",
  "PolarFSInstanceId": "pfs-**************",
  "ServerlessType": "2",
  "MemApplicationAttribute": {
    "LlmModelName": "",
    "EmbedderModelName": "",
    "RerankerModelName": "",
    "ProjectName": "",
    "DbName": "",
    "UserName": ""
  },
  "PolarClawSaaSApplicationAttribute": {
    "AuthCallbackURL": ""
  },
  "MinorVersion": "",
  "LatestVersion": "",
  "IsLatestVersion": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.