すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeElasticPlans

    ドキュメントセンター

    AnalyticDB:DescribeElasticPlans

    最終更新日:Mar 17, 2026

    AnalyticDB for MySQL クラスターのスケーリングプランをクエリします。

    操作説明

    AnalyticDB for MySQL のエンドポイントについては、「エンドポイント」をご参照ください。

    今すぐお試しください

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

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ElasticPlanName

    string

    任意

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

    説明

    このパラメーターを指定しない場合、すべてのスケーリングプランがクエリされます。

    test
    ResourceGroupName

    string

    任意

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

    説明

    • このパラメーターを指定しない場合、インタラクティブなリソースグループタイプとエラスティック I/O ユニット (EIU) タイプを含む、すべてのリソースグループのスケーリングプランがクエリされます。

    • DescribeDBResourceGroup 操作を呼び出して、クラスター内のリソースグループの名前をクエリできます。

    test
    Enabled

    boolean

    任意

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

    • true

    • false

    true
    PageSize

    integer

    必須

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

    10
    PageNumber

    integer

    必須

    ページ番号。

    1
    DBClusterId

    string

    必須

    クラスター ID。

    説明

    DescribeDBClusters 操作を呼び出して、リージョン内のすべての AnalyticDB for MySQL クラスターの ID をクエリできます。

    amv-wz9509beptiz****
    Type

    string

    任意

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

    • EXECUTOR：コンピューティングリソースタイプを指定するインタラクティブなリソースグループタイプ。

    • WORKER：EIU タイプ。

    EXECUTOR

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PaginationResponse<List>

    TotalCount

    integer

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

    15
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

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

    10
    ElasticPlans

    array<object>

    クエリされたスケーリングプラン。

    object

    クエリされたスケーリングプラン。

    ElasticPlanName

    string

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

    test
    Type

    string

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

    • EXECUTOR：コンピューティングリソースタイプを指定するインタラクティブなリソースグループタイプ。

    • WORKER：EIU タイプ。

    EXECUTOR
    Enabled

    boolean

    プラン作成後すぐにスケーリングプランが有効になるかどうかを示します。 有効な値：

    • true

    • false

    true
    ResourceGroupName

    string

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

    説明

    DescribeDBResourceGroup 操作を呼び出して、クラスター内のリソースグループの名前をクエリできます。

    test
    TargetSize

    string

    スケーリング後のエラスティックリソースの量。

    32ACU
    NextScheduleTime

    string

    次のスケジューリングが実行される時間。

    説明

    時間は yyyy-MM-ddTHH:mm:ssZ フォーマットです。

    2022-01-01T12:01:00Z
    AutoScale

    boolean

    「EIU の比例デフォルトスケーリング」が有効になっているかどうかを示します。 有効な値：

    • true

    • false

    false
    RequestId

    string

    リクエスト ID。

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

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 15,
  "PageNumber": 1,
  "PageSize": 10,
  "ElasticPlans": [
    {
      "ElasticPlanName": "test",
      "Type": "EXECUTOR",
      "Enabled": true,
      "ResourceGroupName": "test",
      "TargetSize": "32ACU",
      "NextScheduleTime": "2022-01-01T12:01:00Z",
      "AutoScale": false
    }
  ],
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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