すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeApplicationAttribute

    ドキュメントセンター

    PolarDB:DescribeApplicationAttribute

    最終更新日:Jun 05, 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

    * 全リソース

    *

    		 なし なし

    リクエスト構文

    POST HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ApplicationId

    文字列

    必須

    アプリケーションを一意に識別する ID です。

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ。

    RequestId

    文字列

    リクエスト ID。

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

    文字列

    アプリケーション ID。

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

    文字列

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

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

    文字列

    CPU アーキテクチャ。値：

    • x86

    x86
    Description

    文字列

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

    myapp
    SecurityGroups

    配列<object>

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

    object

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

    SecurityGroupName

    文字列

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

    MyGroupName
    SecurityGroupId

    文字列

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

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

    文字列

    リージョン ID。

    cn-beijing
    NetType

    文字列

    ネットワークタイプ。値：

    • vpc

    vpc
    SecurityIPArrays

    配列<object>

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

    object

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

    SecurityIPArrayTag

    文字列

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

    mytag
    SecurityIPType

    文字列

    IP アドレスの種類。

    ipv4
    SecurityIPList

    文字列

    ホワイトリストに登録された IP アドレス。複数指定する場合はカンマで区切ります。

    127.0.0.1
    SecurityIPArrayName

    文字列

    IP アドレスグループの名前。デフォルト値は default です。

    default
    SecurityIPNetType

    文字列

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

    mix
    Status

    文字列

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

    • Creating ：アプリケーションを作成中です。

    • Activated ：アプリケーションが実行中です。

    • Maintaining ：アプリケーションをメンテナンス中です。

    • ClassChanging ：アプリケーションの構成を変更中です。

    • Transing ：アプリケーションを移行中です。

    • MinorVersionUpgrading ：アプリケーションのマイナーバージョンをアップグレード中です。

    • NetCreating ：エンドポイントを作成中です。

    • NetDeleting ：エンドポイントを削除中です。

    • NetModifying ：エンドポイントを変更中です。

    • Restarting ：アプリケーションを再起動中です。

    • Locking ：アプリケーションをロック中です。

    • Locked ：アプリケーションがロックされています。

    • Unlocking ：アプリケーションのロックを解除中です。

    • Deleting ：アプリケーションを削除中です。

    Activated
    LockMode

    文字列

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

    • Unlock ：アプリケーションはロックされていません。

    • Lock ：アプリケーションがロックされています。

    Unlock
    ApplicationType

    文字列

    アプリケーションの種類。

    supabase
    Version

    文字列

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

    1.0.0
    UpgradeAvailable

    ブール値

    アップグレードが利用可能かどうかを示します。

    false
    MaintainStartTime

    文字列

    メンテナンス開始時刻。

    18:00Z
    MaintainEndTime

    文字列

    メンテナンス終了時刻。

    19:00Z
    PayType

    文字列

    課金方法。

    Postpaid
    Expired

    ブール値

    アプリケーションの有効期限が切れているかを示します。

    false
    VPCId

    文字列

    VPC ID。

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

    文字列

    VSwitch ID。

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

    配列<object>

    子コンポーネント。

    object

    子コンポーネントに関する情報。

    Status

    文字列

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

    Activated
    SecurityGroups

    配列<object>

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

    コンポーネントレベルのセキュリティグループがアプリケーションレベルのセキュリティグループと同じ場合、このパラメータは返されません。

    object

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

    SecurityGroupName

    文字列

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

    MyGroupName
    SecurityGroupId

    文字列

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

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

    文字列

    リージョン ID。

    cn-beijing
    NetType

    文字列

    ネットワークタイプ。値：

    • vpc

    vpc
    ComponentType

    文字列

    子コンポーネントの種類。

    gateway
    Topology

    object

    子コンポーネントのトポロジー。

    Parents

    配列

    この子コンポーネントの親ノードの ID またはコンポーネントタイプ。

    文字列

    この子コンポーネントの親ノードの ID またはコンポーネントタイプ。

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

    配列

    この子コンポーネントの子ノードの ID またはコンポーネントタイプ。

    文字列

    この子コンポーネントの子ノードの ID またはコンポーネントタイプ。

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

    文字列

    子コンポーネントのトポロジーレイヤー。

    0
    SecurityIPArrays

    配列<object>

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

    コンポーネントレベルのホワイトリストがアプリケーションレベルのホワイトリストと同じ場合、このパラメータは返されません。

    object

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

    SecurityIPArrayTag

    文字列

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

    mytag
    SecurityIPType

    文字列

    IP アドレスの種類。

    ipv4
    SecurityIPList

    文字列

    ホワイトリストに登録された IP アドレス。複数指定する場合はカンマで区切ります。

    127.0.0.1
    SecurityIPArrayName

    文字列

    IP アドレスグループの名前。デフォルト値は default です。

    default
    SecurityIPNetType

    文字列

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

    mix
    ComponentClassDescription

    文字列

    子コンポーネントのクラスの説明。

    2C4GB
    ComponentId

    文字列

    子コンポーネント ID。

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

    文字列

    子コンポーネントのクラス。

    polar.app.g2.medium
    ComponentReplica

    integer

    子コンポーネントのレプリカ数。

    1
    ComponentMaxReplica

    integer

    子コンポーネントの最大レプリカ数。

    1
    ComponentReplicaGroupName

    文字列

    子コンポーネントのレプリカグループ名。

    default
    Endpoints

    配列<object>

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

    object

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

    Description

    文字列

    エンドポイントの説明。

    myendpoint
    PortDescription

    文字列

    ポートの説明。

    kong_http
    EndpointId

    文字列

    エンドポイント ID。

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

    文字列

    IP アドレス。

    172.31.95.252
    Port

    文字列

    ポート。

    8080
    NetType

    文字列

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

    • Private ： VPC エンドポイント

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

    Private
    Storages

    配列<object>

    ストレージリソースの詳細。

    object

    ストレージリソース。

    StoragePerformanceLevel

    文字列

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

    PL0
    StorageInstanceId

    文字列

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

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

    文字列

    ストレージタイプ。

    essd
    StorageCapacity

    文字列

    ストレージ容量。

    20Gi
    CreationTime

    文字列

    作成時刻。

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

    文字列

    有効期限。

    このパラメータは、従量課金インスタンスでは返されません。

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

    文字列

    リージョン ID。

    cn-beijing
    ZoneId

    文字列

    ゾーン ID。

    cn-beijing-l
    PolarFSInstanceId

    文字列

    PolarFS コールドストレージインスタンスまたは PolarFS 高パフォーマンスインスタンスの ID。

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

    文字列

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

    • 2 ： Agile

    • 3 ： Stable

    2
    MemApplicationAttribute

    object

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

    GraphLlmModelName

    文字列

    グラフ LLM モデルの名前。

    qwen3-max
    LlmModelName

    文字列

    LLM モデルの名前。

    qwen3-max
    EmbedderModelName

    文字列

    埋め込みモデルの名前。

    text-embedding-v4
    RerankerModelName

    文字列

    リランカーモデルの名前。

    qwen3-rerank
    ProjectName

    文字列

    プロジェクト名。プロジェクトデータが格納されるデータベーススキーマに対応します。

    test-project-name
    DbName

    文字列

    データベース名。

    test-database-name
    UserName

    文字列

    ユーザー名。

    test-user
    PolarClawSaaSApplicationAttribute

    object

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

    AuthCallbackURL

    文字列

    認証コールバック URL。

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

    文字列

    Supabase クラスター ID。

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

    配列

    有効な認証プロバイダー。

    文字列

    認証プロバイダー。

    MinorVersion

    文字列

    マイナーバージョン。

    v2026.3.13-1#20260320
    LatestVersion

    文字列

    最新バージョン。

    v2026.3.13-1#20260320
    IsLatestVersion

    ブール値

    アプリケーションが最新バージョンかを示します。

    true
    NatGatewayId

    文字列

    NAT ゲートウェイの ID。

    pc-xxx
    SnatStatus

    文字列

    SNAT ステータス。

    off
    CanDisableSnat

    ブール値

    SNAT を無効化できるかを示します。

    例

    成功レスポンス

    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": "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-*******************",
          "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",
    "EmbedderModelName": "text-embedding-v4",
    "RerankerModelName": "qwen3-rerank",
    "ProjectName": " test-project-name",
    "DbName": "test-database-name",
    "UserName": "test-user"
  },
  "PolarClawSaaSApplicationAttribute": {
    "AuthCallbackURL": "http://8.xxx.xxx.xxx.xxx/xxx",
    "SupabaseClusterId": "pa-**************",
    "AuthProviders": [
      ""
    ]
  },
  "MinorVersion": "v2025.3.13-1#20250320",
  "LatestVersion": "v2025.3.13-1#20250320",
  "IsLatestVersion": true,
  "NatGatewayId": "pc-xxx",
  "SnatStatus": "off",
  "CanDisableSnat": false
}

    エラーコード

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

    変更履歴

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