ListResultExportJobHistory - 列出结果集导出历史任务

更新时间:2025-03-10 07:57

调用ListResultExportJobHistory接口查询当前RAM用户结果集导出执行历史记录列表。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

说明
您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息,包括地域 ID。
cn-hangzhou
DBClusterIdstring

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

说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 湖仓版(3.0)集群的集群 ID。
amv-7xv5ty5m9o4v****
PageNumberstring

页码,取值为大于 0 且不超过 Integer 最大值的整数。

1
PageSizestring

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
StartTimestring

查询开始时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2022-01-01T12:01:00Z
EndTimestring

查询结束时间,UTC 时间,格式为:yyyy-MM-ddTHH:mmZ。

说明
查询结束时间需晚于查询开始时间。
2023-05-25T06:54:00Z
Orderobject

根据指定字段对 SQL 语句进行排序,格式为 JSON,是一个有序 JSON 数组,按输入数组的顺序进行复合排序,包含FieldType两个字段,例如[{"Field":"CreateTimee", "Type": "desc" }]。其中:

  • Field表示需要排序的字段名,支持如下字段:

    • CreateTime:执行开始时间。
    • Status:执行状态。
    • DatabaseUser:用户名称。
    • TimeCost:执行耗时。
    • ResourceGroup:资源组。
    • ExportRows:导出行数。
    • Progress:导出进度。
  • Type表示排序类型,支持如下取值(取值均不区分大小写):

    • Desc:降序。
    • Asc:升序。
Fieldstring

排序字段名称,支持的排序字段如下:

  • CreateTime
  • DatabaseUser
  • TimeCost
  • ResourceGroup
  • Status
  • Progress
  • ExportRows
DatabaseUser
Typestring

排序类型,取值:

  • Desc:降序
  • Asc:升序
Desc
StatusListarray

任务执行状态列表(支持按照状态进行筛选)。

string

支持的状态有:

  1. SUBMITTED:任务提交成功。
  2. RUNNING:任务正在运行中。
  3. SUCCEEDED:任务执行成功。
  4. FAILED:任务执行失败。
RUNNING
ResourceGroupstring

任务执行资源组(支持按照资源组进行筛选)。

user_default
DatabaseUserstring

数据库用户。

test1

返回参数

名称类型描述示例值
名称类型描述示例值
object

返回详细信息。

RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Successboolean

调用是否成功,取值说明:

  • true:成功。
  • false:失败。
true
HttpStatusCodeinteger

HTTP 请求返回的响应状态码,200 表示请求发送成功。

200
Messagestring

调用结果的附加信息。取值说明:

  • 请求正常,返回 Ok
  • 请求异常,返回具体异常错误码。
OK
Codestring

接口状态或 POP 错误码。

InvalidInput
Itemsarray<object>

列表详情。

itemobject

结果集导出详情。

DBClusterIdstring

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

amv-7xv5ty5m9o4v****
AliUidstring

RAM 账号 ID。

120010511678****
Sqlstring

结果集导出任务中使用的 SQL 语句详情。

SELECT * FROM `ADB_SampleData_TPCH`.`supplier` LIMIT 20
CreateTimestring

结果集导出任务创建时间。UTC 时间,格式为yyyy-mm-ddThh:mm:ssZ

2022-04-01T09:50:18Z
StartTimestring

任务的开始时间,UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ。

2021-07-03T04:00:00Z
EndTimestring

查询结束时间。UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ

说明
查询结束时间需晚于查询开始时间。
2023-06-15T02:13:00Z
DatabaseUserstring

RAM 用户关联的数据库账号名称。

ram_user
TimeCostlong

数据导出耗时,单位是毫秒。

说明
从数据导出任务启动开始算,直到导出结束。
560
ExportJobIdstring

结果集导出任务唯一标识。

export_2024051319271219802100800401300****
ResourceGroupstring

任务执行资源组。

test
Statusstring

导出任务执行状态,枚举类型,分为以下几种状态:

  1. SUBMITTED:任务提交成功。
  2. RUNNING:任务正在运行中。
  3. SUCCEEDED:任务执行成功。
  4. FAILED:任务执行失败。
RUNNING
ExportPathstring

结果集完整地址。

oss://testBucketName/export_test/result_export/2024/05/13/202405131528400210090110690315154****/result.csv
Progressstring

导出进度。单位为百分比(%),取值范围[0,100]。

30
ProcessIdstring

返回 SQL 查询 ID,便于用户诊断。

说明
您可以通过调用 DescribeDiagnosisSQLInfo 接口进行查询诊断。
202306121421111720161451770345339****
ExportRowsstring

导出行数,接口调用成功才返回该参数。

10000
Messagestring

结果集导出 SQL 执行错误信息,只在任务执行失败时才返回该信息。

Failed to execute SQL
Enginestring

任务执行的引擎,目前只支持 XIHE。

XIHE
Schemastring

数据库名称。

lake_db
ExportTypestring

导出类型。

-
IsExpiredboolean

是否已过期:

  • false: 未过期,
  • true: 已过期
PageNumberinteger

页号,和传入的值一致。

1
PageSizeinteger

本页记录数。

10
TotalCountlong

总记录数。

174

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Success": true,
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": "InvalidInput",
  "Items": [
    {
      "DBClusterId": "amv-7xv5ty5m9o4v****",
      "AliUid": "120010511678****",
      "Sql": "SELECT * FROM `ADB_SampleData_TPCH`.`supplier` LIMIT 20",
      "CreateTime": "2022-04-01T09:50:18Z",
      "StartTime": "2021-07-03T04:00:00Z",
      "EndTime": "2023-06-15T02:13:00Z",
      "DatabaseUser": "ram_user",
      "TimeCost": 560,
      "ExportJobId": "export_2024051319271219802100800401300****\n",
      "ResourceGroup": "test",
      "Status": "RUNNING",
      "ExportPath": "oss://testBucketName/export_test/result_export/2024/05/13/202405131528400210090110690315154****/result.csv",
      "Progress": "30",
      "ProcessId": "202306121421111720161451770345339****",
      "ExportRows": "10000",
      "Message": "Failed to execute SQL",
      "Engine": "XIHE",
      "Schema": "lake_db",
      "ExportType": "-",
      "IsExpired": true
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 174
}

错误码

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

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
文档反馈