Pausing a Migration Task Group
Function
This API is used to pause a migration task group in the Creating or Executing state.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/taskgroups/{group_id}/stop
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | The project ID. Minimum length: 1 character Maximum length: 1,024 characters |
| group_id | Yes | String | The task group ID. Minimum length: 1 character Maximum length: 1,024 characters |
Request
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | The token used for IAM authentication. Minimum length: 1 character Maximum length: 16,384 characters |
Response
Status code: 200
Ok
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | The error message. |
| error_code | String | The error code. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | The error message. |
| error_code | String | The error code. |
Example Request
This example pauses the migration task group 157ece42-3270-4824-a3d2-f0187a03ca01 in the project f4e146cac1de45669c3fed73dc3b9c6f.
PUT https://{endpoint}/v2/f4e146cac1de45669c3fed73dc3b9c6f/taskgroups/157ece42-3270-4824-a3d2-f0187a03ca01 Example Response
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | Ok |
| 400 | Bad request |
| 403 | Forbidden |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.