すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeDBClusterAttribute

    ドキュメントセンター

    AnalyticDB:DescribeDBClusterAttribute

    最終更新日:Apr 07, 2026

    特定のクラスターの詳細を返します。

    操作説明

    このサービスの エンドポイント を確認するには、「エンドポイント」をご参照ください。

    今すぐお試しください

    この 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:DescribeDBClusterAttribute

    get

    *DBClusterLakeVersion

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    Data Lakehouse Edition クラスターの ID。

    説明

    DescribeDBClusters 操作を呼び出してクラスター ID を取得できます。

    amv-wz9509beptiz****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    A5C433C2-001F-58E3-99F5-3274C14DF8BD
    Items

    object

    DBCluster

    array<object>

    Data Lakehouse Edition クラスターに関する情報。

    array<object>

    クラスターの詳細。

    CreationTime

    string

    クラスターが作成された時刻。 時刻は yyyy-MM-ddThh:mm:ssZ フォーマットで、協定世界時 (UTC) で表示されます。

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

    string

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

    • true：クラスターは期限切れです。

    • false：クラスターは期限切れではありません。

    説明

    • クラスターが期限切れになると、一定期間後にクラスターはロックされるか、リリースされます。 クラスターを更新することを推奨します。 詳細については、「更新」をご参照ください。

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

    false
    MaintainTime

    string

    クラスターのメンテナンスウィンドウ。 時刻は HH:mmZ-HH:mmZ フォーマットで、協定世界時 (UTC) で表示されます。

    説明

    メンテナンスウィンドウの詳細については、「メンテナンスウィンドウの設定」をご参照ください。

    04:00Z-05:00Z
    PayType

    string

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

    • Postpaid：従量課金。

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

    Prepaid
    Tags

    object

    Tag

    array<object>

    タグのリスト。

    object

    Key

    string

    タグキー。

    説明

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

    tag1
    Value

    string

    タグ値。

    test1
    Mode

    string

    クラスターのモード。 デフォルト値は flexible で、これは弾性モードのクラスターを示します。

    flexible
    Port

    integer

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

    3306
    LockMode

    string

    クラスターのロックモード。 有効値：

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

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

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

    ManualLock
    EngineVersion

    string

    クラスターのエンジンバージョン。

    3.1.16
    StorageResource

    string

    予約済みのストレージリソース量です。これらのリソースはデータの読み書きに使用され、量を増やすことでクラスターの読み書き性能を向上させることができます。

    24ACU
    DBClusterId

    string

    Data Lakehouse Edition クラスターの ID。

    amv-wz9509beptiz****
    ConnectionString

    string

    クラスターの VPC エンドポイント。

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

    string

    クラスターのタイプ。 デフォルト値は Common で、これは通常のクラスターを示します。

    Common
    CommodityCode

    string

    クラスターの商品コードで、請求管理ページのクラスターコードと同じです。 有効値：

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

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

    ads_pre
    ExpireTime

    string

    クラスターの有効期限。

    • クラスターがサブスクリプションクラスターの場合、有効期限が返されます。

    • クラスターが従量課金クラスターの場合、空の文字列が返されます。

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

    string

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

    説明

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

    instance_expire
    VPCId

    string

    Virtual Private Cloud (VPC) ID。

    vpc-bp13h7uzhulpu****
    ComputeResource

    string

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

    16ACU
    RegionId

    string

    クラスターのリージョン ID。

    cn-hangzhou
    VSwitchId

    string

    vSwitch ID。

    vsw-uf629gydd54ld****
    DBVersion

    string

    AnalyticDB for MySQL クラスターのバージョン。 現在、バージョン 5.0 のみがサポートされています。

    5.0
    DBClusterStatus

    string

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

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

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

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

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

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

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

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

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

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

    Running
    ResourceGroupId

    string

    リソースグループ ID。

    rg-acfmyiu4ekp****
    DBClusterNetworkType

    string

    クラスターのネットワークタイプ。 VPC (Virtual Private Cloud) のみがサポートされています。

    VPC
    DBClusterDescription

    string

    クラスターの説明。

    adb_test
    UserENIStatus

    boolean

    Elastic Network Interface (ENI) が有効になっているかどうかを示します。 有効値：

    • true：ENI は有効です。

    • false：ENI は有効ではありません。

    false
    ZoneId

    string

    クラスターのゾーン ID。

    cn-hangzhou-h
    Engine

    string

    クラスターのデータベースエンジン。 値は常に AnalyticDB です。

    AnalyticDB
    ReservedACU

    string

    クラスター内で利用可能な予約済みコンピューティングリソースの量。

    24ACU
    ComputeResourceTotal

    string

    クラスター内のコンピューティングリソースの総量。

    48ACU
    StorageResourceTotal

    string

    クラスター内のストレージリソースの総量。

    24ACU
    SupportedFeatures

    object

    このパラメーターは将来の使用のために予約されています。

    string

    このパラメーターは将来の使用のために予約されています。

    预留参数，不涉及。
    ProductForm

    string

    このパラメーターは将来の使用のために予約されています。

    预留参数，不涉及。
    ReservedNodeSize

    string

    このパラメーターは将来の使用のために予約されています。

    预留参数，不涉及。
    ReservedNodeCount

    integer

    このパラメーターは将来の使用のために予約されています。

    预留参数，不涉及。
    ClickhouseEngineEnabled

    boolean

    ClickHouse ワイドテーブルエンジンが有効になっているかどうかを示します。

    • true：ClickHouse ワイドテーブルエンジンは有効です。

    • false：ClickHouse ワイドテーブルエンジンは有効ではありません。

    列挙値:

    • true :

      true

    • false :

      false

    true
    AINodeNumber

    integer

    AI ノードの数。

    3
    ProductVersion

    string

    クラスターのプロダクトバージョン。 有効値：

    • BasicVersion：Basic Edition。

    • EnterpriseVersion：Enterprise Edition。

    BasicVersion
    KmsId

    string

    ディスク暗号化に使用されるキー ID。

    説明

    このパラメーターは、AnalyticDB for MySQL クラスターでディスク暗号化が有効になっている場合にのみ返されます。

    e1935511-cf88-1123-a0f8-1be8d251****
    TaskInfo

    object

    タスク情報。

    Name

    string

    タスクの名前。

    ScaleUpDBCluster
    Status

    string

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

    • NOT_RUN：タスクは実行待機中です。

    • RUNNING：タスクは実行中です。

    • SUCCEED：タスクは完了しました。

    RUNNING
    Progress

    string

    タスクの進捗状況 (パーセンテージ)。

    10
    StepList

    object

    StepList

    array<object>

    タスクのステップ。

    object

    ステップの詳細。

    StepName

    string

    ステップの名前。

    PrepareResources
    StepDesc

    string

    ステップの説明。

    Prepare resources
    StepStatus

    string

    ステップのステータス。 有効値：

    • NOT_RUN：ステップは実行待機中です。

    • RUNNING：ステップは実行中です。

    • SUCCEED：ステップは完了しました。

    RUNNING
    StepProgress

    string

    ステップの進捗状況 (パーセンテージ)。

    50
    StartTime

    string

    ステップの開始時刻。 時刻は yyyy-MM-ddThh:mm:ssZ フォーマットで、協定世界時 (UTC) で表示されます。

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

    string

    ステップの終了時刻。 時刻は yyyy-MM-ddThh:mm:ssZ フォーマットで、協定世界時 (UTC) で表示されます。

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

    string

    ENI の VPC 情報。

    vpc-rj9hnedlfm645uj******
    UserENIVSwitchOptions

    string

    ENI の vSwitch ID。 複数の ID はコンマ (,) で区切られます。

    vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******
    UserENIZoneOptions

    string

    ENI のゾーン ID。 複数の ID はコンマ (,) で区切られます。

    cn-hangzhou-k,cn-hangzhou-h
    SecondaryZoneId

    string

    セカンダリゾーンの ID。

    cn-hangzhou-k
    SecondaryVSwitchId

    string

    セカンダリ vSwitch の ID。

    vsw-8vbl7kfaxxxxx
    DiskEncryption

    boolean

    ディスク暗号化が有効になっているかどうかを示します。 有効値：

    • true：ディスク暗号化は有効です。

    • false：ディスク暗号化は有効ではありません。

    false
    ClickhouseEngineCacheSize

    integer

    ClickHouse ワイドテーブルエンジンのキャッシュサイズ (GB)。 値 -1 は、ワイドテーブルエンジンが無効になっていることを示します。

    100
    AINodeSpec

    string

    AI ノードの仕様。

    ADB.MLGrand.5

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD",
  "Items": {
    "DBCluster": [
      {
        "CreationTime": "2022-07-01T09:50:18Z",
        "Expired": "false",
        "MaintainTime": "04:00Z-05:00Z",
        "PayType": "Prepaid",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": 3306,
        "LockMode": "ManualLock",
        "EngineVersion": "3.1.16",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-wz9509beptiz****",
        "ConnectionString": "amv-wz9509beptiz****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-10-01T09:50:18Z",
        "LockReason": "instance_expire",
        "VPCId": "vpc-bp13h7uzhulpu****",
        "ComputeResource": "16ACU",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-uf629gydd54ld****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "UserENIStatus": false,
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "24ACU",
        "ComputeResourceTotal": "48ACU",
        "StorageResourceTotal": "24ACU",
        "SupportedFeatures": {
          "key": "预留参数，不涉及。"
        },
        "ProductForm": "预留参数，不涉及。",
        "ReservedNodeSize": "预留参数，不涉及。",
        "ReservedNodeCount": 0,
        "ClickhouseEngineEnabled": true,
        "AINodeNumber": 3,
        "ProductVersion": "BasicVersion",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "TaskInfo": {
          "Name": "ScaleUpDBCluster",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "PrepareResources",
                "StepDesc": "Prepare resources",
                "StepStatus": "RUNNING",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "UserENIVpcId": "vpc-rj9hnedlfm645uj******",
        "UserENIVSwitchOptions": "vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******",
        "UserENIZoneOptions": "cn-hangzhou-k,cn-hangzhou-h",
        "SecondaryZoneId": "cn-hangzhou-k",
        "SecondaryVSwitchId": "vsw-8vbl7kfaxxxxx",
        "DiskEncryption": false,
        "ClickhouseEngineCacheSize": 100,
        "AINodeSpec": "ADB.MLGrand.5"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The DBClusterId provided does not exist in our records.

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

    変更履歴

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