调用DescribeElasticPlan接口查询指定AnalyticDB MySQL数仓版（3.0）集群的资源弹性计划。

使用说明

该接口仅适用于AnalyticDB MySQL数仓版（3.0）弹性模式集群版（新版）32核及以上规格的集群。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeElasticPlan

系统规定参数。取值：DescribeElasticPlan。

DBClusterId String 是 am-bp278jg9****

AnalyticDB MySQL数仓版（3.0）集群ID。

说明 您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL数仓版（3.0）集群的集群ID。
ElasticPlanName String 否 realtime

弹性计划名称，取值说明：

  • 长度为2~30字符。
  • 由大写字母、小写字母、数字或下划线（_）组成。
    说明 不填写该参数时，返回指定集群下所有弹性计划的详细信息。
ResourcePoolName String 否 USER_DEFAULT

资源组名称。

说明
ElasticPlanEnable Boolean 否 true

弹性计划是否生效，取值说明：

  • true（默认值）：生效。
  • false：不生效。

返回数据

名称 类型 示例值 描述
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。
ElasticPlanList Array of ElasticPlanInfo

弹性计划列表。
EndTime String 10:00:00

弹性计划还原时间，与弹性计划扩容时间的间隔不能超过24小时。格式：HH:mm:ss。
WeeklyRepeat String 3,4,5,6

执行弹性计划的周期。0～6表示周日到周六，多个日期用半角逗号（,）分隔。
StartTime String 08:00:00

弹性计划扩容时间，格式：HH:mm:ss。
ResourcePoolName String USER_DEFAULT

资源组名称。
StartDay String 2022-12-02

弹性计划起始日期，只有设置了弹性计划起始日期才会返回参数值。格式：yyyy-MM-dd。
ElasticNodeNum Integer 0

弹性计划节点数。

  • 当ElasticPlanType为worker时，该参数不返回或返回结果为0。
  • 当ElasticPlanType为executorcombineworker或executor时，该参数返回结果为大于0的数字。
Enable Boolean true

弹性计划是否生效，取值说明：

  • true（默认值）：生效。
  • false：不生效。
EndDay String 2022-12-09

弹性计划结束日期，只有设置了弹性计划结束日期才会返回参数值。格式：yyyy-MM-dd。
PlanName String realtime

弹性计划名称。
ElasticPlanType String worker

弹性计划资源类型，取值说明：

  • worker：弹性IO资源单独弹性。
  • executor：计算资源单独弹性。
  • executorcombineworker（默认值）：计算，弹性IO资源按默认比例弹性。
ElasticPlanWorkerSpec String 16 Core 64 GB

弹性计划支持扩容的资源规格，取值说明：

  • 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

示例

请求示例

http(s)://adb.aliyuncs.com/?Action=DescribeElasticPlan
&DBClusterId=am-bp278jg9****
&ElasticPlanName=realtime
&ResourcePoolName=USER_DEFAULT
&ElasticPlanEnable=true
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeElasticPlanResponse>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <ElasticPlanList>
        <EndTime>10:00:00</EndTime>
        <WeeklyRepeat>3,4,5,6</WeeklyRepeat>
        <StartTime>08:00:00</StartTime>
        <ResourcePoolName>USER_DEFAULT</ResourcePoolName>
        <StartDay>2022-12-02</StartDay>
        <ElasticNodeNum>0</ElasticNodeNum>
        <Enable>true</Enable>
        <EndDay>2022-12-09</EndDay>
        <PlanName>realtime</PlanName>
        <ElasticPlanType>WORKER</ElasticPlanType>
        <ElasticPlanWorkerSpec>16 Core 64 GB</ElasticPlanWorkerSpec>
    </ElasticPlanList>
</DescribeElasticPlanResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "ElasticPlanList" : [ {
    "EndTime" : "10:00:00",
    "WeeklyRepeat" : "3,4,5,6",
    "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"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

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