すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeDBResourceGroup

    ドキュメントセンター

    AnalyticDB:DescribeDBResourceGroup

    最終更新日:Feb 26, 2026

    AnalyticDB for MySQL クラスターのリソースグループに関する情報をクエリします。

    操作説明

    この操作は、以下のエディションで利用できます。

    • Enterprise Edition。

    • Basic Edition。

    • Data Lakehouse Edition。

    • Data Warehouse Edition (エラスティックモード): 32 コア、128 GB 以上。

    今すぐお試しください

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

    get

    *DBCluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    AnalyticDB for MySQL Data Warehouse Edition (V3.0) クラスターの ID。

    説明

    DescribeDBClusters 操作を呼び出すことで、リージョン内のすべての AnalyticDB for MySQL Data Warehouse Edition (V3.0) クラスターの ID をクエリできます。

    am-bp1ub9grke1****
    GroupName

    string

    任意

    リソースグループ名。

    USER_DEFAULT

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    1AD222E9-E606-4A42-BF6D-8A4442913CEF
    GroupsInfo

    array<object>

    クエリされたリソースグループ。

    array<object>

    リソースグループ。

    GroupType

    string

    クエリ実行モード。有効な値は次のとおりです。

    • interactive (デフォルト)

    • batch

    • job

    interactive
    UpdateTime

    string

    リソースグループが更新された時間。

    2022-11-09 16:57:35.241
    GroupName

    string

    リソースグループ名。

    USER_DEFAULT
    MinComputeResource

    string

    予約済み計算リソースの最小量。単位: AnalyticDB 計算ユニット (ACU)。

    • GroupType の値が interactive の場合、16 ACU が返されます。

    • GroupType の値が job の場合、0 ACU が返されます。

    0ACU
    MaxComputeResource

    string

    予約済み計算リソースの最大量。これは、クラスターに割り当てられていないリソースの量を指します。単位: ACU。

    • GroupType の値が interactive の場合、クラスターに割り当てられていない予約済み計算リソースの量が 16 ACU の増分で返されます。

    • GroupType の値が job の場合、クラスターに割り当てられていない予約済み計算リソースの量が 8 ACU の増分で返されます。

    32ACU
    ClusterSizeResource

    string

    単一の計算クラスターのリソース仕様。単位: ACU。

    16ACU
    MinClusterCount

    integer

    リソースグループに必要な計算クラスターの最小数。最小値: 1。

    1
    MaxClusterCount

    integer

    リソースグループで許可される計算クラスターの最大数。最大値: 10。

    4
    RunningClusterCount

    integer

    リソースグループで実行中の計算クラスターの数。

    2
    ClusterMode

    string

    リソースグループの動作モード。有効な値は次のとおりです。

    • Disable (デフォルト)

    • AutoScale

    AutoScale
    ElasticMinComputeResource

    string

    エラスティックコンピューティングリソースの最小量。単位: ACU。

    16ACU
    CreateTime

    string

    リソースグループが作成された時間。

    2022-10-09 16:57:35.241
    GroupUsers

    string

    リソースグループに関連付けられているデータベースアカウント。複数のデータベースアカウントはカンマ (,) で区切られます。

    testb,testc
    NodeNum

    integer

    ノード数。各ノードは 16 コアと 64 GB のメモリを提供します。

    2
    GroupUserList

    array

    リソースグループに関連付けられているデータベースアカウント。

    string

    リソースグループに関連付けられているデータベースアカウント。

    user1
    Engine

    string

    リソースグループのエンジン。有効な値は次のとおりです。

    • AnalyticDB (デフォルト)

    • SparkWarehouse

    AnalyticDB
    EngineParams

    object

    リソースグループで実行されるすべての Spark ジョブに適用できる Spark アプリケーション構成パラメーター。特定の Spark ジョブのパラメーターを構成する場合は、ジョブを送信する際にコードエディタでパラメーターの値を指定できます。

    {\"spark.adb.version\":\"3.5\"}
    Status

    string

    リソースグループのステータス。有効な値は次のとおりです。

    • Pending

    • Running

    • Scaling

    • Deleting

    • Deleted

    Running
    ConnectionString

    string

    リソースグループのエンドポイント。

    説明

    このパラメーターは、Engine の値が SparkWarehouse の場合にのみ返されます。

    amv-bp1nw64y******.ads.aliyuncs.com
    Port

    string

    リソースグループのポート番号。

    説明

    このパラメーターは、Engine の値が SparkWarehouse の場合にのみ返されます。

    3306
    DBClusterId

    string

    クラスター ID。

    am-bp1ub9grke1****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "GroupsInfo": [
    {
      "GroupType": "interactive",
      "UpdateTime": "2022-11-09 16:57:35.241",
      "GroupName": "USER_DEFAULT",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "32ACU",
      "ClusterSizeResource": "16ACU",
      "MinClusterCount": 1,
      "MaxClusterCount": 4,
      "RunningClusterCount": 2,
      "ClusterMode": "AutoScale",
      "ElasticMinComputeResource": "16ACU",
      "CreateTime": "2022-10-09 16:57:35.241",
      "GroupUsers": "testb,testc",
      "NodeNum": 2,
      "GroupUserList": [
        "user1"
      ],
      "Engine": "AnalyticDB",
      "EngineParams": {
        "test": "test",
        "test2": 1
      },
      "Status": "Running",
      "ConnectionString": "amv-bp1nw64y******.ads.aliyuncs.com",
      "Port": "3306"
    }
  ],
  "DBClusterId": "am-bp1ub9grke1****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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