すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeDBClusters

    ドキュメントセンター

    AnalyticDB:DescribeDBClusters

    最終更新日:Apr 15, 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

    list

    *DBClusterLakeVersion

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    説明

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

    cn-hangzhou
    DBClusterIds

    string

    任意

    クラスター ID。

    このパラメーターを省略した場合、指定されたリージョン内のすべてのクラスターに関する情報が返されます。

    amv-bp1r053byu48p****
    DBClusterDescription

    string

    任意

    クラスターの説明。

    • http:// または https:// で始めることはできません。

    • 説明は 2～256 文字である必要があります。

    test
    DBClusterStatus

    string

    任意

    クラスターのステータス。有効な値：

    • Preparing：クラスターは準備中です。

    • Creating：クラスターは作成中です。

    • Running：クラスターは実行中です。

    • Deleting：クラスターは削除中です。

    • Restoring：クラスターはバックアップから復元中です。

    • ClassChanging：クラスターの仕様は変更中です。

    • NetAddressCreating：クラスターのネットワーク接続は作成中です。

    • NetAddressDeleting：クラスターのネットワーク接続は削除中です。

    • NetAddressModifying：クラスターのネットワーク接続は変更中です。

    Running
    PageSize

    integer

    任意

    各ページに返すエントリ数。有効な値：

    • 30 (デフォルト)

    • 50

    • 100

    30
    PageNumber

    integer

    任意

    ページ番号。値は正の整数である必要があります。デフォルト値：1。

    1
    ResourceGroupId

    string

    任意

    リソースグループの ID。このパラメーターを省略した場合、すべてのリソースグループ内のクラスターに関する情報が返されます。

    rg-4690g37929****
    Tag

    array<object>

    任意

    クラスターをフィルターするためのタグ。

    object

    任意

    クラスタータグに関する情報。

    Key

    string

    任意

    タグキー。

    tag1
    Value

    string

    任意

    タグ値。

    test1
    ProductVersion

    string

    任意

    製品バージョン。有効な値：

    • EnterpriseVersion：Enterprise Edition。

    • BasicVersion：Basic Edition。

    説明

    このパラメーターを省略した場合、すべての製品バージョンのクラスターが返されます。

    BasicVersion
    DBClusterVersion

    string

    任意

    クラスターバージョン。有効な値：

    • 3.0：データウェアハウス版。

    • 5.0 (デフォルト)：Lakehouse、Enterprise、Basic の各エディションが含まれます。

    • All：データウェアハウス、Lakehouse、Enterprise、Basic の各エディションを含むすべてのエディション。

    5.0

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    返されたエントリの総数。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。

    30
    RequestId

    string

    リクエスト ID。

    A5EDBA27-AF3E-5966-9503-FD1557E19167
    PageNumber

    integer

    ページ番号。

    1
    Items

    object

    DBCluster

    array<object>

    クラスターの詳細。

    array<object>

    クラスターの詳細。

    Expired

    string

    サブスクリプションクラスターの有効期限が切れているかどうかを示します。有効な値：

    • true：クラスターの有効期限が切れています。

    • false：クラスターの有効期限が切れていません。

    説明

    • サブスクリプションクラスターの有効期限が切れると、ロックされ、一定期間後にリリースされる場合があります。クラスターを更新することを推奨します。詳細については、「更新」をご参照ください。

    • このパラメーターは、従量課金クラスターには返されません。

    false
    CreateTime

    string

    クラスターの作成時刻。時刻は協定世界時 (UTC) で、yyyy-MM-ddTHH:mm:ssZ 形式です。

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

    string

    クラスターの課金方法。有効な値：

    • Postpaid：従量課金。

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

    Prepaid
    Mode

    string

    クラスターのモード。flexible の値は、クラスターが弾性モードであることを示します。

    flexible
    Port

    string

    クラスターのポート番号。

    3306
    LockMode

    string

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

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

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

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

    Unlock
    StorageResource

    string

    予約済みのストレージリソース量。AnalyticDB コンピューティングユニット (ACU) は、1 vCPU と 4 GB のメモリに相当します。ストレージリソースは、データの読み書き操作に使用されます。ストレージリソースを増やすと、クラスターの読み書き性能が向上します。

    24ACU
    DBClusterId

    string

    Data Lakehouse Edition クラスターの ID。

    amv-bp163885f8q21****
    ConnectionString

    string

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

    amv-bp163885f8q21****.ads.aliyuncs.com
    DBClusterType

    string

    クラスターのタイプ。Common の値は、通常クラスターであることを示します。

    Common
    CommodityCode

    string

    クラスターの商品コード。有効な値：

    • ads：従量課金クラスター。

    • ads_pre：サブスクリプションクラスター。

    ads_pre
    ExpireTime

    string

    クラスターの有効期限。時刻は協定世界時 (UTC) で、yyyy-MM-ddTHH:mm:ssZ 形式です。

    説明

    • クラスターがサブスクリプションの課金方法である場合、実際の有効期限が返されます。

    • クラスターが従量課金の課金方法である場合、値は返されません。

    2022-07-01T09:50:18Z
    LockReason

    string

    クラスターがロックされている理由。

    説明

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

    instance_expired
    VPCId

    string

    Virtual Private Cloud (VPC) ID。

    vpc-bp13h7uzhulpuxvnp****
    RegionId

    string

    クラスターが存在するリージョンの ID。

    cn-hangzhou
    ComputeResource

    string

    予約済みのコンピューティングリソース量。AnalyticDB コンピューティングユニット (ACU) は、1 vCPU と 4 GB のメモリに相当します。コンピューティングリソースは、データ計算に使用されます。コンピューティングリソースを増やすことで、クエリを高速化し、クラスターのパフォーマンスに基づいて弾力的にスケーリングできます。

    16ACU
    VSwitchId

    string

    vSwitch ID。

    vsw-bp1syh8vvw8yech7n****
    DBVersion

    string

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

    5.0
    DBClusterStatus

    string

    クラスターのステータス。有効な値：

    • Preparing：クラスターは準備中です。

    • Creating：クラスターは作成中です。

    • Running：クラスターは実行中です。

    • Deleting：クラスターは削除中です。

    • Restoring：クラスターはバックアップから復元中です。

    • ClassChanging：クラスターの仕様は変更中です。

    • NetAddressCreating：ネットワーク接続は作成中です。

    • NetAddressDeleting：ネットワーク接続は削除中です。

    • NetAddressModifying：ネットワーク接続は変更中です。

    Running
    ResourceGroupId

    string

    リソースグループの ID。

    rg-acfmyiu4ekp****
    DBClusterNetworkType

    string

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

    VPC
    DBClusterDescription

    string

    クラスターの説明。

    adb_test
    ZoneId

    string

    クラスターが存在するゾーンの ID。

    cn-hangzhou-h
    Engine

    string

    クラスターのデータベースエンジン。値は AnalyticDB に固定されています。

    AnalyticDB
    ReservedACU

    string

    残りの予約済みコンピューティングリソース量。ACU は 1 vCPU と 4 GB のメモリに相当します。

    32ACU
    Tags

    object

    Tag

    array<object>

    タグのリスト。

    object

    タグ。

    Key

    string

    タグキー。

    説明

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

    tag1
    Value

    string

    タグ値。

    test1
    Category

    string

    クラスターのエディション。このパラメーターは、Data Warehouse Edition のクラスターに対してのみ返されます。有効な値：

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

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

    • MIXED_STORAGE：弾性モードの Cluster Edition (新規)。

    説明

    クラスターのエディションの詳細については、「製品エディション」をご参照ください。

    MIXED_STORAGE
    InnerPort

    string

    クラスターの内部ポート。

    3306
    VPCCloudInstanceId

    string

    内部エンドポイント。

    am-bp163885f8q21****-controller
    InnerIp

    string

    クラスターの内部 IP アドレス。

    10.1.xx.xx
    DtsJobId

    string

    Data Transmission Service (DTS) 同期タスクの ID。このパラメーターは、MySQL 分析インスタンスに対してのみ返されます。

    dtsb1578j90XXXX
    ElasticIOResource

    integer

    Elastic IO Units (EIUs) の数。詳細については、「EIU の詳細」をご参照ください。

    説明

    このパラメーターは、弾性モードのクラスターに対してのみ返されます。

    2
    RdsInstanceId

    string

    ソース ApsaraDB RDS インスタンスの ID。このパラメーターは、MySQL 分析インスタンスに対してのみ返されます。

    rm-bp11q28kvl688****
    ExecutorCount

    string

    弾性モードクラスター内の計算ノード数。

    1
    DBNodeClass

    string

    ノード仕様。このパラメーターは、Data Warehouse Edition のクラスターに対してのみ返されます。

    E8
    DiskType

    string

    クラスターのディスクタイプ。有効な値：

    • local_ssd：ローカル SSD。

    • cloud：標準クラウドディスク。

    • cloud_ssd：SSD クラウドディスク。

    • cloud_efficiency：Ultra ディスク。

    • cloud_essd：PL1 ESSD。

    • cloud_essd2：PL2 ESSD。

    • cloud_essd3：PL3 ESSD。

    説明

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

    cloud_essd
    DBNodeStorage

    integer

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

    300
    DBNodeCount

    integer

    ノードグループの数。

    2
    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
    ProductForm

    string

    製品形態。有効な値：

    • LegacyForm：レガシー形態。

    • IntegrationForm：統合形態。

    IntegrationForm
    ProductVersion

    string

    製品バージョン。有効な値：

    • BasicVersion：Basic Edition。

    • EnterpriseVersion：Enterprise Edition。

    EnterpriseVersion
    ReservedNodeSize

    string

    単一の予約済みノードのリソース仕様。

    8ACU
    ReservedNodeCount

    integer

    予約済みリソースノードの数。

    1
    AINodeSpec

    string

    AI ノードの仕様。

    ADB.MLGrand.5
    AINodeNumber

    integer

    AI ノードの数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "A5EDBA27-AF3E-5966-9503-FD1557E19167",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "Expired": "false",
        "CreateTime": "2022-04-01T09:50:18Z",
        "PayType": "Prepaid",
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-bp163885f8q21****",
        "ConnectionString": "amv-bp163885f8q21****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-07-01T09:50:18Z",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnp****",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "16ACU",
        "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "32ACU",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Category": "MIXED_STORAGE",
        "InnerPort": "3306",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "InnerIp": "10.1.xx.xx",
        "DtsJobId": "dtsb1578j90XXXX",
        "ElasticIOResource": 2,
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "ExecutorCount": "1",
        "DBNodeClass": "E8",
        "DiskType": "cloud_essd",
        "DBNodeStorage": 300,
        "DBNodeCount": 2,
        "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"
              }
            ]
          }
        },
        "ProductForm": "IntegrationForm",
        "ProductVersion": "EnterpriseVersion",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 1,
        "AINodeSpec": "ADB.MLGrand.5",
        "AINodeNumber": 1
      }
    ]
  }
}

    エラーコード

    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.

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

    変更履歴

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