Updated on 2025-03-31 GMT+08:00

Updating Tasks in Batches

Function

This API is used to update migration tasks in batches. You can update all migration tasks in a migration task group or update migration tasks with specified IDs.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/tasks/batch-update

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

Minimum length: 1 character

Maximum length: 1,024 characters

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The IAM token authentication. Ensure that the project ID contained in the token matches the project ID in the request URI.

Minimum length: 1 character

Maximum length: 16,384 characters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

group_id

No

String

The ID of the migration task group. All tasks in the task group will be updated.

Either group_id or ids must be specified.

Minimum length: 1 character

Maximum length: 36 characters

ids

No

Array of longs

The migration task ID array, including IDs of all tasks to be updated in batches.

Either group_id or ids must be specified.

Minimum value: 0

Maximum value: 9223372036854775807

Array length: 0 to 20

bandwidth_policy

Yes

Array of BandwidthPolicyDto objects

The traffic limiting rules. Each element in the array corresponds to the maximum bandwidth in a time period. A maximum of five periods are allowed, and the periods cannot overlap.

Array length: 0 to 5

task_priority

No

String

The task priority. There are three priority levels: high, medium, and low. This setting can only be modified for tasks that are waiting, suspended, and failed.

HIGH: high priority

MEDIUM: medium priority

LOW: low priority

The value can be:

  • HIGH

  • MEDIUM

  • LOW

Table 4 BandwidthPolicyDto field description

Parameter

Mandatory

Type

Description

end

Yes

String

The end time of the traffic limiting rule. The format is hh:mm, for example, 12:03.

max_bandwidth

Yes

Long

The maximum traffic bandwidth allowed in the specified time period. The unit is byte/s. The value ranges from 1,048,576 bytes/s (equivalent to 1 MB/s) to 209,715,200 bytes/s (equivalent to 200 MB/s).

Minimum value: 1048576

Maximum value: 209715200

start

Yes

String

The start time of the traffic limiting rule. The format is hh:mm, for example, 12:03.

Response

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

The error message.

error_code

String

The error code.

Example Request

  • This example updates the traffic limiting rules for tasks in the task group with ID xxxxxxxx by setting start to 00:01, end to 23:59, and max_bandwidth to 50000000.

    /v2/{project_id}/tasks/batch-update
    
    {
      "group_id" : "xxxxxxxx",
      "bandwidth_policy" : [ {
        "start" : "00:01",
        "end" : "23:59",
        "max_bandwidth" : 50000000
      } ]
    }
  • This example updates the traffic limiting rules for tasks with IDs 111 and 222 by setting start to 00:01, end to 23:59, and max_bandwidth to 50000000.

    /v2/{project_id}/tasks/batch-update
    
    {
      "ids" : [ 111, 222 ],
      "bandwidth_policy" : [ {
        "start" : "00:01",
        "end" : "23:59",
        "max_bandwidth" : 50000000
      } ]
    }

Example Response

None

SDK Sample Code

The sample code is as follows.

Java

  • This example updates the traffic limiting rules for tasks in the task group with ID xxxxxxxx by setting start to 00:01, end to 23:59, and max_bandwidth to 50000000.

     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
    55
    56
    57
    58
    59
    60
    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.oms.v2.region.OmsRegion;
    import com.huaweicloud.sdk.oms.v2.*;
    import com.huaweicloud.sdk.oms.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class BatchUpdateTasksSolution {
    
        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);
    
            OmsClient client = OmsClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(OmsRegion.valueOf("<YOUR REGION>"))
                    .build();
            BatchUpdateTasksRequest request = new BatchUpdateTasksRequest();
            BatchUpdateTasksReq body = new BatchUpdateTasksReq();
            List<BandwidthPolicyDto> listbodyBandwidthPolicy = new ArrayList<>();
            listbodyBandwidthPolicy.add(
                new BandwidthPolicyDto()
                    .withEnd("23:59")
                    .withMaxBandwidth(50000000L)
                    .withStart("00:01")
            );
            body.withBandwidthPolicy(listbodyBandwidthPolicy);
            body.withGroupId("xxxxxxxx");
            request.withBody(body);
            try {
                BatchUpdateTasksResponse response = client.batchUpdateTasks(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());
            }
        }
    }
    
  • This example updates the traffic limiting rules for tasks with IDs 111 and 222 by setting start to 00:01, end to 23:59, and max_bandwidth to 50000000.

     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
    55
    56
    57
    58
    59
    60
    61
    62
    63
    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.oms.v2.region.OmsRegion;
    import com.huaweicloud.sdk.oms.v2.*;
    import com.huaweicloud.sdk.oms.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class BatchUpdateTasksSolution {
    
        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);
    
            OmsClient client = OmsClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(OmsRegion.valueOf("<YOUR REGION>"))
                    .build();
            BatchUpdateTasksRequest request = new BatchUpdateTasksRequest();
            BatchUpdateTasksReq body = new BatchUpdateTasksReq();
            List<BandwidthPolicyDto> listbodyBandwidthPolicy = new ArrayList<>();
            listbodyBandwidthPolicy.add(
                new BandwidthPolicyDto()
                    .withEnd("23:59")
                    .withMaxBandwidth(50000000L)
                    .withStart("00:01")
            );
            List<Long> listbodyIds = new ArrayList<>();
            listbodyIds.add(111L);
            listbodyIds.add(222L);
            body.withBandwidthPolicy(listbodyBandwidthPolicy);
            body.withIds(listbodyIds);
            request.withBody(body);
            try {
                BatchUpdateTasksResponse response = client.batchUpdateTasks(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());
            }
        }
    }
    

