All Products
Search

This Product

    PolarDB:DescribeApplicationAttribute

    Document Center

    PolarDB:DescribeApplicationAttribute

    Last Updated:Jun 10, 2026

    Mengambil detail aplikasi tertentu di Instans PolarDB Basis Data Relasional Cloud-Native.

    Deskripsi operasi

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

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:DescribeApplicationAttribute

    get

    *全部资源

    *

    		 None None

    Sintaks permintaan

    POST  HTTP/1.1

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ApplicationId

    string

    Yes

    ID aplikasi.

    pa-**************

    Elemen respons

    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 instance 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 application-level security groups.

    object

    An application-level security group.

    SecurityGroupName

    string

    The security group name.

    MyGroupName
    SecurityGroupId

    string

    The security group ID.

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

    string

    The region ID.

    cn-beijing
    NetType

    string

    The network type. The value is:

    • vpc

    vpc
    SecurityIPArrays

    array<object>

    The application-level whitelists.

    object

    An application-level whitelist.

    SecurityIPArrayTag

    string

    The tag of the IP address group.

    mytag
    SecurityIPType

    string

    The IP address type.

    ipv4
    SecurityIPList

    string

    The whitelisted IP addresses, separated by commas.

    127.0.0.1
    SecurityIPArrayName

    string

    The name of the IP address group. The default value is default.

    default
    SecurityIPNetType

    string

    The network type of the whitelisted IP addresses. The default 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 being maintained.

    • ClassChanging: The application configuration is 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 restarting.

    • 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 maintenance start time.

    18:00Z
    MaintainEndTime

    string

    The maintenance end time.

    19:00Z
    PayType

    string

    The billing method.

    Postpaid
    Expired

    boolean

    Indicates whether the application has expired.

    false
    VPCId

    string

    The VPC ID.

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

    string

    The VSwitch ID.

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

    array<object>

    The child components.

    array<object>

    Information about a child component.

    Status

    string

    The component status. The valid values are the same as those for the application status.

    Activated
    SecurityGroups

    array<object>

    The component-level security groups.

    This parameter is not returned if the component-level security groups are the same as the application-level security groups.

    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 of the child component.

    Parents

    array

    A list of parent nodes for the component, identified by their IDs or component types.

    string

    The ID or component type of a parent node.

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

    array

    A list of child nodes for the component, identified by their IDs or component types.

    string

    The ID or component type of a child node.

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

    string

    The level of the component in the topology.

    0
    SecurityIPArrays

    array<object>

    The component-level whitelists.

    This parameter is not returned 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. Default value: default.

    default
    SecurityIPNetType

    string

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

    mix
    ComponentClassDescription

    string

    The description of the child component's class.

    2C4GB
    ComponentId

    string

    The child component ID.

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

    string

    The class of the child component.

    polar.app.g2.medium
    ComponentReplica

    integer

    The number of replicas of the child component.

    1
    ComponentMaxReplica

    integer

    The maximum number of replicas for the child component.

    1
    ComponentReplicaGroupName

    string

    The group name of the child component replicas.

    default
    Endpoints

    array<object>

    The application endpoints.

    object

    An application endpoint.

    Description

    string

    The endpoint description.

    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: a VPC endpoint

    • Public: a public endpoint

    Private
    Storages

    array<object>

    The details of the storage resources.

    object

    A storage resource.

    StoragePerformanceLevel

    string

    The storage performance level.

    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.

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

    string

    The expiration time.

    This parameter is not returned for Postpaid instances.

    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 Cold Storage or PolarFS High-performance instance.

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

    string

    The Serverless type. Valid values:

    • 2: Agile

    • 3: Stable

    2
    MemApplicationAttribute

    object

    The attributes of the Mem0 application.

    GraphLlmModelName

    string

    qwen3-max
    LlmModelName

    string

    The name of the LLM model.

    qwen3-max

    EmbedderModelName

    string

    The name of the embedder model.

    text-embedding-v4

    RerankerModelName

    string

    The name of the reranker model.

    qwen3-rerank

    ProjectName

    string

    The project name. It corresponds to the database schema where project data is stored.

    test-project-name

    DbName

    string

    The database name.

    test-database-name

    UserName

    string

    The username.

    test-user

    PolarClawSaaSApplicationAttribute

    object

    The attributes of the PolarClaw SaaS application.

    AuthCallbackURL

    string

    The authentication callback URL.

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

    string

    The Supabase cluster ID.

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

    array

    The enabled authentication providers.

    string

    An authentication provider.

    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 application is the latest version.

    true
    NatGatewayId

    string

    pc-xxx
    SnatStatus

    string

    off
    CanDisableSnat

    boolean

    Contoh

    Respons sukses

    JSONformat

    {
  "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": "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"
  },
  "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
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.