すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeDBClustersZonal

    ドキュメントセンター

    PolarDB:DescribeDBClustersZonal

    最終更新日:Oct 15, 2025

    MyBase 内の PolarDB クラスターを一覧表示します。

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエスト構文

    GET  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    DBClusterIds

    string

    任意

    クラスター ID。複数のクラスター ID を指定するには、コンマ (,) で区切ります。

    pc-****************
    DBClusterDescription

    string

    任意

    クラスターの説明。あいまい検索がサポートされています。

    pc-****************
    ConnectionString

    string

    任意

    データベースのエンドポイント。

    ********.rwlb.polardb-pg-public.rds.aliyuncs.com
    DBClusterStatus

    string

    任意

    クラスターのステータス。

    Running
    DBType

    string

    任意

    データベースのタイプ。有効な値:

    • MySQL

    • PostgreSQL

    • Oracle

    MySQL
    DescribeType

    string

    任意

    クエリモード。値を `Simple` に設定します。このモードでは、クラスターの基本的なメタデータのみが返されます。

    Simple
    DBVersion

    string

    任意

    データベースのバージョン。

    5.6
    RecentCreationInterval

    integer

    任意

    過去 N 日間に作成されたクラスターのフィルター。有効な値: 0～15。

    7
    RecentExpirationInterval

    integer

    任意

    N 日後に有効期限が切れるクラスターのフィルター。有効な値: 0～15。

    6
    Expired

    string

    任意

    クラスターの有効期限が切れているかどうかを指定します。有効な値:

    • true

    • false

    true
    PageSize

    integer

    任意

    各ページに返すエントリ数。有効な値: 30、50、100。

    デフォルト値: 30。

    30
    PageNumber

    integer

    任意

    ページ番号。値は 0 より大きく、Integer データの型の最大値を超えない整数である必要があります。デフォルト値: 1。

    10
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-**********
    Tag

    array<object>

    任意

    タグのリスト。

    object

    任意

    Value

    string

    任意

    タグキーの値。

    5.6
    Key

    string

    任意

    タグ `n` のキー。最大 20 個のタグを指定してクラスターをフィルターできます。`n` は 1 から始まる一意の連続した整数である必要があります。`Tag.n.Key` は `Tag.n.Value` に対応します。

    MySQL
    PayType

    string

    任意

    課金方法。有効な値:

    • Postpaid: 従量課金

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

    Postpaid
    DBNodeIds

    string

    任意

    ノード ID。複数のノード ID を指定できます。コンマ (,) で区切ります。

    pi-***************
    CloudProvider

    string

    任意

    クラウド サービス プロバイダー。

    AlibabaCloud
    MaxResults

    integer

    任意

    現在のリクエストで返されるエントリの最大数。デフォルト値: 10。

    10
    NextToken

    string

    任意

    結果の次のページを取得するために使用されるトークン。このパラメーターを、前の API 呼び出しから返された `NextToken` の値に設定します。最初の呼び出しでは、このパラメーターを指定する必要はありません。

    212db86sca4384811e0b5e8707e******

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    TotalRecordCount

    integer

    レコードの総数。

    16
    PageRecordCount

    integer

    現在のページのクラスター数。

    5
    RequestId

    string

    リクエスト ID。

    9B7BFB11-C077-4FE3-B051-F69CEB******
    PageNumber

    integer

    ページ番号。

    12
    Items

    array<object>

    クラスターのリスト。

    object

    Category

    string

    クラスターのエディション。次のエディションがサポートされています:

    • Normal: クラスター版

    • Basic: シングルノード

    • Archive: X-Engine

    • NormalMultimaster: マルチマスタークラスター (データベース/テーブル)

    Normal
    DBClusterId

    string

    クラスター ID。

    pc-****************
    DBType

    string

    データベースのタイプ。

    MySQL
    CentralControlRegionId

    string

    中央コントロールリージョンの ID。

    cn-beijing
    DBVersion

    string

    データベースのバージョン。

    5.6
    CloudProvider

    string

    クラウド サービス プロバイダー。

    ENS
    Tags

    array<object>

    タグのリスト。

    object

    Value

    string

    タグの値。

    5.6
    Key

    string

    タグキー。

    MySQL
    StorageType

    string

    Standard Edition クラスターのストレージタイプ。有効な値:

    • essdpl0

    • essdpl1

    • essdpl2

    • essdpl3

    • essdautopl

    essdautopl
    ZoneId

    string

    ゾーン ID。

    cn-hangzhou-i
    DBClusterStatus

    string

    クラスターのステータス。

    Running
    CreateTime

    string

    作成時間。

    2020-08-14T05:58:42Z
    DBClusterDescription

    string

    クラスターの説明。

    GDN-1
    Expired

    string

    クラスターの有効期限が切れているかどうかを示します。有効な値:

    • true

    • false

    false
    PayType

    string

    課金方法。有効な値:

    • Postpaid: 従量課金。

    • Prepaid: サブスクリプション。

    Prepaid
    LockMode

    string

    クラスターのロック状態。有効な値:

    • Unlock: 法線。

    • ManualLock: クラスターは手動でロックされます。

    • LockByExpiration: クラスターは有効期限が切れると自動的にロックされます。

    Unlock
    VswitchId

    string

    vSwitch ID。

    vsw-***************
    StrictConsistency

    string

    複数のゾーンにまたがるデータに対して強力な整合性が有効になっているかどうかを示します。有効な値:

    • ON: 強力な整合性が有効になっています。これは、3 つのゾーンにデプロイされている Standard Edition クラスターに適用されます。

    • OFF: 強力な整合性は有効になっていません。

    ON
    DBNodeClass

    string

    ノードの仕様。

    polar.mysql.g1.tiny.c
    StorageUsed

    integer

    クラスターの使用済みストレージ容量。単位: バイト。

    3009413120
    ENSRegionId

    string

    ENS リージョン ID。

    sg-singapore-9
    DBNodeNumber

    integer

    ノード数。

    2
    VpcId

    string

    VPC (virtual private cloud) の ID。

    vpc-****************
    StorageSpace

    integer

    インスタンスのストレージ容量。

    10
    ServerlessType

    string

    サーバーレスタイプ。`AgileServerless` は、クラスターがサーバーレスクラスターであることを示します。空の値は、クラスターが通常のクラスターであることを示します。

    AgileServerless
    AiType

    string

    AI ノードタイプ。有効な値:

    • SearchNode: 検索ノード

    • DLNode: AI ノード

    SearchNode
    CpuCores

    string

    CPU コアの数。

    1
    SubCategory

    string

    計算ノードの仕様タイプ。有効な値:

    • 排他的: 専用

    • General: 汎用

    Exclusive
    ExpireTime

    string

    クラスターの有効期限。

    説明

    このパラメーターは、Prepaid (サブスクリプション) クラスターに対してのみ返されます。Postpaid (従量課金) クラスターの場合、このパラメーターは空です。

    2022-09-14T16:00:00Z
    MaxResults

    integer

    現在のリクエストで返されるエントリの最大数。デフォルト値: 10。

    10
    NextToken

    string

    結果の次のページを取得するためのトークン。さらに結果がある場合、このパラメーターが返されます。次のページを取得するには、次のリクエストにこのトークンを含めます。すべての結果が返された場合、このパラメーターは返されません。

    212db86sca4384811e0b5e8707e******

    例

    成功レスポンス

    JSONJSON

    {
  "TotalRecordCount": 16,
  "PageRecordCount": 5,
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "PageNumber": 12,
  "Items": [
    {
      "Category": "Normal",
      "DBClusterId": "pc-****************",
      "DBType": "MySQL",
      "CentralControlRegionId": "cn-beijing",
      "DBVersion": "5.6",
      "CloudProvider": "ENS",
      "Tags": [
        {
          "Value": "5.6",
          "Key": "MySQL"
        }
      ],
      "StorageType": "essdautopl",
      "ZoneId": "cn-hangzhou-i",
      "DBClusterStatus": "Running",
      "CreateTime": "2020-08-14T05:58:42Z",
      "DBClusterDescription": "GDN-1",
      "Expired": "false",
      "PayType": "Prepaid",
      "LockMode": "Unlock",
      "VswitchId": "vsw-***************",
      "StrictConsistency": "ON",
      "DBNodeClass": "polar.mysql.g1.tiny.c",
      "StorageUsed": 3009413120,
      "ENSRegionId": "sg-singapore-9",
      "DBNodeNumber": 2,
      "VpcId": "vpc-****************",
      "StorageSpace": 10,
      "ServerlessType": "AgileServerless",
      "AiType": "SearchNode",
      "CpuCores": "1",
      "SubCategory": "Exclusive",
      "ExpireTime": "2022-09-14T16:00:00Z"
    }
  ],
  "MaxResults": 10,
  "NextToken": "212db86sca4384811e0b5e8707e******"
}

    エラーコード

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

    変更履歴

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