Python

  • This example updates the traffic limiting rules for tasks in the task group with ID xxxxxxxx by setting start to 00:01, end to 23:59, and max_bandwidth to 50000000.

     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
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkoms.v2.region.oms_region import OmsRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkoms.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 = OmsClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(OmsRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = BatchUpdateTasksRequest()
            listBandwidthPolicybody = [
                BandwidthPolicyDto(
                    end="23:59",
                    max_bandwidth=50000000,
                    start="00:01"
                )
            ]
            request.body = BatchUpdateTasksReq(
                bandwidth_policy=listBandwidthPolicybody,
                group_id="xxxxxxxx"
            )
            response = client.batch_update_tasks(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • This example updates the traffic limiting rules for tasks with IDs 111 and 222 by setting start to 00:01, end to 23:59, and max_bandwidth to 50000000.

     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
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkoms.v2.region.oms_region import OmsRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkoms.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 = OmsClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(OmsRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = BatchUpdateTasksRequest()
            listBandwidthPolicybody = [
                BandwidthPolicyDto(
                    end="23:59",
                    max_bandwidth=50000000,
                    start="00:01"
                )
            ]
            listIdsbody = [
                111,
                222
            ]
            request.body = BatchUpdateTasksReq(
                bandwidth_policy=listBandwidthPolicybody,
                ids=listIdsbody
            )
            response = client.batch_update_tasks(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    

Go

  • This example updates the traffic limiting rules for tasks in the task group with ID xxxxxxxx by setting start to 00:01, end to 23:59, and max_bandwidth to 50000000.

     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
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        oms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/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 := oms.NewOmsClient(
            oms.OmsClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.BatchUpdateTasksRequest{}
    	var listBandwidthPolicybody = []model.BandwidthPolicyDto{
            {
                End: "23:59",
                MaxBandwidth: int64(50000000),
                Start: "00:01",
            },
        }
    	groupIdBatchUpdateTasksReq:= "xxxxxxxx"
    	request.Body = &model.BatchUpdateTasksReq{
    		BandwidthPolicy: listBandwidthPolicybody,
    		GroupId: &groupIdBatchUpdateTasksReq,
    	}
    	response, err := client.BatchUpdateTasks(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • This example updates the traffic limiting rules for tasks with IDs 111 and 222 by setting start to 00:01, end to 23:59, and max_bandwidth to 50000000.

     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
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        oms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/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 := oms.NewOmsClient(
            oms.OmsClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.BatchUpdateTasksRequest{}
    	var listBandwidthPolicybody = []model.BandwidthPolicyDto{
            {
                End: "23:59",
                MaxBandwidth: int64(50000000),
                Start: "00:01",
            },
        }
    	var listIdsbody = []int64{
            int64(111),
    	    int64(222),
        }
    	request.Body = &model.BatchUpdateTasksReq{
    		BandwidthPolicy: listBandwidthPolicybody,
    		Ids: &listIdsbody,
    	}
    	response, err := client.BatchUpdateTasks(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

More

For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.

Status Codes

Status Code

Description

200

OK. Batch update succeeded.

400

Bad request. Invalid parameters.

Error Codes

For details, see Error Codes.