全部产品
Search
文档中心

数据管理 DMS:GetPagedInstance - 获取工单任务信息

更新时间:Apr 26, 2024

返回指定工单的任务信息。

调试

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

授权信息

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

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

请求参数

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

数据归档工单号。

868*****
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
3***

返回参数

名称类型描述示例值
object
TraceIdstring

用于跟踪服务请求。

0a06e1e316757357507896067d3780
Successboolean

请求是否成功,取值:

  • true:请求成功。

  • false:请求失败。

true
ErrorMessagestring

错误信息。

UnknownError
ErrorCodestring

错误码。

UnknownError
PageIndexlong

分页页码。

1
RequestIdstring

请求 ID。

7FAD400F-7A5C-4193-8F9A-39D86C4F0231
PageSizelong

每页数据量。

10
Totallong

任务实例总数。

2
Dataobject

返回的数据信息。

Instanceobject []

任务实例。

BusinessTimestring

业务时间。

2023-05-14 16:00:57
CheckStatuslong

归档校验状态,返回值如下:

  • 0:校验成功
  • 1:校验不一致
  • 2:未执行校验
  • 3:正在运行
  • 4:校验中断
3
DagIdlong

任务流 ID,任务流的唯一标识。

33***
Deletestring

是否删除归档文件。取值:

  • true:删除。
  • false:不删除。
false
EndTimestring

任务结束的时间。

2023-04-23 10:23:20
GmtCreatestring

创建任务流的时间。

2023-03-28 10:50:45
GmtModifiedstring

更新任务流的时间。

2023-04-18 15:28:16
HistoryDagIdlong

历史任务流 ID。

68***
Idlong

任务流 ID。

24****
LastRunningContextstring

上次任务流运行的情况。

{”nodes":[11***,11***]"}
Msgstring

本次任务运行的详细信息。

”归档任务日志:xxxx“
Statuslong

归档任务状态。

  • 0:待调度。
  • 1:正在执行。
  • 2:已暂停。
  • 3:执行失败。
  • 4:执行成功。
  • 5:完成。
1
TaskTypelong

链路类型。

  • 1:归档。
  • 2:归档恢复。
  • 2:归档校验。
1
TenantIdstring

租户 ID。

34***
TriggerTypelong

触发类型,取值如下:

  • 0:周期调度。
  • 1:手动运行。
1
Versionstring

版本号。

13***

示例

正常返回示例

JSON格式

{
  "TraceId": "0a06e1e316757357507896067d3780",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "PageIndex": 1,
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "PageSize": 10,
  "Total": 2,
  "Data": {
    "Instance": [
      {
        "BusinessTime": "2023-05-14 16:00:57",
        "CheckStatus": 3,
        "DagId": 0,
        "Delete": "false",
        "EndTime": "2023-04-23 10:23:20",
        "GmtCreate": "2023-03-28 10:50:45",
        "GmtModified": "2023-04-18 15:28:16",
        "HistoryDagId": 0,
        "Id": 0,
        "LastRunningContext": "{”nodes\":[11***,11***]\"}",
        "Msg": "”归档任务日志:xxxx“",
        "Status": 1,
        "TaskType": 1,
        "TenantId": "34***",
        "TriggerType": 1,
        "Version": "13***"
      }
    ]
  }
}

错误码

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