The mgwutil tool enables you to use the command line to update job statuses and traffic-throttling policies. This includes starting and pausing jobs, and adjusting bandwidth and queries per second (QPS) parameters. - Data Online Migration

You can use these commands to update job statuses and traffic-throttling policies.

Start a job

Command format

mgwutil start-job <job-name>

Parameters

Parameter	Required	Description
job-name	Yes	The name of the job to start.

Example

mgwutil start-job mgwutil-abc

Successful response

{
  "Code":      "success" ,
  "StatusCode": 200,
  "LogTime": "2024-12-25 17:51:37",
  "Data":       {}
}

Failed response

{
  "Code": "fail",
  "StatusCode": 404,
  "LogTime": "2026-01-16 13:59:25",
  "ErrorMsg": "SDKError:    StatusCode: 404    Code: NoSuchImportJob    Message: The specified import job does not exist    Data: {'AccessDeniedDetail':null,'Recommend':null,'ecCode':null,'hostId':'1****96****94***.cn-hangzhou.mgw.aliyuncs.com','requestId':'6969D3BD5CCFC933302EC1A4','statusCode':404} ",
  "ErrorCode": "NoSuchImportJob",
  "RequestId": "6969D3BD5CCFC933302EC1A4"
}

Pause a job

Command format

mgwutil pause-job <job-name>

Parameters

Parameter	Required	Description
job-name	Yes	The name of the job to pause.

Example

mgwutil pause-job mgwutil-abc

Successful response

{
  "Code":      "success" ,
  "StatusCode": 200,
  "LogTime": "2025-12-25 17:51:37",
  "Data":       {}
}

Failed response

{
  "Code": "fail",
  "StatusCode": 404,
  "LogTime": "2026-01-16 13:59:25",
  "ErrorMsg": "SDKError:    StatusCode: 404    Code: NoSuchImportJob    Message: The specified import job does not exist    Data: {'AccessDeniedDetail':null,'Recommend':null,'ecCode':null,'hostId':'1****96****94***.cn-hangzhou.mgw.aliyuncs.com','requestId':'6969D3BD5CCFC933302EC1A4','statusCode':404} ",
  "ErrorCode": "NoSuchImportJob",
  "RequestId": "6969D3BD5CCFC933302EC1A4"
}

Close a job

Command format

mgwutil close-job <job-name>

Parameters

Parameter	Required	Description
job-name	Yes	The name of the job to close.

Example

mgwutil close-job mgwutil-abc

Successful response

{
  "Code":      "success" ,
  "StatusCode": 200,
  "LogTime": "2025-12-25 17:51:37",
  "Data":       {}
}

Failed response

{
  "Code": "fail",
  "StatusCode": 404,
  "LogTime": "2026-01-16 13:59:25",
  "ErrorMsg": "SDKError:    StatusCode: 404    Code: NoSuchImportJob    Message: The specified import job does not exist    Data: {'AccessDeniedDetail':null,'Recommend':null,'ecCode':null,'hostId':'1****96****94***.cn-hangzhou.mgw.aliyuncs.com','requestId':'6969D3BD5CCFC933302EC1A4','statusCode':404} ",
  "ErrorCode": "NoSuchImportJob",
  "RequestId": "6969D3BD5CCFC933302EC1A4"
}

Update the traffic-throttling policy for a job

Command format

mgwutil update-qos <job-name> [--max-bandwidth <value>] [--max-qps <value>]

Parameters

Parameter	Required	Description
job-name	Yes	The name of the job whose traffic-throttling policy you want to update.
--max-bandwidth	Yes	The traffic limit to update, in bits/s.
--max-qps	Yes	The QPS limit update is pending.

Example

mgwutil update-qos mgwutil-abc --max-bandwidth 1000000 --max-qps 1000

Successful response

{
  "Code":      "success" ,
  "StatusCode": 200,
  "LogTime": "2025-12-25 17:51:37",
  "Data":       {}
}

Failed response

{
  "Code": "fail",
  "StatusCode": 404,
  "LogTime": "2026-01-16 13:59:25",
  "ErrorMsg": "SDKError:    StatusCode: 404    Code: NoSuchImportJob    Message: The specified import job does not exist    Data: {'AccessDeniedDetail':null,'Recommend':null,'ecCode':null,'hostId':'1****96****94***.cn-hangzhou.mgw.aliyuncs.com','requestId':'6969D3BD5CCFC933302EC1A4','statusCode':404} ",
  "ErrorCode": "NoSuchImportJob",
  "RequestId": "6969D3BD5CCFC933302EC1A4"
}

Error codes

Note

An error code indicates the type of error. For more information, see the error message (ErrorMsg).
These error codes include common error codes.

ErrorCode	Description
NoSuchImportJob	The specified job does not exist. Confirm that the job name is correct and that the job has been created.