调用DescribeElasticPlan查询弹性计划_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

调用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	否	资源组名称。说明您可以调用 DescribeDBResourceGroup 接口查看资源组名称。	USER_DEFAULT
ElasticPlanEnable	boolean	否	弹性计划是否生效，取值说明： true（默认值）：生效。 false：不生效。	true

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
ElasticPlanList	array<object>	弹性计划列表。
ElasticPlanInfo	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 值是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-12-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情