文档

DescribeElasticPlanJobs - 查询弹性计划作业列表

更新时间:

查询AnalyticDB MySQL湖仓版(3.0)集群的弹性计划作业。

调试

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

授权信息

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

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

请求参数

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

弹性计划名称。

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

    资源组名称。

    说明
  • 不填写表示查询所有资源组的弹性计划,包括 Interactive 资源组类型和存储加速服务(EIU)。
  • test
    Statusstring

    作业状态。 取值说明:

    • RUNNING:运行中。
    • SUCCESSFUL:运行成功。
    • FAILED:运行失败。
    说明 不填写将查询所有状态的弹性计划。
    SUCCESSFUL
    StartTimestring

    开始时间。 格式为 yyyy-MM-ddTHH:mm:ssZ。

    2022-01-01T12:01:00Z
    PageSizeinteger

    每页大小。

    10
    PageNumberinteger

    页数。

    1
    DBClusterIdstring

    集群 ID。

    说明 调用 DescribeDBClusters 接口可以查看 AnalyticDB MySQL 湖仓版(3.0)集群的集群 ID。
    amv-wz9509beptiz****

    返回参数

    名称类型描述示例值
    object

    PaginationResponse<List>

    TotalCountinteger

    总作业数。

    15
    PageNumberinteger

    页数。

    1
    PageSizeinteger

    每页大小。

    10
    Jobsobject []

    作业列表。

    ElasticPlanNamestring

    弹性计划名称。

    test
    Statusstring

    作业状态。 取值说明:

    • RUNNING:运行中。
    • SUCCESSFUL:运行成功。
    • FAILED:运行失败。
    SUCCESSFUL
    Typestring

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

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

    资源组名称。

    test
    StartTimestring

    作业开始时间。

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

    作业结束时间。

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

    目标规格。

    32ACU
    TotalAcustring

    总资源。

    说明
    • Type 取值为 EXECUTOR 时,本参数表示所属资源组的总计算资源。
    • Type 取值为 WORKER 时,本参数表示整个集群的总存储资源。
    32ACU
    ReserveAcustring

    预留资源。

    说明
    • Type 取值为 EXECUTOR 时,本参数表示当前资源组的预留资源。
    • Type 取值为 WORKER 时,本参数表示当前集群的总预留存储资源。
    16ACU
    ElasticAcustring

    弹性资源。

    说明
    • Type 取值为 EXECUTOR 时,本参数表示当前资源组的弹性资源。
    • Type 取值为 WORKER 时,本参数表示当前集群的总存储弹性资源。
    16ACU
    InstanceSizeinteger

    实例数量。

    说明
    • Type 取值为 EXECUTOR 时,本参数表示当前计算节点数量。
    • Type 取值为 WORKER 时,本参数表示当前集群的存储副本集数量。
    1
    RequestIdstring

    请求 ID。

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

    示例

    正常返回示例

    JSON格式

    {
      "TotalCount": 15,
      "PageNumber": 1,
      "PageSize": 10,
      "Jobs": [
        {
          "ElasticPlanName": "test",
          "Status": "SUCCESSFUL",
          "Type": "EXECUTOR",
          "ResourceGroupName": "test",
          "StartTime": "2022-01-01T11:01:00Z",
          "EndTime": "2022-01-01T12:01:00Z",
          "TargetSize": "32ACU",
          "TotalAcu": "32ACU",
          "ReserveAcu": "16ACU",
          "ElasticAcu": "16ACU",
          "InstanceSize": 1
        }
      ],
      "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-12-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:404
    2023-04-13OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      新增错误码:404
    • 本页导读 (1)
    文档反馈