文档

DescribeElasticDailyPlan - 查询分时弹性计划日计划执行信息

更新时间:

调用DescribeElasticDailyPlan接口查询分时弹性计划日计划执行信息。该接口仅适用于ADB弹性模式集群版(新版)。

接口说明

使用说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeElasticDailyPlanRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

AnalyticDB MySQL 数仓版(3.0)集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 数仓版(3.0)集群的集群 ID。
am-bp11q28kvl688****
ElasticPlanNamestring

弹性计划名称。取值说明:

  • 长度为 2~30 字符。
  • 由大写字母、小写字母、数字或下划线(_)组成。
realtimeplan
ResourcePoolNamestring

资源组名称。

说明 您可以调用 DescribeDBResourceGroup 接口查看资源组名称。
test
ElasticDailyPlanDaystring

当天弹性计划的起始日期,格式:yyyy-MM-dd。

2022-12-02
ElasticDailyPlanStatusListstring

当天弹性计划执行状态,同时查询多个状态用半角逗号(,)分隔,取值说明:

  • 1:未执行。
  • 2:执行中。
  • 3:执行成功。
  • 4:执行失败。
3

返回参数

名称类型描述示例值
object

返回结构体

RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
ElasticDailyPlanListobject []

当天弹性计划的信息列表。

Statusinteger

当天弹性计划执行状态,同时查询多个状态用半角逗号(,)分隔,取值说明:

  • 1:未执行。
  • 2:执行中。
  • 3:执行成功。
  • 4:执行失败。
3
Daystring

当天弹性计划的起始日期,格式:yyyy-MM-dd。

2022-12-02
ResourcePoolNamestring

资源组名称。

test
StartTsstring

实际扩容时间。格式:yyyy-MM-dd hh:mm:ss(UTC 时间)。

2022-12-02 16:00:00
PlanEndTsstring

计划还原时间。格式:yyyy-MM-dd hh:mm:ss(UTC 时间)。

2022-12-02 16:00:00
PlanStartTsstring

计划扩容时间。格式:yyyy-MM-dd hh:mm:ss(UTC 时间)。

2022-12-02 15:00:00
ElasticNodeNuminteger

弹性计划节点数。

  • 当 ElasticPlanType 为 worker 时,该参数不返回或返回结果为 0。

  • 当 ElasticPlanType 为 executorcombineworkerexecutor 时,该参数返回结果为大于 0 的数字。

0
EndTsstring

实际还原时间。格式:yyyy-MM-dd hh:mm:ss(UTC 时间)。

2022-12-02 16:00:00
PlanNamestring

弹性计划名称。

realtimeplan
ElasticPlanTypestring

弹性计划资源类型,取值说明:

  • worker:弹性 IO 资源单独弹性。

  • executor:计算资源单独弹性。

  • executorcombineworker(默认值):计算,弹性 IO 资源按默认比例弹性。

worker
ElasticPlanWorkerSpecstring

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

  • 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",
  "ElasticDailyPlanList": [
    {
      "Status": 3,
      "Day": "2022-12-02",
      "ResourcePoolName": "test",
      "StartTs": "2022-12-02 16:00:00",
      "PlanEndTs": "2022-12-02 16:00:00",
      "PlanStartTs": "2022-12-02 15:00:00",
      "ElasticNodeNum": 0,
      "EndTs": "2022-12-02 16:00:00",
      "PlanName": "realtimeplan",
      "ElasticPlanType": "worker",
      "ElasticPlanWorkerSpec": "16 Core 64 GB"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

  • 本页导读 (1)
文档反馈