文档

DescribeElasticPlans - 查询弹性计划列表

更新时间:

根据查询条件查询集群的弹性计划。

接口说明

当前服务的接入地址请参见服务接入点

调试

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

授权信息

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

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

请求参数

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

弹性计划名称。

说明 不填写弹性计划名称将查询所有弹性计划。
test
ResourceGroupNamestring

资源组名称。

说明
  • 不填写表示查询所有资源组的弹性计划,包括 Interactive 资源组类型和存储加速服务(EIU)。
  • 调用 DescribeDBResourceGroup 接口可以查看集群的资源组名称。
  • test
    Enabledboolean

    创建后是否启用弹性计划。 取值说明:

    • true:启用。
    • false:不启用。
    true
    PageSizeinteger

    每页大小。

    10
    PageNumberinteger

    页数。

    1
    DBClusterIdstring

    集群 ID。

    说明 调用 DescribeDBClusters 接口可以查看集群的集群 ID。
    amv-wz9509beptiz****
    Typestring

    弹性计划类型。 取值说明:

    • EXECUTOR:Interactive 资源组,即计算资源类型。
    • WORKER:存储加速服务(EIU)。
    EXECUTOR

    返回参数

    名称类型描述示例值
    object

    PaginationResponse<List>

    TotalCountinteger

    总计划数。

    15
    PageNumberinteger

    页数。

    1
    PageSizeinteger

    每页大小。

    10
    ElasticPlansarray<object>

    弹性计划列表。

    object

    弹性计划。

    ElasticPlanNamestring

    弹性计划名称。

    test
    Typestring

    弹性计划类型。 取值说明:

    • EXECUTORE:Interactive 资源组类型,即计算资源类型。
    • WORKER:存储加速服务(EIU)。
    EXECUTOR
    Enabledboolean

    创建后是否立即启用弹性计划。 取值说明:

    • true:立即启用。
    • false:不启用。
    true
    ResourceGroupNamestring

    资源组名称。

    说明 调用 DescribeDBResourceGroup 接口可以查看集群的资源组名称。
    test
    TargetSizestring

    目标规格。

    32ACU
    NextScheduleTimestring

    下次调度时间。

    说明 格式为 yyyy-MM-ddTHH:mm:ssZ。
    2022-01-01T12:01:00Z
    AutoScaleboolean

    是否开启存储加速服务(EIU)按比例默认弹性。 取值说明:

    • true:开启。
    • false:不开启。
    false
    RequestIdstring

    请求 ID。

    A5C433C2-001F-58E3-99F5-3274C14DF8BD

    示例

    正常返回示例

    JSON格式

    {
      "TotalCount": 15,
      "PageNumber": 1,
      "PageSize": 10,
      "ElasticPlans": [
        {
          "ElasticPlanName": "test",
          "Type": "EXECUTOR",
          "Enabled": true,
          "ResourceGroupName": "test",
          "TargetSize": "32ACU",
          "NextScheduleTime": "2022-01-01T12:01:00Z",
          "AutoScale": false
        }
      ],
      "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD"
    }

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2023-11-13OpenAPI 错误码发生变更查看变更详情
    2023-06-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2023-04-13OpenAPI 错误码发生变更查看变更详情