調(diào)用DescribeElasticPlan接口查詢彈性計劃。該接口僅適用于數(shù)倉版彈性模式集群版(新版)。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
adb:DescribeElasticPlan | get |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 數(shù)倉版集群 ID。 說明
您可以調(diào)用 DescribeDBClusters 接口查看目標地域下所有數(shù)倉版集群的集群 ID。
| am-bp278jg9**** |
ElasticPlanName | string | 否 | 彈性計劃名稱,取值說明:
說明
不填寫該參數(shù)時,返回指定集群下所有彈性計劃的詳細信息。
| realtime |
ResourcePoolName | string | 否 | 資源組名稱。 說明
| USER_DEFAULT |
ElasticPlanEnable | boolean | 否 | 彈性計劃是否生效,取值說明:
| true |
返回參數(shù)
示例
正常返回示例
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 值是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-12-27 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |