Lists the running history of a migration task.
Operation description
- To query the execution history of a migration task, you must have the permission on mgw:ListImportJobHistory.
- A migration task can run multiple rounds. A unique execution ID is generated for each round.
- The execution history of a migration task records the change history of the task status.
Authorization information
There is currently no authorization information disclosed in the API.
Request syntax
GET /jobhistory/{jobName} HTTP/1.1
Host: userid.cn-hangzhou.mgw.aliyuncs.com
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| jobName | string | Yes | The task name. | test_job_name |
| runtimeId | integer | No | The execution ID of the task. If you specify an execution ID, only the running history related to the execution ID is listed. | 1 |
| marker | string | No | The marker after which the running history of the task is listed. | test_marker |
| count | string | No | Specifies the number of running records of the migration task to be returned. | 100 |
Response parameters
Examples
Sample success responses
JSONformat
{
"JobHistoryList": {
"Truncated": true,
"NextMarker": "test_next_marker",
"JobHistory": [
{
"Name": "test_name",
"JobVersion": "test_id",
"RuntimeId": 1,
"CommitId": 2,
"StartTime": "2024-05-01 12:00:00",
"EndTime": "2024-05-01 12:00:00",
"Status": "IMPORT_JOB_DOING",
"TotalCount": 1000,
"CopiedCount": 900,
"FailedCount": 100,
"TotalSize": 1000,
"CopiedSize": 1000,
"RuntimeState": "Normal",
"Message": "test error msg.",
"Operator": "user",
"ListStatus": "Listing"
}
]
}
}XMLformat
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<JobHistoryList>
<Truncated>true</Truncated>
<NextMarker>test_next_marker</NextMarker>
<JobHistory>
<Name>test_name</Name>
<JobVersion>test_id</JobVersion>
<RuntimeId>1</RuntimeId>
<CommitId>2</CommitId>
<StartTime>2024-05-01 12:00:00</StartTime>
<EndTime>2024-05-01 12:00:00</EndTime>
<Status>IMPORT_JOB_DOING</Status>
<TotalCount>1000</TotalCount>
<CopiedCount>900</CopiedCount>
<FailedCount>100</FailedCount>
<TotalSize>1000</TotalSize>
<CopiedSize>1000</CopiedSize>
<RuntimeState>Normal</RuntimeState>
<Message>test error msg.</Message>
<Operator>user</Operator>
<ListStatus>Listing</ListStatus>
</JobHistory>
</JobHistoryList>Error codes
For a list of error codes, visit the Service error codes.