すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeElasticPlan

    ドキュメントセンター

    AnalyticDB:DescribeElasticPlan

    最終更新日:Feb 26, 2026

    AnalyticDB for MySQL クラスターのスケーリングプランを照会します。この操作は、Cluster Edition の弾力性モードの AnalyticDB for MySQL クラスターにのみ適用されます。

    操作説明

    この操作は、32 コア以上の Cluster Edition の弾力性モードの AnalyticDB for MySQL データウェアハウス版 (V3.0) クラスターでのみ呼び出すことができます。

    今すぐお試しください

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

    get

    DBCluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    AnalyticDB for MySQL データウェアハウス版 (V3.0) クラスターの ID。

    説明

    DescribeDBClusters 操作を呼び出すことで、リージョン内のすべての AnalyticDB for MySQL データウェアハウス版 (V3.0) クラスターの ID を照会できます。

    am-bp278jg9****
    ElasticPlanName

    string

    任意

    スケーリングプランの名前。

    • 名前の長さは 2～30 文字である必要があります。

    • 名前に使用できる文字は、英字、数字、アンダースコア (_) です。

    説明

    このパラメーターを指定しない場合、指定されたクラスターのすべてのスケーリングプランに関する情報が返されます。

    realtime
    ResourcePoolName

    string

    任意

    リソースグループの名前。

    説明

    DescribeDBResourceGroup 操作を呼び出して、リソースグループ名を照会できます。

    USER_DEFAULT
    ElasticPlanEnable

    boolean

    任意

    スケーリングプランを有効にするかどうかを指定します。有効な値：

    • true (デフォルト)

    • false

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    array<object>

    照会されたスケーリングプラン。

    object

    EndTime

    string

    スケーリングプランの復元時間。スケールアップ時間と復元時間の間隔は 24 時間を超えることはできません。時間は HH:mm:ss 形式です。

    10:00:00
    WeeklyRepeat

    string

    スケーリングプランが実行された曜日。有効な値：0～6。0 は日曜日、6 は土曜日を表します。複数の値はコンマ (,) で区切ります。

    3,4,5,6
    MonthlyRepeat

    string

    スケーリングプランが実行された日付。値は月の日付を表します。複数の値はコンマ (,) で区切ります。

    1,15,25
    StartTime

    string

    スケーリングプランのスケールアップ時間。時間は HH:mm:ss 形式です。

    08:00:00
    ResourcePoolName

    string

    リソースグループの名前。

    USER_DEFAULT
    StartDay

    string

    スケーリングプランの開始日。このパラメーターは、スケーリングプランの開始日が設定されている場合にのみ返されます。日付は yyyy-MM-dd 形式です。

    2022-12-02
    ElasticNodeNum

    integer

    スケーリングプランに関連するノードの数。

    • ElasticPlanType が worker に設定されている場合、0 または null が返されます。

    • ElasticPlanType が executorcombineworker または executor に設定されている場合、0 より大きい値が返されます。

    0
    Enable

    boolean

    スケーリングプランが有効かどうかを示します。有効な値：

    • true (デフォルト)

    • false

    true
    EndDay

    string

    スケーリングプランの終了日。このパラメーターは、スケーリングプランの終了日が設定されている場合にのみ返されます。日付は yyyy-MM-dd 形式です。

    2022-12-09
    PlanName

    string

    スケーリングプランの名前。

    realtime
    ElasticPlanType

    string

    スケーリングプランのタイプ。有効な値：

    • worker: 弾性 I/O リソースのみをスケールします。

    • executor: コンピューティングリソースのみをスケールします。

    • executorcombineworker (デフォルト): 弾性 I/O リソースとコンピューティングリソースの両方を比例してスケールします。

    worker
    ElasticPlanWorkerSpec

    string

    スケーリングプランによってスケールアップできるリソース仕様。有効な値：

    • 8 コア 64 GB (デフォルト)

    • 16 コア 64 GB

    • 32 コア 64 GB

    • 64 コア 128 GB

    • 12 コア 96 GB

    • 24 コア 96 GB

    • 52 コア 86 GB

    16 Core 64 GB

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "ElasticPlanList": [
    {
      "EndTime": "10:00:00",
      "WeeklyRepeat": "3,4,5,6",
      "MonthlyRepeat": "1,15,25",
      "StartTime": "08:00:00",
      "ResourcePoolName": "USER_DEFAULT",
      "StartDay": "2022-12-02",
      "ElasticNodeNum": 0,
      "Enable": true,
      "EndDay": "2022-12-09",
      "PlanName": "realtime",
      "ElasticPlanType": "worker",
      "ElasticPlanWorkerSpec": "16 Core 64 GB"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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