Pausing a Migration Task
Function
This API is used to stop a migration task that is in the Migrating state.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/tasks/{task_id}/stop
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        Yes  | 
      
        String  | 
      
        The project ID. Minimum length: 1 character Maximum length: 1,024 characters  | 
     
| 
        task_id  | 
      
        Yes  | 
      
        String  | 
      
        The migration task 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: 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 task 191297407830872 in the project 2c0689c860ad4728a497c91ec0844383.
POST https://{endpoint}/v2/2c0689c860ad4728a497c91ec0844383/tasks/191297407830872
 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.