使用DescribeElasticPlanJobs查询弹性计划作业列表-云原生数据仓库AnalyticDB-阿里云

查询集群的弹性计划作业。

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeElasticPlanJobs	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ElasticPlanName	string	否	弹性计划名称。说明不填写弹性计划名称将查询所有弹性计划。调用 DescribeElasticPlans 接口查看集群的弹性计划名称。	test
ResourceGroupName	string	否	资源组名称。说明不填写表示查询所有资源组的弹性计划，包括 Interactive 资源组类型和存储加速服务（EIU）。调用 DescribeDBResourceGroup 接口可以查看集群的资源组名称。	test
Status	string	否	作业状态。取值说明： RUNNING：运行中。 SUCCESSFUL：运行成功。 FAILED：运行失败。说明不填写将查询所有状态的弹性计划。	SUCCESSFUL
StartTime	string	否	开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ。	2022-01-01T12:01:00Z
PageSize	integer	是	每页大小。	10
PageNumber	integer	是	页数。	1
DBClusterId	string	是	集群 ID。说明调用 DescribeDBClusters 接口可以查看集群 ID。	amv-wz9509beptiz****

返回参数

名称	类型	描述	示例值
	object	PaginationResponse<List>
TotalCount	integer	总作业数。	15
PageNumber	integer	页数。	1
PageSize	integer	每页大小。	10
Jobs	array<object>	作业列表。
Jobs	object
ElasticPlanName	string	弹性计划名称。	test
Status	string	作业状态。取值说明： RUNNING：运行中。 SUCCESSFUL：运行成功。 FAILED：运行失败。	SUCCESSFUL
Type	string	弹性计划作业类型。取值说明： EXECUTORE：Interactive 资源组类型，即计算资源类型。 WORKER：存储加速服务（EIU）。	EXECUTOR
ResourceGroupName	string	资源组名称。	test
StartTime	string	作业开始时间。说明格式为 yyyy-MM-ddTHH:mm:ssZ。	2022-01-01T11:01:00Z
EndTime	string	作业结束时间。说明格式为 yyyy-MM-ddTHH:mm:ssZ。	2022-01-01T12:01:00Z
TargetSize	string	目标规格。	32ACU
TotalAcu	string	总资源。说明 Type 取值为 EXECUTOR 时，本参数表示所属资源组的总计算资源。 Type 取值为 WORKER 时，本参数表示整个集群的总存储资源。	32ACU
ReserveAcu	string	预留资源。说明 Type 取值为 EXECUTOR 时，本参数表示当前资源组的预留资源。 Type 取值为 WORKER 时，本参数表示当前集群的总预留存储资源。	16ACU
ElasticAcu	string	弹性资源。说明 Type 取值为 EXECUTOR 时，本参数表示当前资源组的弹性资源。 Type 取值为 WORKER 时，本参数表示当前集群的总存储弹性资源。	16ACU
InstanceSize	integer	实例数量。说明 Type 取值为 EXECUTOR 时，本参数表示当前计算节点数量。 Type 取值为 WORKER 时，本参数表示当前集群的存储副本集数量。	1
RequestId	string	请求 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"
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2023-12-12	OpenAPI 错误码发生变更	查看变更详情
2023-04-13	OpenAPI 错误码发生变更	查看变更详情