全部產品
Search

搜尋本產品

    AnalyticDB：DescribeElasticPlan - 查詢彈性計劃

    文件中心

    AnalyticDB：DescribeElasticPlan - 查詢彈性計劃

    更新時間：Feb 26, 2026

    調用DescribeElasticPlan介面查詢彈性計劃。該介面僅適用於數倉版彈性模式叢集版（新版）。

    介面說明

    使用說明

    該介面僅適用於數倉版彈性模式叢集版（新版）32 核及以上規格的叢集。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    adb:DescribeElasticPlan

    get

    DBCluster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    是

    數倉版叢集 ID。

    說明

    您可以調用 DescribeDBClusters 介面查看目標地區下所有數倉版叢集的叢集 ID。

    am-bp278jg9****
    ElasticPlanName

    string

    否

    彈性計劃名稱，取值說明：

    • 長度為 2~30 字元。

    • 由大寫字母、小寫字母、數字或底線（_）組成。

    說明

    不填寫該參數時，返回指定叢集下所有彈性計劃的詳細資料。

    realtime
    ResourcePoolName

    string

    否

    資源群組名稱。

    說明

    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 表示周日到周六，多個日期用半形逗號（,）分隔。

    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。

    • 當 ElasticPlanType 為 executorcombineworker 或 executor 時，該參數返回結果為大於 0 的數字。

    0
    Enable

    boolean

    彈性計劃是否生效，取值說明：

    • true（預設值）：生效。

    • false：不生效。

    true
    EndDay

    string

    彈性計劃結束日期，只有設定了彈性計劃結束日期才會返回參數值。格式：yyyy-MM-dd。

    2022-12-09
    PlanName

    string

    彈性計劃名稱。

    realtime
    ElasticPlanType

    string

    彈性計劃資源類型，取值說明：

    • worker：彈性 IO 資源單獨彈性。

    • executor：計算資源單獨彈性。

    • executorcombineworker（預設值）：計算，彈性 IO 資源按預設比例彈性。

    worker
    ElasticPlanWorkerSpec

    string

    彈性計劃支援擴容的資源規格，取值說明：

    • 8 Core 64 GB（預設規格）

    • 16 Core 64 GB

    • 32 Core 64 GB

    • 64 Core 128 GB

    • 12 Core 96 GB

    • 24 Core 96 GB

    • 52 Core 86 GB

    16 Core 64 GB

    樣本

    正常返回樣本

    JSON格式

    {
  "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 status code

    錯誤碼

    錯誤資訊

    描述
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。