すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeDBClusters

    ドキュメントセンター

    AnalyticDB:DescribeDBClusters

    最終更新日:Mar 20, 2026

    Data Lakehouse Edition クラスターの一覧を取得します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    adb:DescribeDBClusters

    get

    DBCluster

    acs:adb:{#regionId}:{#accountId}:dbcluster/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    説明

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

    cn-hangzhou
    DBClusterIds

    string

    任意

    クラスター ID。

    説明

    指定したリージョン内の任意のクラスター ID を指定できます。

    am-bp1r053byu48p****
    DBClusterDescription

    string

    任意

    クラスターの説明。

    • http:// または https:// で始まらないこと。

    • 長さは 2 文字以上、256 文字以下であること。

    test
    DBClusterStatus

    string

    任意

    クラスターのステータス。有効な値は以下のとおりです。

    • Preparing：準備中。

    • Creating：作成中。

    • Restoring：バックアップからの復元中。

    • Running：実行中。

    • Deleting：削除中。

    • ClassChanging：仕様のアップグレードまたはダウングレード中。

    • NetAddressCreating：ネットワークエンドポイントの作成中。

    • NetAddressDeleting：ネットワークエンドポイントの削除中。

    Running
    PageSize

    integer

    任意

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

    • 30（デフォルト）

    • 50

    • 100

    30
    PageNumber

    integer

    任意

    ページ番号。有効な値は、0 より大きく、整数型の最大値以下である整数です。デフォルト値：1。

    1
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-4690g37929XXXX
    Tag

    array<object>

    任意

    タグのリスト。

    object

    任意

    リスト内の項目の詳細情報。

    Key

    string

    任意

    タグキー。タグキーでクラスターをフィルターできます。最大 20 組のキーと値のペアを指定できます。Tag.N.Key および Tag.N.Value の N は、1 から始まる連続した一意の整数である必要があります。

    説明

    タグキーは最大 64 文字です。また、aliyun、acs:、http://、https:// で始まらないようにしてください。

    tag1
    Value

    string

    任意

    タグ値。タグ値でクラスターをフィルターできます。最大 20 組のキーと値のペアを指定できます。Tag.N.Key および Tag.N.Value の N は、1 から始まる連続した一意の整数である必要があります。

    説明

    タグ値は最大 64 文字です。また、aliyun、acs:、http://、https:// で始まらないようにしてください。

    test1
    DBVersion

    string

    任意

    データベースのバージョン。有効な値：3.0。

    3.0
    DBClusterVersion

    string

    任意

    クラスターバージョン

    • 3.0：Data Warehouse Edition。

    • 5.0（デフォルト）：Data Lakehouse Edition、Enterprise Edition、Basic Edition を含む。

    • All：Data Warehouse Edition、Data Lakehouse Edition、Enterprise Edition、Basic Edition を含むすべてのバージョン。

    3.0

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたリストの詳細情報。

    TotalCount

    integer

    合計エントリ数。

    1
    PageSize

    integer

    1 ページあたりに返されるエントリ数。

    30
    RequestId

    string

    リクエスト ID。

    D65A809F-34CE-4550-9BC1-0ED21ETG380
    PageNumber

    integer

    ページ番号。

    1
    Items

    object

    DBCluster

    array<object>

    クラスターのリスト。

    array<object>

    クラスター一覧の詳細情報。

    DtsJobId

    string

    DTS 同期タスク ID。このパラメーターは MySQL 分析インスタンスの場合のみ返されます。

    dtsb1578j90XXXX
    DBNodeCount

    integer

    ノードグループ数。

    1
    Expired

    string

    クラスターが期限切れかどうかを示します。有効な値は以下のとおりです。

    • true：期限切れ。

    • false：期限切れではない。

    false
    CreateTime

    string

    クラスターの作成時刻（協定世界時 (UTC)）。フォーマット：yyyy-MM-ddTHH:mm:ssZ。例：2021-04-01T09:50:18Z。

    2021-04-01T09:50:18Z
    PayType

    string

    支払い方法。有効な値は以下のとおりです。

    • Postpaid：従量課金。

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

    Postpaid
    DiskType

    string

    ディスクタイプ。有効な値は以下のとおりです。

    • local_ssd：ローカル SSD。

    • cloud：標準ストレージ。

    • cloud_ssd：標準 SSD。

    • cloud_efficiency：Ultra ディスク。

    • cloud_essd0：ESSD PL0。

    • cloud_essd：ESSD PL1。

    • cloud_essd2：ESSD PL2。

    • cloud_essd3：ESSD PL3。

    説明

    ESSD の詳細については、「ESSD の仕様」をご参照ください。

    cloud_essd
    Tags

    object

    Tag

    array<object>

    タグのリスト。

    object

    タグリストの詳細情報。

    Key

    string

    タグキー。

    説明

    クラスターにタグを追加するには、TagResources 操作を呼び出します。

    tag1
    Value

    string

    タグ値。

    test1
    Mode

    string

    クラスターモード。有効な値は以下のとおりです。

    • flexible：フレキシブルモード。

    • reserver：予約モード。

    説明

    flexible
    Port

    string

    ポート番号。デフォルト値：3306。

    3306
    LockMode

    string

    クラスターロックモード。有効な値は以下のとおりです。

    • Unlock：ロック解除済み。

    • ManualLock：手動ロック済み。

    • LockByExpiration：有効期限切れによるロック。

    • LockByRestoration：ロールバック前のロック。

    • LockByDiskQuota：ストレージ使用量がクォータの 90 % に達したためのロック。

    Unlock
    StorageResource

    string

    フレキシブルモードで読み書き操作に使用されるストレージリソース仕様。このリソースを増やすことで、クラスターの読み書き性能が向上します。

    8Core32GB
    ExecutorCount

    string

    フレキシブルモードでクラスターが使用する計算ノード数。

    1
    DBClusterId

    string

    クラスター ID。

    am-bp163885f8q21****
    ConnectionString

    string

    クラスターのパブリックエンドポイント。

    am-bp163885f8q21****.ads.aliyuncs.com
    RdsInstanceId

    string

    ソース ApsaraDB RDS インスタンス ID。このパラメーターは MySQL 分析インスタンスの場合のみ返されます。

    rm-bp11q28kvl688****
    DBClusterType

    string

    クラスタータイプ。有効な値は以下のとおりです。

    • Common：標準クラスター。

    • RDS_ANALYSIS：MySQL 分析インスタンス。

    Common
    CommodityCode

    string

    商品コード。固定値：ads。

    ads
    ExpireTime

    string

    クラスターの有効期限（協定世界時 (UTC)）。フォーマット：yyyy-MM-ddTHH:mm:ssZ。例：2999-09-08T16:00:00Z。

    説明

    • クラスターがサブスクリプション課金方式を使用している場合、このパラメーターは実際の有効期限を返します。

    • クラスターが従量課金方式を使用している場合、このパラメーターは固定値 2999-09-08T16:00:00Z を返します。

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

    integer

    クラスターのストレージ容量（GB 単位）。

    300
    DBNodeClass

    string

    ノードスペック。

    E8
    LockReason

    string

    クラスターがロックされた理由。

    説明

    このパラメーターは、クラスターがロックされている場合にのみ返されます。固定値：instance_expire。

    instance_expired
    VPCId

    string

    VPC（Virtual Private Cloud）ID。

    vpc-bp13h7uzhulpuxvnpXXXX
    RegionId

    string

    クラスターが配置されているリージョン ID。

    cn-hangzhou
    ComputeResource

    string

    フレキシブルモードでデータ処理に使用される計算リソース仕様。計算リソースを増やすことでクエリ速度が向上します。必要に応じて、これらのリソースをスケールアップまたはスケールダウンできます。

    8Core32GB
    ElasticIOResource

    integer

    Elastic IO Unit（EIU）。詳細については、「EIU の概要」をご参照ください。

    説明

    このパラメーターは、フレキシブルモードのクラスターの場合にのみ返されます。

    0
    VSwitchId

    string

    vSwitch ID。

    vsw-bp1syh8vvw8yech7nXXXX
    DBVersion

    string

    データベースのバージョン。サポートされるのは 3.0 のみです。

    3.0
    VPCCloudInstanceId

    string

    VPC インスタンス ID。

    am-bp163885f8q21****-controller
    DBClusterStatus

    string

    クラスターのステータス。詳細については、「ステートテーブル」をご参照ください。

    Running
    ResourceGroupId

    string

    リソースグループ ID。

    rg-acfmyiu4ekp****
    DBClusterNetworkType

    string

    クラスターのネットワークタイプ。サポートされるのは VPC のみです。

    vpc
    DBClusterDescription

    string

    クラスターの説明。

    adb_test
    ZoneId

    string

    クラスターが配置されているゾーン ID。

    cn-hangzhou-h
    Category

    string

    プロダクトエディション。有効な値は以下のとおりです。

    • BASIC：予約モードの Basic Edition。

    • CLUSTER：予約モードの Cluster Edition。

    • MIXED_STORAGE：フレキシブルモードの Cluster Edition（新規）。

    説明

    詳細については、「プロダクトエディション」をご参照ください。

    MIXED_STORAGE
    Engine

    string

    クラスターのエンジン。固定値：AnalyticDB。

    AnalyticDB
    InnerIp

    string

    パブリック IP アドレス。

    10.1.xx.xx
    InnerPort

    string

    ポート番号。

    3306
    TaskInfo

    object

    タスクの進行状況情報。

    Name

    string

    タスク名。

    analyticDBFlexibleScaleOut
    Status

    string

    タスクのステータス。有効な値は以下のとおりです。

    • NOT_RUN：実行待ち。

    • RUNNING：実行中。

    • SUCCEED：完了。

    RUNNING
    Progress

    string

    タスクの進捗率（% 単位）。

    10
    StepList

    object

    StepList

    array<object>

    タスクのステップ。

    object

    タスクのステップ。

    StepName

    string

    ステップ名。

    ApplyResource
    StepDesc

    string

    ステップの説明。

    Apply resource
    StepStatus

    string

    ステップのステータス。有効な値は以下のとおりです。

    • NOT_RUN：実行待ち。

    • RUNNING：実行中。

    • SUCCEED：完了。

    SUCCEED
    StepProgress

    string

    ステップの進捗率（% 単位）。

    50
    StartTime

    string

    ステップの開始時刻。フォーマット：YYYY-MM-DDThh:mm:ssZ。

    2024-03-10T09:28:34Z
    EndTime

    string

    ステップの終了時刻。フォーマット：YYYY-MM-DDThh:mm:ssZ。

    2024-03-10T10:28:34Z
    ProductVersion

    string

    プロダクトバージョン。有効な値は以下のとおりです。

    • BasicVersion：Basic Edition。

    • EnterpriseVersion：Enterprise Edition。

    EnterpriseVersion

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "DtsJobId": "dtsb1578j90XXXX",
        "DBNodeCount": 1,
        "Expired": "false",
        "CreateTime": "2021-04-01T09:50:18Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "8Core32GB",
        "ExecutorCount": "1",
        "DBClusterId": "am-bp163885f8q21****",
        "ConnectionString": "am-bp163885f8q21****.ads.aliyuncs.com",
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "DBClusterType": "Common",
        "CommodityCode": "ads",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBNodeStorage": 300,
        "DBNodeClass": "E8",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnpXXXX",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "8Core32GB",
        "ElasticIOResource": 0,
        "VSwitchId": "vsw-bp1syh8vvw8yech7nXXXX",
        "DBVersion": "3.0",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "vpc",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Category": "MIXED_STORAGE",
        "Engine": "AnalyticDB",
        "InnerIp": "10.1.xx.xx",
        "InnerPort": "3306",
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Apply resource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductVersion": "EnterpriseVersion"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError An error occurred while processing your request. An error occurred while processing your request.
    503 ServiceUnavailable An error occurred while processing your request. An error occurred while processing your request.

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

    変更履歴

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