list-job(列举任务)

更新时间:
复制为 MD 格式

使用 list-job 命令可以列举已创建的迁移任务,支持按时间倒序、分页查询以及按父任务名称过滤。

命令格式

mgwutil list-job [--marker <value>] [--count <value>] [--parent-name <value>] [--text] [--json]

参数说明

参数

必填 | 可选

说明

--marker

可选

分页查询的起始标记。首次查询时无需提供此参数。

当上一次查询结果中 Truncated 为 true 时,将返回的 NextMarker 值作为本次查询的 marker 值,以获取下一页数据。

--count

可选

指定单次查询返回的任务数量。

  • 默认值:50;

  • 取值范围:1~100。

--parent-name

可选

父任务的名称。用于查询指定父任务下的所有子任务。当指定此参数时,其余参数将被忽略,命令会一次性返回所有子任务。

--text

响应内容将以纯文本(Text)格式返回。不填结果默认采用纯文本格式返回。

--json

响应内容将以JSON格式返回。

使用示例

列举所有任务

  • 执行命令时,默认使用 --text 文本格式 按创建时间倒序(从最新到最早)列出所有任务。

    • 加入 --text 参数。

      mgwutil list-job --text
    • 不加参数。

      mgwutil list-job

    成功返回

    CreateTime              Name                                                            Version                                 Status                  SrcAddress                                                      DestAddress                                                     ParentVersion                       
    2026-01-21 12:01:42     ****-test-retry-20260121-114234-retry-20260121-120141        87753f47-****-4db2-****-bce22714dd15    IMPORT_JOB_FINISHED     ****-test-dest-retry-20260121-114234-retry-20260121-120141   ****-test-src                                                a0cf618c-f524-4372-a115-fb31eef4f29e
    2026-01-21 11:42:35     ****-test-retry-20260121-114234                              a0cf618c-****-4372-****-fb31eef4f29e    IMPORT_JOB_FINISHED     ****-test-dest-retry-20260121-114234                         ****-test-src                                                72e542b0-d8ca-4ef6-a4e1-2b0af9c50c64
    
  • 执行命令时,使用 --json JSON格式 按创建时间倒序(从最新到最早)列出所有任务。

mgwutil list-job --json

成功返回

{
  "Code": "success",
  "StatusCode": 200,
  "Data": [
    {
      "CreateTime": "2026-01-21 12:01:42",
      "Name": "****-test-retry-20260121-114234-retry-20260121-120141",
      "Version": "87753f47-****-4db2-****-bce22714dd15",
      "Status": "IMPORT_JOB_FINISHED",
      "SrcAddress": "o****-test-dest-retry-20260121-114234-retry-20260121-120141",
      "DestAddress": "****-test-src",
      "ParentVersion": "a0cf618c-****-4372-****-fb31eef4f29e"
    },
    {
      "CreateTime": "2026-01-21 11:42:35",
      "Name": "****-test-retry-20260121-114234",
      "Version": "a0cf618c-****-4372-****-fb31eef4f29e",
      "Status": "IMPORT_JOB_FINISHED",
      "SrcAddress": "****-test-dest-retry-20260121-114234",
      "DestAddress": "o****-test-src",
      "ParentVersion": "72e542b0-****-4ef6-****-2b0af9c50c64"
    },
    {
      "CreateTime": "2026-01-21 11:31:56",
      "Name": "****-test",
      "Version": "72e542b0-****-4ef6-****-2b0af9c50c64",
      "Status": "IMPORT_JOB_FINISHED",
      "SrcAddress": "****-test-dest",
      "DestAddress": "****-test-src",
      "ParentVersion": ""
    }
  ],
  "LogTime": "2026-01-21 19:19:47"
}

分页列举任务

当任务总数超过单页数量时,可通过 --marker--count 参数进行分页查询。

  • 加入 --text 参数。

    mgwutil list-job --marker "" --count 2 --text
  • 默认不加参数。

mgwutil list-job --marker "" --count 2

成功返回

CreateTime              Name                                                            Version                                 Status                  SrcAddress                                                      DestAddress                                                     ParentVersion                       
2026-01-21 12:01:42     ****-test-retry-20260121-114234-retry-20260121-120141        87753f47-****-4db2-****-bce22714dd15    IMPORT_JOB_FINISHED     ****-test-dest-retry-20260121-114234-retry-20260121-120141   ****-test-src                                                a0cf618c-f524-4372-a115-fb31eef4f29e
2026-01-21 11:42:35     ****-test-retry-20260121-114234                              a0cf618c-****-4372-****-fb31eef4f29e    IMPORT_JOB_FINISHED     ****-test-dest-retry-20260121-114234                         ****-test-src                                                72e542b0-d8ca-4ef6-a4e1-2b0af9c50c64
  • 加入 --json 参数。

mgwutil list-job --marker "" --count 2 --json

成功返回

{
  "Code": "success",
  "StatusCode": 200,
  "Data": {
    "ImportJob": [
      {
        "CreateTime": "2025-12-30 11:28:19",
        "Name": "2233333",
        "Version": "741b0c9b-****-4056-****-4126337820b5",
        "Status": "IMPORT_JOB_BEGIN",
        "SrcAddress": "oss-oss-1-15-per-mouth-and-sat-sun-9-start-dest",
        "DestAddress": "oss-oss-1-15-per-mouth-and-sat-sun-9-start-src",
        "ParentVersion": ""
      },
      {
        "CreateTime": "2025-09-26 10:29:21",
        "Name": "common-inv-oss-oss-test-****",
        "Version": "75074dfa-****-4bc7-****-421cb0155835",
        "Status": "IMPORT_JOB_FINISHED",
        "SrcAddress": "common-inv-****-oss-src",
        "DestAddress": "****-test-common-inv-dest",
        "ParentVersion": ""
      }
    ],
    "NextMarker": "common-inv-oss-oss-test-****",
    "Truncated": true
  },
  "LogTime": "2026-01-21 19:29:55"
}

失败返回

{
  "Code": "fail",
  "StatusCode": 400,
  "LogTime": "2026-01-18 22:08:01",
  "ErrorMsg": "SDKError:    StatusCode: 400    Code: InvalidArgument    Message: count is less than 0 or exceed maximum    Data: {'AccessDeniedDetail':null,'Recommend':null,'ecCode':null,'hostId':'1***6387****55.cn-hangzhou.mgw.aliyuncs.com','requestId':'696CE941F8BE363534B70D92','statusCode':400} ",
  "ErrorCode": "InvalidArgument",
  "RequestId": "696CE941F8BE363534B70D92"
}

错误码

说明
  • 错误码表示错误类别,详情请参考错误信息(ErrorMsg)。

  • 此错误码包含 通用错误码

ErrorCode

说明

InvalidArgument

参数无效或参数值不合法。