すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeApplications

    ドキュメントセンター

    PolarDB:DescribeApplications

    最終更新日:Sep 11, 2026

    指定されたリージョン内のすべての 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:DescribeApplications

    get

    *Application

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

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-beijing
    ApplicationIds

    string

    任意

    アプリケーション ID のリスト。指定した場合、これらのアプリケーションに関する情報のみが返されます。

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

    PageSize

    integer

    任意

    ページサイズ。有効な値:

    • 30

    • 50

    • 100

    デフォルト値: 30。

    30
    PageNumber

    integer

    任意

    ページ番号。デフォルト値: 1。

    1
    DBClusterId

    string

    任意

    PolarDB インスタンスの ID。指定した場合、この PolarDB インスタンスに関連するアプリケーション情報のみが返されます。

    pc-**************

    ApplicationTypes

    string

    任意

    アプリケーションエンジンフィルター。

    Tag

    array<object>

    任意

    タグ。

    object

    任意

    タグ。

    Key

    string

    任意

    タグキー。

    testKey
    Value

    string

    任意

    タグ値。

    testValue

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    Items

    object

    Applications

    array<object>

    アプリケーションのリスト。

    array<object>

    アプリケーション情報。

    ApplicationId

    string

    アプリケーションの ID。

    pa-**************
    ApplicationType

    string

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

    supabase
    BranchId

    string

    AgenticDB ブランチの ID。

    br-1db52a73dc8545f19a47a3f1d8
    CreationTime

    string

    作成時間。

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

    string

    関連付けられた PolarDB インスタンスの ID。

    pc-xxxxxx
    Description

    string

    アプリケーションの説明または備考。

    myapp
    Endpoints

    object

    endpoint

    array<object>

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

    object

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

    IP

    string

    IP アドレス。

    192.168.0.3
    NetType

    string

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

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

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

    Public
    Port

    string

    ポート。

    8080
    EngineVersion

    string

    DPI エンジンのバージョン。

    1.0.0
    ExpireTime

    string

    有効期限の時間。

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

    string

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

    false
    PayType

    string

    課金タイプ。アプリケーションが課金されていない場合、この値は空です。

    Postpaid
    PolarFSInstanceId

    string

    アプリケーションに関連付けられた PolarFS インスタンスの ID。

    pcs-**************
    RegionId

    string

    リージョン。

    cn-hangzhou
    Status

    string

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

    • Creating: 作成中。

    • Activated: 実行中。

    • Maintaining: メンテナンス中。

    • ClassChanging: 構成変更中。

    • Transing: 移行中。

    • MinorVersionUpgrading: マイナーバージョンアップグレード中。

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

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

    • NetModifying: エンドポイント変更済み。

    • Restarting: 再起動中。

    • Locking: ロック中。

    • Locked: ロック済み。

    • Unlocking: ロック解除中。

    • Deleting: 削除中。

    Activated
    Tags

    object

    Tag

    array<object>

    タグ。

    object

    タグ。

    Key

    string

    タグキー。

    testKey
    Value

    string

    タグ値。

    testValue
    ZoneId

    string

    ゾーン。

    cn-hangzhou-b
    PageNumber

    integer

    現在のページ番号。

    1
    PageRecordCount

    integer

    現在のページのエントリ数。

    1
    RequestId

    string

    リクエストの ID。

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

    integer

    エントリの総数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "Items": {
    "Applications": [
      {
        "ApplicationId": "pa-**************",
        "ApplicationType": "supabase",
        "BranchId": "br-1db52a73dc8545f19a47a3f1d8",
        "CreationTime": "2025-03-25T09:37:10Z",
        "DBClusterId": "pc-xxxxxx",
        "Description": "myapp",
        "Endpoints": {
          "endpoint": [
            {
              "IP": "192.168.0.3",
              "NetType": "Public",
              "Port": "8080"
            }
          ]
        },
        "EngineVersion": "1.0.0",
        "ExpireTime": "2025-06-25T09:37:10Z",
        "Expired": "false",
        "PayType": "Postpaid",
        "PolarFSInstanceId": "pcs-**************\n",
        "RegionId": "cn-hangzhou",
        "Status": "Activated",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValue"
            }
          ]
        },
        "ZoneId": "cn-hangzhou-b"
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 1,
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "TotalRecordCount": 1
}

    エラーコード

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

    変更履歴

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