Obtains the details of a migration task.
Operation description
- To query the information about a migration task, you must have the permission on mgw:GetImportJob.
Authorization information
There is currently no authorization information disclosed in the API.
Request syntax
GET /job/{jobName} HTTP/1.1
Host: userid.cn-hangzhou.mgw.aliyuncs.com
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| byVersion | string | No | Specifies whether to obtain the details of the migration task by using the task ID. | false |
| jobName | string | Yes | The name of the migration task. If the byVersion parameter is set to true, this parameter indicates the ID of the migration task. | test_job_name |
Response parameters
Examples
Sample success responses
JSONformat
{
"ImportJob": {
"Name": "test_name",
"SrcAddress": "test_src_address",
"DestAddress": "test_dest_address",
"Status": "IMPORT_JOB_DOING",
"EnableMultiVersioning": false,
"CreateTime": "2024-05-01 12:00:00",
"ModifyTime": "2024-05-01 12:00:00",
"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
}
}
}XMLformat
<?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-01 12:00:00</CreateTime>
<ModifyTime>2024-05-01 12:00:00</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>Error codes
For a list of error codes, visit the Service error codes.