すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeDBInstances

    ドキュメントセンター

    AnalyticDB:DescribeDBInstances

    最終更新日:Mar 30, 2026

    AnalyticDB for PostgreSQL インスタンスの一覧を取得します。

    操作説明

    使用方法

    この API は、指定されたリージョン内の AnalyticDB for PostgreSQL インスタンスの詳細（インスタンスタイプ、ネットワークタイプ、インスタンスステータスなど）を取得します。

    QPS 制限

    この API のデフォルト QPS 制限は、ユーザーあたり 1 秒あたり 1,000 リクエストです。この制限を超える呼び出しはスロットルされ、ビジネスに影響を与える可能性があります。API 呼び出しは計画的に行ってください。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    gpdb:DescribeDBInstances

    get

    *DBInstance

    acs:gpdb:{#regionId}:{#accountId}:dbinstance/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    インスタンスが配置されているリージョン ID です。

    説明

    利用可能なリージョン ID は、DescribeRegions 操作を呼び出して確認できます。

    cn-hangzhou
    DBInstanceDescription

    string

    任意

    インスタンスの説明です。

    gp-bp12ga6v69h86****
    InstanceNetworkType

    string

    任意

    インスタンスのネットワークタイプです。有効な値は次のとおりです。

    • VPC：VPC

    • Classic：クラシックネットワーク

    説明

    このパラメーターを省略した場合、すべてのネットワークタイプのインスタンスが返されます。

    VPC
    DBInstanceIds

    string

    任意

    インスタンス ID です。複数の ID を指定する場合は、カンマ (,) で区切ります。

    gp-bp12ga6v69h86****
    PageSize

    integer

    任意

    1 ページあたりに返されるエントリ数です。有効な値は次のとおりです。

    • 30

    • 50

    • 100

    デフォルト値：30

    50
    PageNumber

    integer

    任意

    ページ番号です。値は 0 より大きい整数である必要があります。デフォルト値：1

    1
    Tag

    array<object>

    任意

    インスタンスにアタッチされているタグです。

    object

    任意

    インスタンスにアタッチされているタグです。

    Key

    string

    任意

    タグキーです。

    test-key
    Value

    string

    任意

    タグ値です。

    test-value
    InstanceDeployTypes

    array

    任意

    このパラメーターは非推奨です。このパラメーターを指定しないでください。

    string

    任意

    このパラメーターは非推奨です。このパラメーターを指定しないでください。

    null
    DBInstanceStatuses

    array

    任意

    インスタンスのステータスです。

    string

    任意

    インスタンスのステータスです。複数のステータスを指定できます。複数のステータスを指定する場合は、カンマ (,) で区切ります。詳細については、「インスタンスステータス」をご参照ください。

    説明

    このパラメーターの値は小文字である必要があります。

    running
    DBInstanceCategories

    array

    任意

    インスタンスエディションです。複数のエディションを指定できます。複数のエディションを指定する場合は、カンマ (,) で区切ります。

    string

    任意

    インスタンスエディションです。複数のエディションを指定できます。複数のエディションを指定する場合は、カンマ (,) で区切ります。有効な値は次のとおりです。

    • basic：Basic Edition

    • highavailability：High-availability Edition

    • finance：Enterprise Edition

    basic,highavailability
    DBInstanceModes

    array

    任意

    インスタンスのリソースタイプです。複数のリソースタイプを指定できます。複数のリソースタイプを指定する場合は、カンマ (,) で区切ります。

    string

    任意

    インスタンスのリソースタイプです。複数のリソースタイプを指定できます。複数のリソースタイプを指定する場合は、カンマ (,) で区切ります。有効な値は次のとおりです。

    • serverless：サーバーレス

    • storageelastic：ストレージエラスティックモード

    • classic：ストレージリザーブドモード

    storageelastic,serverless
    ResourceGroupId

    string

    任意

    インスタンスが属するリソースグループの ID です。

    rg-bp67acfmxazb4p****
    VpcId

    string

    任意

    VPC ID です。このパラメーターを指定すると、特定の VPC 内のインスタンスをクエリできます。

    vpc-t4nqyp3tc5mx7vy6****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたデータです。

    Items

    object

    インスタンスのコレクションです。

    DBInstance

    array<object>

    インスタンスの詳細リストです。

    array<object>

    インスタンスの詳細です。

    ConnectionMode

    string

    このパラメーターは非推奨であり、返されません。

    アクセスモードをクエリするには、DescribeDBInstanceAttribute 操作を呼び出してください。

    null
    CreateTime

    string

    インスタンスの作成時刻です。時刻は UTC で表されます。

    2021-10-09T04:54:08Z
    DBInstanceCategory

    string

    インスタンスエディションです。有効な値は次のとおりです。

    • Basic：Basic Edition

    • HighAvailability：High-availability Edition

    • Finance：Enterprise Edition

    HighAvailability
    DBInstanceDescription

    string

    インスタンスの説明です。

    gp-bp12ga6v69h86****
    DBInstanceId

    string

    インスタンス ID です。

    gp-bp12ga6v69h86****
    DBInstanceMode

    string

    インスタンスモードです。有効な値は次のとおりです。

    • Serverless：サーバーレス

    • StorageElastic：ストレージエラスティックモード

    • Classic：ストレージリザーブドモード

    StorageElastic
    DBInstanceNetType

    string

    インスタンスのネットワークインターフェースタイプです。有効な値は次のとおりです。

    • 0：インターネット

    • 1：内部ネットワーク

    • 2：VPC

    2
    DBInstanceStatus

    string

    インスタンスステータスです。詳細については、「インスタンスステータス表」をご参照ください。

    Running
    Engine

    string

    データベースエンジンです。

    gpdb
    EngineVersion

    string

    データベースエンジンバージョンです。

    6.0
    ExpireTime

    string

    インスタンスの有効期限切れ時刻です。時刻は UTC で表されます。

    説明

    従量課金インスタンスの場合、有効期限切れ時刻は 2999-09-08T16:00:00Z です。

    2999-09-08T16:00:00Z
    InstanceDeployType

    string

    インスタンスのデプロイメントタイプです。有効な値は次のとおりです。

    • cluster：ストレージエラスティックモードまたはサーバーレス

    • replicaSet：ストレージリザーブドモード

    cluster
    InstanceNetworkType

    string

    インスタンスのネットワークタイプです。有効な値は次のとおりです。

    • Classic：クラシックネットワーク

    • VPC：VPC

    VPC
    LockMode

    string

    インスタンスのロックモードです。有効な値は次のとおりです。

    • Unlock：インスタンスはロックされていません。

    • ManualLock：インスタンスは手動でロックされています。

    • LockByExpiration：インスタンスは有効期限切れ後に自動的にロックされます。

    • LockByRestoration：インスタンスはロールバック前に自動的にロックされます。

    • LockByDiskQuota：インスタンスのストレージ容量がいっぱいになると自動的にロックされます。

    • LockReadInstanceByDiskQuota：読み取り専用インスタンスのストレージ容量がいっぱいになると自動的にロックされます。

    Unlock
    LockReason

    string

    インスタンスがロックされた理由です。有効な値は次のとおりです。

    • 0：インスタンスは正常に実行中です。

    • 1：インスタンスは手動でロックされています。

    • 2：インスタンスは有効期限切れ後に自動的にロックされます。

    • 3：インスタンスはロールバック前に自動的にロックされます。

    • 4：インスタンスのストレージ容量がいっぱいになると自動的にロックされます。

    説明

    ストレージリザーブドモードのインスタンスの場合、インスタンスがロックされていないときは、このパラメーターは空文字列を返します。

    0
    MasterNodeNum

    integer

    コーディネーターノードの数です。

    1
    PayType

    string

    インスタンスの課金方法です。有効な値は次のとおりです。

    • Postpaid：従量課金

    • Prepaid：サブスクリプション

    Postpaid
    ProdType

    string

    プロダクトタイプです。有効な値は次のとおりです。

    • standard：標準

    • cost-effective：コスト効率重視

    standard
    RegionId

    string

    リージョン ID です。

    cn-hangzhou
    ResourceGroupId

    string

    インスタンスが属するリソースグループの ID です。

    rg-bp67acfmxazb4p****
    SegNodeNum

    string

    セグメントノードの数です。

    4
    ServerlessMode

    string

    サーバーレスインスタンスのモードです。有効な値は次のとおりです。

    • Manual：手動スケジューリング

    • Auto：自動スケジューリング

    説明

    • このパラメーターは、サーバーレスインスタンスの場合にのみ返されます。

    • AnalyticDB for PostgreSQL サーバーレスの自動スケジューリング機能は、現在招待制プレビューです。この機能を使用するには、チケットを送信してアクセス権をリクエストしてください。

    Manual
    StorageSize

    string

    インスタンスのストレージ容量 (単位：GB) です。

    50
    StorageType

    string

    インスタンスのストレージタイプです。有効な値は次のとおりです。

    • cloud_essd：ESSD

    • cloud_efficiency：Ultra Disk

    cloud_essd
    Tags

    object

    インスタンスにアタッチされているタグです。

    Tag

    array<object>

    タグの配列です。

    object

    タグの詳細です。

    Key

    string

    タグキーです。

    test-key
    Value

    string

    タグ値です。

    test-value
    VSwitchId

    string

    vSwitch ID です。

    vsw-bp1cpq8mr64paltkb****
    VpcId

    string

    VPC ID です。

    vpc-bp19ame5m1r3oejns****
    ZoneId

    string

    ゾーン ID です。

    cn-hangzhou-h
    PageNumber

    integer

    ページ番号です。

    1
    PageRecordCount

    integer

    現在のページに返されたエントリ数です。

    1
    RequestId

    string

    リクエスト ID です。

    53EA07B7-FC2A-521B-AB7C-27**********
    TotalRecordCount

    integer

    エントリの総数です。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "Items": {
    "DBInstance": [
      {
        "ConnectionMode": "null",
        "CreateTime": "2021-10-09T04:54:08Z",
        "DBInstanceCategory": "HighAvailability",
        "DBInstanceDescription": "gp-bp12ga6v69h86****",
        "DBInstanceId": "gp-bp12ga6v69h86****",
        "DBInstanceMode": "StorageElastic",
        "DBInstanceNetType": "2",
        "DBInstanceStatus": "Running",
        "Engine": "gpdb",
        "EngineVersion": "6.0",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "InstanceDeployType": "cluster",
        "InstanceNetworkType": "VPC",
        "LockMode": "Unlock",
        "LockReason": "0",
        "MasterNodeNum": 1,
        "PayType": "Postpaid",
        "ProdType": "standard",
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "SegNodeNum": "4",
        "ServerlessMode": "Manual",
        "StorageSize": "50",
        "StorageType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "test-key",
              "Value": "test-value"
            }
          ]
        },
        "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
        "VpcId": "vpc-bp19ame5m1r3oejns****",
        "ZoneId": "cn-hangzhou-h"
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 1,
  "RequestId": "53EA07B7-FC2A-521B-AB7C-27**********",
  "TotalRecordCount": 1
}

    エラーコード

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

    変更履歴

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