All Products
Search

This Product

    PolarDB:DescribeApplicationAttribute

    Document Center

    PolarDB:DescribeApplicationAttribute

    Last Updated:Sep 24, 2026

    Retrieves the details of a specified PolarDB instance application.

    Operation description

    This operation queries all information about a specific PolarDB application, including but not limited to 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

    *Application

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

    		 None 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

    Schema of Response

    RequestId

    string

    The request ID.

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

    string

    The application ID.

    pa-**************
    DBClusterId

    string

    The instance ID of the PolarDB instance on which the application depends.

    pc-**************
    Architecture

    string

    The CPU architecture. Valid values:

    • x86

    x86
    Description

    string

    The description of the application.

    myapp
    SecurityGroups

    array<object>

    The list of security groups at the application level.

    object

    The security group at the application level.

    SecurityGroupName

    string

    The name of the security group.

    MyGroupName
    SecurityGroupId

    string

    The security group ID.

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

    string

    The region ID.

    cn-beijing
    NetType

    string

    The network type. Valid values:

    • vpc

    vpc
    SecurityIPArrays

    array<object>

    The list of whitelists at the application level.

    object

    The whitelist at the application level.

    SecurityIPArrayTag

    string

    The tag of the IP address group.

    mytag
    SecurityIPType

    string

    The type of the IP address.

    ipv4
    SecurityIPList

    string

    The whitelisted IP addresses, separated by commas (,).

    127.0.0.1
    SecurityIPArrayName

    string

    The name of the IP address group. Default value: default.

    default
    SecurityIPNetType

    string

    The network type of the whitelisted IP addresses. Default value: mix.

    mix
    Status

    string

    The application status. Valid values:

    • Creating: Being created.

    • Activated: Running.

    • Maintaining: Under maintenance.

    • ClassChanging: Configuration is being changed.

    • Transing: Being migrated.

    • MinorVersionUpgrading: Minor version is being upgraded.

    • NetCreating: Endpoint is being created.

    • NetDeleting: Endpoint is being deleted.

    • NetModifying: Endpoint is being modified.

    • Restarting: Being restarted.

    • Locking: Being locked.

    • Locked: Locked.

    • Unlocking: Being unlocked.

    • Deleting: Being deleted.

    Activated
    LockMode

    string

    The lock mode. Valid values:

    • Unlock: Not locked.

    • Lock: 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.

    The time is in UTC and in the HH:mmZ format.

    18:00Z
    MaintainEndTime

    string

    The end time of the maintenance window.

    The time is in UTC and in the HH:mmZ format.

    19:00Z
    PayType

    string

    The billing method.

    Postpaid
    Expired

    boolean

    Indicates whether the application has expired.

    false
    VPCId

    string

    VPC ID

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

    string

    VSwitch ID

    vsw-*******************
    Components

    array<object>

    The list of subcomponents.

    array<object>

    The subcomponent information.

    Status

    string

    The component status. Valid values are the same as those of the application status.

    Activated
    SecurityGroups

    array<object>

    The list of security groups at the subcomponent level.

    If the security groups at the subcomponent level are the same as those at the application level, this response element is omitted.

    object

    The security group at the subcomponent level.

    SecurityGroupName

    string

    The name of the security group.

    MyGroupName
    SecurityGroupId

    string

    The security group ID.

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

    RegionId

    string

    The region ID.

    cn-beijing
    NetType

    string

    The network type. Valid values:

    • vpc

    vpc
    ComponentType

    string

    The type of the application subcomponent.

    gateway
    Topology

    object

    The topology information of the application subcomponent.

    Parents

    array

    The list of topology parent node IDs or parent node subcomponent types of the current application subcomponent.

    string

    The topology parent node ID or parent node subcomponent type of the current application subcomponent.

    pac-**************
    Children

    array

    The list of topology child node IDs or child node subcomponent types of the current application subcomponent.

    string

    The topology child node ID or child node subcomponent type of the current application subcomponent.

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

    string

    The topology layer of the current application subcomponent.

    0
    SecurityIPArrays

    array<object>

    The list of whitelist addresses at the subcomponent level.

    If the whitelists at the subcomponent level are the same as those at the application level, this response element is omitted.

    object

    The whitelist address at the subcomponent level.

    SecurityIPArrayTag

    string

    The tag of the IP address group.

    mytag
    SecurityIPType

    string

    The type of the IP address.

    ipv4
    SecurityIPList

    string

    The whitelisted IP addresses, separated by commas (,).

    127.0.0.1
    SecurityIPArrayName

    string

    The name of the IP address group. Default value: default.

    default
    SecurityIPNetType

    string

    The network type of the whitelisted IP addresses. Default value: mix.

    mix
    ComponentClassDescription

    string

    The specification description of the application subcomponent.

    2C4GB
    ComponentId

    string

    The subcomponent ID.

    pac-*******************
    ComponentClass

    string

    The specification of the application subcomponent.

    polar.app.g2.medium
    ComponentReplica

    integer

    The number of replicas of the application subcomponent.

    1
    ComponentMaxReplica

    integer

    The maximum number of replicas of the application subcomponent.

    1
    ComponentReplicaGroupName

    string

    The group name of the replicas of the application subcomponent.

    default
    Endpoints

    array<object>

    The list of endpoints of the application.

    object

    The endpoint of the application.

    Description

    string

    The description of the endpoint.

    myendpoint
    PortDescription

    string

    The port description.

    kong_http
    EndpointId

    string

    The endpoint ID.

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

    string

    The IP address.

    172.31.95.252
    Port

    string

    The port.

    8080
    NetType

    string

    The endpoint type. Valid values:

    • Private: VPC endpoint.

    • Public: Public endpoint.

    Private
    Domain

    string

    Storages

    array<object>

    The storage resource information.

    object

    StoragePerformanceLevel

    string

    The storage performance level (PL).

    PL0
    StorageInstanceId

    string

    The storage instance ID.

    pa-**************
    StorageType

    string

    The storage type.

    essd
    StorageCapacity

    string

    The storage capacity.

    20Gi
    CreationTime

    string

    The creation time.

    The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).

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

    string

    The expiration time.

    This value is empty when the billing method is Postpaid.

    The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).

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

    string

    The region ID.

    cn-beijing
    ZoneId

    string

    The zone ID.

    cn-beijing-l
    PolarFSInstanceId

    string

    The instance ID of PolarFS Cold Storage Edition or High Performance Edition.

    pfs-**************
    ServerlessType

    string

    The serverless type. Valid values:

    • 2: agile.

    • 3: steady.

    2
    MemApplicationAttribute

    object

    The Mem0 application attributes.

    GraphLlmModelName

    string

    The graph LLM model support.

    qwen3-max
    LlmModelName

    string

    The LLM model name.

    qwen3-max

    EmbedderModelName

    string

    The embedder model name.

    text-embedding-v4

    RerankerModelName

    string

    The reranker model name.

    qwen3-rerank

    ProjectName

    string

    The project name, which corresponds to the schema that stores project data in the database.

    test-project-name

    DbName

    string

    The database name.

    test-database-name

    UserName

    string

    The username.

    test-user

    SessionStore

    object

    The Mem0 full session information storage configuration.

    Status

    string

    The session storage status. Valid values: DISABLED, ENABLING, ENABLED, and DISABLING.

    ENABLED
    DBClusterId

    string

    The PolarDB cluster ID used for session storage. This parameter is returned only when the status is ENABLED.

    pc-xxx
    DBName

    string

    The session database name. This parameter is returned only when the status is ENABLED.

    contextdb_example
    AccountMode

    string

    The account source. Valid values: reuse_vector and existing. This parameter is returned only when the status is ENABLED.

    existing
    PolarClawSaaSApplicationAttribute

    object

    The PolarClaw SaaS application attributes.

    AuthCallbackURL

    string

    The authentication callback URL.

    http://8.xxx.xxx.xxx.xxx/xxx
    SupabaseClusterId

    string

    The Supabase cluster ID.

    pa-**************
    AuthProviders

    array

    string

    MinorVersion

    string

    The minor version number.

    v2026.3.13-1#20260320
    LatestVersion

    string

    The latest version number.

    v2026.3.13-1#20260320
    IsLatestVersion

    boolean

    Indicates whether the current version is the latest version.

    true
    NatGatewayId

    string

    The NAT gateway ID.

    pc-xxx
    SnatStatus

    string

    The SNAT status. Valid values: on and off.

    off
    CanDisableSnat

    boolean

    Indicates whether SNAT can be disabled.

    VpcNatGatewayId

    string

    The customer-managed VPC NAT gateway ID used for NAT mapping.

    ngw-xxx
    NatMappingSnatIpAddress

    string

    The SNAT IP address bound to the vSwitch where the application resides for NAT mapping. This is a customer-managed SNAT entry that is discovered and returned by the control plane in real time. This parameter is not related to the SNAT of Internet NAT gateways.

    10.64.0.20
    DnatMappings

    array<object>

    The list of DNAT mapping entries for NAT mapping.

    object

    The DNAT mapping entry.

    PortName

    string

    The port name. Valid values: webui, hermesagent, dashboard, and ssh.

    webui
    BackendPort

    integer

    The backend service port.

    8787
    FrontPort

    integer

    The frontend port.

    10001
    AccessAddress

    string

    The access address in the format of NatIp:FrontPort. This address can be directly used within the office network.

    10.64.0.10:10001
    EntryId

    string

    The DNAT entry ID.

    fwd-xxx
    Status

    string

    The entry status.

    Available

    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",
      "Domain": ""
    }
  ],
  "Storages": [
    {
      "StoragePerformanceLevel": "PL0",
      "StorageInstanceId": "pa-**************",
      "StorageType": "essd",
      "StorageCapacity": "20Gi"
    }
  ],
  "CreationTime": "2025-03-25T09:37:10Z",
  "ExpireTime": "2025-06-25T09:37:10Z",
  "RegionId": "cn-beijing",
  "ZoneId": "cn-beijing-l",
  "PolarFSInstanceId": "pfs-**************",
  "ServerlessType": "2",
  "MemApplicationAttribute": {
    "GraphLlmModelName": "qwen3-max",
    "LlmModelName": "qwen3-max\n",
    "EmbedderModelName": "text-embedding-v4\n",
    "RerankerModelName": "qwen3-rerank\n",
    "ProjectName": " test-project-name\n",
    "DbName": "test-database-name\n",
    "UserName": "test-user\n",
    "SessionStore": {
      "Status": "ENABLED",
      "DBClusterId": "pc-xxx",
      "DBName": "contextdb_example",
      "AccountMode": "existing"
    }
  },
  "PolarClawSaaSApplicationAttribute": {
    "AuthCallbackURL": "http://8.xxx.xxx.xxx.xxx/xxx",
    "SupabaseClusterId": "pa-**************",
    "AuthProviders": [
      ""
    ]
  },
  "MinorVersion": "v2026.3.13-1#20260320",
  "LatestVersion": "v2026.3.13-1#20260320",
  "IsLatestVersion": true,
  "NatGatewayId": "pc-xxx",
  "SnatStatus": "off",
  "CanDisableSnat": false,
  "VpcNatGatewayId": "ngw-xxx",
  "NatMappingSnatIpAddress": "10.64.0.20",
  "DnatMappings": [
    {
      "PortName": "webui",
      "BackendPort": 8787,
      "FrontPort": 10001,
      "AccessAddress": "10.64.0.10:10001",
      "EntryId": "fwd-xxx",
      "Status": "Available"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.