Deleting Data Migration Tasks
Function
This API is used to delete data migration tasks.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
 - If you are using identity policy-based authorization, the following identity policy-based permissions are required. 
     
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
dcs:migrationTask:delete
Write
migrationTask
-
-
-
 
URI
DELETE /v2/{project_id}/migration-tasks/delete
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         project_id  | 
       
         Yes  | 
       
         String  | 
       
         Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Range: N/A Default Value: N/A  | 
      
Request Parameters
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         task_id_list  | 
       
         Yes  | 
       
         Array of strings  | 
       
         Definition: List of IDs of the migration tasks to delete. Constraints: N/A  | 
      
Response Parameters
Status code: 200
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         task_id_list  | 
       
         Array of strings  | 
       
         Definition: List of IDs of the migration tasks to delete.  | 
      
Status code: 400
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_msg  | 
       
         String  | 
       
         Parameter description: Error message. Value range: N/A.  | 
      
| 
         error_code  | 
       
         String  | 
       
         Parameter description: Error code. Value range: For details, see Error Codes.  | 
      
| 
         error_ext_msg  | 
       
         String  | 
       
         Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.  | 
      
Status code: 401
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_msg  | 
       
         String  | 
       
         Parameter description: Error message. Value range: N/A.  | 
      
| 
         error_code  | 
       
         String  | 
       
         Parameter description: Error code. Value range: For details, see Error Codes.  | 
      
| 
         error_ext_msg  | 
       
         String  | 
       
         Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.  | 
      
Status code: 403
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_msg  | 
       
         String  | 
       
         Parameter description: Error message. Value range: N/A.  | 
      
| 
         error_code  | 
       
         String  | 
       
         Parameter description: Error code. Value range: For details, see Error Codes.  | 
      
| 
         error_ext_msg  | 
       
         String  | 
       
         Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.  | 
      
Status code: 404
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_msg  | 
       
         String  | 
       
         Parameter description: Error message. Value range: N/A.  | 
      
| 
         error_code  | 
       
         String  | 
       
         Parameter description: Error code. Value range: For details, see Error Codes.  | 
      
| 
         error_ext_msg  | 
       
         String  | 
       
         Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.  | 
      
Status code: 500
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_msg  | 
       
         String  | 
       
         Parameter description: Error message. Value range: N/A.  | 
      
| 
         error_code  | 
       
         String  | 
       
         Parameter description: Error code. Value range: For details, see Error Codes.  | 
      
| 
         error_ext_msg  | 
       
         String  | 
       
         Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.  | 
      
Example Requests
Deleting data migration tasks
DELETE https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-tasks/delete
{
  "task_id_list" : [ "2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca" ]
}
  Example Responses
Status code: 200
Data migration task is deleted when the migration task ID exists. No operation is performed when the ID does not exist.
{
  "task_id_list" : [ "2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca" ]
}
  SDK Sample Code
The SDK sample code is as follows.
Deleting data migration tasks
          1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54  | 
         
          package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; import java.util.List; import java.util.ArrayList; public class DeleteMigrationTaskSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); DeleteMigrationTaskRequest request = new DeleteMigrationTaskRequest(); DeleteMigrateTaskRequest body = new DeleteMigrateTaskRequest(); List<String> listbodyTaskIdList = new ArrayList<>(); listbodyTaskIdList.add("2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca"); body.withTaskIdList(listbodyTaskIdList); request.withBody(body); try { DeleteMigrationTaskResponse response = client.deleteMigrationTask(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } }  | 
        
Deleting data migration tasks
          1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37  | 
         
          # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = DeleteMigrationTaskRequest() listTaskIdListbody = [ "2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca" ] request.body = DeleteMigrateTaskRequest( task_id_list=listTaskIdListbody ) response = client.delete_migration_task(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)  | 
        
Deleting data migration tasks
          1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43  | 
         
          package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.DeleteMigrationTaskRequest{} var listTaskIdListbody = []string{ "2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca", } request.Body = &model.DeleteMigrateTaskRequest{ TaskIdList: listTaskIdListbody, } response, err := client.DeleteMigrationTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }  | 
        
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| 
         Status Code  | 
       
         Description  | 
      
|---|---|
| 
         200  | 
       
         Data migration task is deleted when the migration task ID exists. No operation is performed when the ID does not exist.  | 
      
| 
         400  | 
       
         Invalid request.  | 
      
| 
         401  | 
       
         Invalid authentication information.  | 
      
| 
         403  | 
       
         The request is rejected.  | 
      
| 
         404  | 
       
         The requested resource does not exist. (No response. For details, see status code 200.)  | 
      
| 
         500  | 
       
         Internal service error.  | 
      
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot