文档

GetJob - 获取任务

更新时间:
一键部署

获取迁移任务详情。

接口说明

  • 获取迁移任务,您必须有 mgw:GetImportJob 权限。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /job/{jobName} HTTP/1.1 Host: userid.cn-hangzhou.mgw.aliyuncs.com

请求参数

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

是否使用任务 ID 获取。

false
jobNamestring

任务名称,如果 byVersion 为 true,该参数表示任务 ID。

test_job_name

返回参数

名称类型描述示例值
object

获取任务响应体。

ImportJobGetJobResp

获取任务详情。

示例

正常返回示例

JSON格式

{
  "ImportJob": {
    "Name": "test_name",
    "SrcAddress": "test_src_address",
    "DestAddress": "test_dest_address",
    "Status": "IMPORT_JOB_DOING",
    "EnableMultiVersioning": false,
    "CreateTime": "2024-05-01T12:00:00.000Z",
    "ModifyTime": "2024-05-01T12:00:00.000Z",
    "Version": "test_id",
    "Audit": {
      "LogMode": "off"
    },
    "OverwriteMode": "always",
    "TransferMode": "all",
    "Tags": "K1:V1,K2:V2",
    "ParentName": "test_parent_name",
    "ParentVersion": "7db93837-a5ee-4e3a-b3c8-800e7947dabc",
    "ConvertSymlinkTarget": false,
    "CreateReport": false,
    "Owner": "test_owner",
    "FilterRule": {
      "KeyFilters": {
        "Includes": {
          "Regex": [
            ".*\\.jpg$"
          ]
        },
        "Excludes": {
          "Regex": [
            ".*\\.jpg$"
          ]
        }
      },
      "LastModifiedFilters": {
        "Includes": {
          "TimeFilter": [
            {
              "StartTime": "2006-01-01T00:00:00Z",
              "EndTime": "2006-12-31T59:59:59Z"
            }
          ]
        },
        "Excludes": {
          "TimeFilter": [
            {
              "StartTime": "2006-01-01T00:00:00Z",
              "EndTime": "2006-12-31T59:59:59Z"
            }
          ]
        }
      },
      "FileTypeFilters": {
        "ExcludeSymlink": true,
        "ExcludeDir": true
      }
    },
    "ImportQos": {
      "MaxBandWidth": 1073741824,
      "MaxImportTaskQps": 1000
    },
    "ScheduleRule": {
      "StartCronExpression": "0 0 * * * ?",
      "SuspendCronExpression": "0 0 * * * ?",
      "MaxScheduleCount": 1
    }
  }
}

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ImportJob>
  <Name>test_name</Name>
  <SrcAddress>test_src_address</SrcAddress>
  <DestAddress>test_dest_address</DestAddress>
  <Status>IMPORT_JOB_DOING</Status>
  <EnableMultiVersioning>false</EnableMultiVersioning>
  <CreateTime>2024-05-01T12:00:00.000Z</CreateTime>
  <ModifyTime>2024-05-01T12:00:00.000Z</ModifyTime>
  <Version>test_id</Version>
  <Audit>
    <LogMode>off</LogMode>
  </Audit>
  <OverwriteMode>always</OverwriteMode>
  <TransferMode>all</TransferMode>
  <Tags>K1:V1,K2:V2</Tags>
  <ParentName>test_parent_name</ParentName>
  <ParentVersion>7db93837-a5ee-4e3a-b3c8-800e7947dabc</ParentVersion>
  <ConvertSymlinkTarget>false</ConvertSymlinkTarget>
  <CreateReport>false</CreateReport>
  <Owner>test_owner</Owner>
  <FilterRule>
    <KeyFilters>
      <Includes>
        <Regex>.*\.jpg$</Regex>
      </Includes>
      <Excludes>
        <Regex>.*\.jpg$</Regex>
      </Excludes>
    </KeyFilters>
    <LastModifiedFilters>
      <Includes>
        <TimeFilter>
          <StartTime>2006-01-01T00:00:00Z</StartTime>
          <EndTime>2006-12-31T59:59:59Z</EndTime>
        </TimeFilter>
      </Includes>
      <Excludes>
        <TimeFilter>
          <StartTime>2006-01-01T00:00:00Z</StartTime>
          <EndTime>2006-12-31T59:59:59Z</EndTime>
        </TimeFilter>
      </Excludes>
    </LastModifiedFilters>
    <FileTypeFilters>
      <ExcludeSymlink>true</ExcludeSymlink>
      <ExcludeDir>true</ExcludeDir>
    </FileTypeFilters>
  </FilterRule>
  <ImportQos>
    <MaxBandWidth>1073741824</MaxBandWidth>
    <MaxImportTaskQps>1000</MaxImportTaskQps>
  </ImportQos>
  <ScheduleRule>
    <StartCronExpression>0 0 * * * ?</StartCronExpression>
    <SuspendCronExpression>0 0 * * * ?</SuspendCronExpression>
    <MaxScheduleCount>1</MaxScheduleCount>
  </ScheduleRule>
</ImportJob>

错误码

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