すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeApplicationAttribute

    ドキュメントセンター

    PolarDB:DescribeApplicationAttribute

    最終更新日:Sep 24, 2026

    指定された PolarDB インスタンスアプリケーションの詳細を取得します。

    操作説明

    この操作では、コンポーネントの詳細やエンドポイントなど、特定の PolarDB アプリケーションに関するすべての情報を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeApplicationAttribute

    get

    *Application。

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

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ApplicationId

    string

    必須

    アプリケーションの ID。

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

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

    string

    アプリケーションの ID。

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

    string

    アプリケーションが依存する PolarDB インスタンスのインスタンス ID。

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

    string

    CPU アーキテクチャ。有効な値:

    • x86

    x86
    Description

    string

    アプリケーションの説明。

    myapp
    SecurityGroups

    array<object>

    アプリケーションレベルのセキュリティグループのリスト。

    object

    アプリケーションレベルのセキュリティグループ。

    SecurityGroupName

    string

    セキュリティグループ名。

    MyGroupName
    SecurityGroupId

    string

    セキュリティグループ ID。

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

    string

    リージョン ID。

    cn-beijing
    NetType

    string

    ネットワークタイプ。有効な値:

    • vpc

    vpc
    SecurityIPArrays

    array<object>

    アプリケーションレベルのホワイトリストのリスト。

    object

    アプリケーションレベルのホワイトリスト。

    SecurityIPArrayTag

    string

    IP アドレスグループのタグ。

    mytag
    SecurityIPType

    string

    IP アドレスのタイプ。

    ipv4
    SecurityIPList

    string

    ホワイトリストに登録された IP アドレス。カンマ (,) で区切ります。

    127.0.0.1
    SecurityIPArrayName

    string

    IP アドレスグループ名。デフォルト値: default。

    デフォルト
    SecurityIPNetType

    string

    ホワイトリストに登録された IP アドレスのネットワークタイプ。デフォルト値: mix。

    mix
    Status

    string

    アプリケーションステータス。有効な値:

    • Creating: 作成中。

    • Activated: 実行中。

    • Maintaining: メンテナンス中。

    • ClassChanging: 構成の変更中。

    • Transing: 移行中。

    • MinorVersionUpgrading: マイナーバージョンのスペックアップ中。

    • NetCreating: エンドポイントの作成中。

    • NetDeleting: エンドポイントの削除中。

    • NetModifying: エンドポイントの変更中。

    • Restarting: 再起動中。

    • Locking: ロック中。

    • Locked: ロック済み。

    • Unlocking: ロック解除中。

    • Deleting: 削除中。

    Activated
    LockMode

    string

    ロックモード。有効な値:

    • Unlock: ロックなし。

    • Lock: ロック済み。

    Unlock
    ApplicationType

    string

    アプリケーションタイプ。

    supabase
    Version

    string

    アプリケーションバージョン。

    1.0.0
    UpgradeAvailable

    string

    スペックアップが利用可能かどうかを示します。

    false
    MaintainStartTime

    string

    メンテナンスウィンドウの開始時刻。

    時間は協定世界時 (UTC) の HH:mmZ フォーマットです。

    18:00Z
    MaintainEndTime

    string

    メンテナンスウィンドウの終了時刻。

    時間は協定世界時 (UTC) の HH:mmZ フォーマットです。

    19:00Z
    PayType

    string

    課金方法。

    Postpaid
    Expired

    boolean

    アプリケーションが期限切れかどうかを示します。

    false
    VPCId

    string

    VPC ID。

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

    string

    vSwitch ID。

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

    array<object>

    サブコンポーネントのリスト。

    array<object>

    サブコンポーネントのフォーマット情報。

    Status

    string

    コンポーネントのステータス。有効な値は、アプリケーションステータスの有効な値と同じです。

    Activated
    SecurityGroups

    array<object>

    サブコンポーネントレベルのセキュリティグループのリスト。

    サブコンポーネントレベルのセキュリティグループがアプリケーションレベルのセキュリティグループと同じ場合、このレスポンス要素は省略されます。

    object

    サブコンポーネントレベルのセキュリティグループ。

    SecurityGroupName

    string

    セキュリティグループ名。

    MyGroupName
    SecurityGroupId

    string

    セキュリティグループ ID。

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

    RegionId

    string

    リージョン ID。

    cn-beijing
    NetType

    string

    ネットワークタイプ。有効な値:

    • vpc

    vpc
    ComponentType

    string

    アプリケーションサブコンポーネントのタイプ。

    ゲートウェイ
    Topology

    object

    アプリケーションサブコンポーネントのトポロジーフォーマット情報。

    Parents

    array

    現在のアプリケーションサブコンポーネントのトポロジー親ノード ID または親ノードサブコンポーネントタイプのリスト。

    string

    現在のアプリケーションサブコンポーネントのトポロジー親ノード ID または親ノードサブコンポーネントタイプ。

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

    array

    現在のアプリケーションサブコンポーネントのトポロジー子ノード ID または子ノードサブコンポーネントタイプのリスト。

    string

    現在のアプリケーションサブコンポーネントのトポロジー子ノード ID または子ノードサブコンポーネントタイプ。

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

    string

    現在のアプリケーションサブコンポーネントのトポロジーレイヤー。

    0
    SecurityIPArrays

    array<object>

    サブコンポーネントレベルのホワイトリストアドレスのリスト。

    サブコンポーネントレベルのホワイトリストがアプリケーションレベルのホワイトリストと同じ場合、このレスポンス要素は省略されます。

    object

    サブコンポーネントレベルのホワイトリストアドレス。

    SecurityIPArrayTag

    string

    IP アドレスグループのタグ。

    mytag
    SecurityIPType

    string

    IP アドレスのタイプ。

    ipv4
    SecurityIPList

    string

    ホワイトリストに登録された IP アドレス。カンマ (,) で区切ります。

    127.0.0.1
    SecurityIPArrayName

    string

    IP アドレスグループ名。デフォルト値: default。

    デフォルト
    SecurityIPNetType

    string

    ホワイトリストに登録された IP アドレスのネットワークタイプ。デフォルト値: mix。

    mix
    ComponentClassDescription

    string

    アプリケーションサブコンポーネントのスペックの説明。

    2C4GB
    ComponentId

    string

    サブコンポーネント ID。

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

    string

    アプリケーションサブコンポーネントのスペック。

    polar.app.g2.medium
    ComponentReplica

    integer

    アプリケーションサブコンポーネントのレプリカ数。

    1
    ComponentMaxReplica

    integer

    アプリケーションサブコンポーネントのレプリカ数の最大値。

    1
    ComponentReplicaGroupName

    string

    アプリケーションサブコンポーネントのレプリカグループ名。

    デフォルト
    Endpoints

    array<object>

    アプリケーションのエンドポイントのリスト。

    object

    アプリケーションのエンドポイント。

    Description

    string

    エンドポイントの説明。

    マイエンドポイント
    PortDescription

    string

    ポートの説明。

    kong_http
    EndpointId

    string

    エンドポイント ID。

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

    string

    IP アドレス。

    172.31.95.252
    Port

    string

    ポート。

    8080
    NetType

    string

    エンドポイントタイプ。有効な値:

    • Private: VPC エンドポイント。

    • Public: パブリックエンドポイント。

    Private
    Domain

    string

    Storages

    array<object>

    ストレージリソースのフォーマット情報。

    object

    StoragePerformanceLevel

    string

    ストレージパフォーマンスレベル (PL)。

    PL0
    StorageInstanceId

    string

    ストレージインスタンス ID。

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

    string

    ストレージタイプ。

    essd
    StorageCapacity

    string

    ストレージ容量。

    20Gi
    CreationTime

    string

    作成時刻。

    時間は協定世界時 (UTC) の ISO 8601 フォーマット (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

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

    string

    有効期限の時刻。

    課金方法が従量課金の場合、この値は空です。

    時間は協定世界時 (UTC) の ISO 8601 フォーマット (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

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

    string

    リージョン ID。

    cn-beijing
    ZoneId

    string

    ゾーン ID。

    cn-beijing-l
    PolarFSInstanceId

    string

    PolarFS コールドストレージエディションまたはハイパフォーマンスエディションのインスタンス ID。

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

    string

    サーバーレスタイプ。有効な値:

    • 2: アジャイル。

    • 3: ステディ。

    2
    MemApplicationAttribute

    object

    Mem0 アプリケーションの属性。

    GraphLlmModelName

    string

    グラフ LLM モデルのサポート。

    qwen3-max
    LlmModelName

    string

    LLM モデル名。

    qwen3-max
    EmbedderModelName

    string

    埋め込みモデル名。

    text-embedding-v4
    RerankerModelName

    string

    リランカーモデル名。

    qwen3-rerank
    ProjectName

    string

    プロジェクト名。データベース内のプロジェクトデータを保存するスキーマに対応します。

    test-プロジェクト-name
    DbName

    string

    データベース名。

    test-データベース-name
    UserName

    string

    ユーザー名。

    test-user
    SessionStore

    object

    Mem0 のフルセッション情報ストレージ構成。

    Status

    string

    セッションストレージのステータス。有効な値: DISABLED、ENABLING、ENABLED、DISABLING。

    ENABLED
    DBClusterId

    string

    セッションストレージに使用される PolarDB クラスターの ID。このパラメーターは、ステータスが ENABLED の場合にのみ返されます。

    pc-xxx
    DBName

    string

    セッションデータベース名。このパラメーターは、ステータスが ENABLED の場合にのみ返されます。

    contextdb_example
    AccountMode

    string

    アカウントソース。有効な値: reuse_vector、existing。このパラメーターは、ステータスが ENABLED の場合にのみ返されます。

    existing
    PolarClawSaaSApplicationAttribute

    object

    PolarClaw SaaS アプリケーションの属性。

    AuthCallbackURL

    string

    認証コールバック URL。

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

    string

    Supabase クラスターの ID。

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

    array

    string

    MinorVersion

    string

    マイナーバージョン番号。

    v2026.3.13-1#20260320
    LatestVersion

    string

    最新バージョン番号。

    v2026.3.13-1#20260320
    IsLatestVersion

    boolean

    現在のバージョンが最新バージョンかどうかを示します。

    true
    NatGatewayId

    string

    NAT ゲートウェイの ID。

    pc-xxx
    SnatStatus

    string

    SNAT のステータス。有効な値: on、off。

    off
    CanDisableSnat

    boolean

    SNAT を無効にできるかどうかを示します。

    VpcNatGatewayId

    string

    NAT マッピングに使用されるお客様管理の VPC NAT ゲートウェイの ID。

    ngw-xxx
    NatMappingSnatIpAddress

    string

    NAT マッピング用に、アプリケーションが存在する vSwitch にバインドされた SNAT IP アドレス。これは、コントロールプレーンによって実時間で検出および返されるお客様管理の SNAT エントリです。このパラメーターは、インターネット NAT ゲートウェイの SNAT とは無関係です。

    10.64.0.20
    DnatMappings

    array<object>

    NAT マッピング用の DNAT マッピングエントリのリスト。

    object

    DNAT マッピングエントリ。

    PortName

    string

    ポート名。有効な値: webui、hermesagent、ダッシュボード、ssh。

    webui
    BackendPort

    integer

    バックエンドサービスポート。

    8787
    FrontPort

    integer

    フロントエンドポート。

    10001
    AccessAddress

    string

    NatIp:FrontPort フォーマットのアクセスアドレス。このアドレスは、オフィスネットワーク内で直接使用できます。

    10.64.0.10:10001
    EntryId

    string

    DNAT エントリの ID。

    fwd-xxx
    Status

    string

    エントリのステータス。

    Available

    例

    成功レスポンス

    JSONJSON

    {
  "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": "デフォルト",
      "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": "ゲートウェイ",
      "Topology": {
        "Parents": [
          "pac-**************"
        ],
        "Children": [
          "pac-**************"
        ],
        "Layer": "0"
      },
      "SecurityIPArrays": [
        {
          "SecurityIPArrayTag": "mytag",
          "SecurityIPType": "ipv4",
          "SecurityIPList": "127.0.0.1",
          "SecurityIPArrayName": "デフォルト",
          "SecurityIPNetType": "mix"
        }
      ],
      "ComponentClassDescription": "2C4GB",
      "ComponentId": "pac-*******************",
      "ComponentClass": "polar.app.g2.medium",
      "ComponentReplica": 1,
      "ComponentMaxReplica": 1,
      "ComponentReplicaGroupName": "デフォルト"
    }
  ],
  "Endpoints": [
    {
      "Description": "myエンドポイント",
      "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",
    "EmbedderModelName": "text-embedding-v4",
    "RerankerModelName": "qwen3-rerank",
    "ProjectName": "テストプロジェクト名",
    "DbName": "テストデータベース名",
    "UserName": "test-user",
    "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"
    }
  ]
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。