全部产品
Search

搜索本产品

    云原生数据仓库AnalyticDB：DescribeLoadTasksRecords - 查询加载任务记录

    文档中心

    云原生数据仓库AnalyticDB：DescribeLoadTasksRecords - 查询加载任务记录

    更新时间：Dec 11, 2024

    查看异步导入导出任务的详情。

    接口说明

    更多关于异步提交导入导出任务的详情，请参见异步提交导入导出任务。

    调试

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

    授权信息

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

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

    请求参数

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

    地域 ID。

    说明 您可以调用 DescribeRegions 接口查看指定数仓版支持的地域 ID。
    		cn-shanghai
    DBClusterIdstring是

    集群 ID。

    说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有数仓版集群的详情，包括集群 ID。
    		am-bp2590j****
    StartTimestring是

    查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    说明 建议查询开始时间设置为 30 天内的任意时间点。
    		2021-05-18T06:00:00Z
    EndTimestring是

    查询结束时间，需晚于查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2021-05-18T06:30:00Z
    DBNamestring否

    导入导出任务所涉及的数据库名称。

    		adb_demo
    PageSizeinteger否

    每页记录数，取值范围如下：

    • 30（默认值）。
    • 50。
    • 100。
    		30
    PageNumberinteger否

    页码，取值为：大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。

    		1
    Orderstring否

    按指定字段对任务进行升序或降序排列。参数值需为 JSON 字符串类型，例如：[{"Field":"CreateTime", "Type":"desc"}]

    说明
  • Field表示需要排序的字段名，支持的字段为：State、CreateTime、DBName、ProcessID、UpdateTime、JobName和ProcessRows。
  • Type表示排序类型，取值范围为Desc（降序）或Asc（升序），取值不区分大小写。
    •
    		[{"Field":"CreateTime", "Type":"desc"}]
    Statestring否

    需要查询的异步导入或导出任务的状态，取值范围如下：

    • INIT：任务初始化。
    • RUNNING：任务进行中。
    • FINISH：任务执行成功。
    • FAILED：任务执行失败。
    		FINISH

    返回参数

    名称类型描述示例值
    object

    参数列表。

    TotalCountstring

    任务总数。

    		1
    PageSizestring

    本页记录数。

    		30
    RequestIdstring

    请求 ID。

    		C60B05DB-2B77-421A-98E9-92C20E******
    PageNumberstring

    页码。

    		1
    DBClusterIdstring

    集群 ID。

    		am-bp2590j****
    LoadTasksRecordsarray<object>

    任务信息列表。

    LoadTaskRecordobject

    参数列表。

    Sqlstring

    异步导入导出任务中使用的 SQL 语句详情。

    		insert overwrite into courses_external_table\nselect * from courses
    Statestring

    任务状态。

    		FINISH
    CreateTimestring

    任务开始时间，精确到毫秒，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

    		2021-05-18 18:47:27.0
    DBNamestring

    导入导出任务涉及的数据库名称。

    		adb_demo
    ProcessIDstring

    进程 ID。

    		2021051818472717201616624903453******
    UpdateTimestring

    任务状态的更新时间，精确到毫秒，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。

    		2021-05-18 18:47:31.0
    JobNamestring

    任务 ID。

    		2021051818472717201616624903453******
    ProcessRowslong

    异步导入导出任务所处理的数据行数。

    		6

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": "1",
  "PageSize": "30",
  "RequestId": "C60B05DB-2B77-421A-98E9-92C20E******",
  "PageNumber": "1",
  "DBClusterId": "am-bp2590j****",
  "LoadTasksRecords": [
    {
      "Sql": "insert overwrite into courses_external_table\\nselect * from courses",
      "State": "FINISH",
      "CreateTime": "2021-05-18 18:47:27.0",
      "DBName": "adb_demo",
      "ProcessID": "2021051818472717201616624903453******",
      "UpdateTime": "2021-05-18 18:47:31.0",
      "JobName": "2021051818472717201616624903453******",
      "ProcessRows": 6
    }
  ]
}

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2023-07-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情