DocsICP FilingConsole
Documentation

UpdateMigrationTask

Updated at:
Copy as MD
Product
My Favorites

Updates a migration task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apig:UpdateMigrationTask

update

*All Resource

*

 None None

Request syntax

PUT /v1/migration-tasks/{taskId} HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example
taskId

string

No

The task ID (path parameter). The task must belong to the current user.

mt-xxxx

Request parameters

Parameter

Type

Required

Description

Example
body

object

No

The request body parameters.

target

string

No

Required. The update target. Determines whether to advance the task status or perform an engine operation.

Valid values:

  • Task :

    Status advancement.

  • Engine :

    Engine operation.

Task
clusterNamespace

string

No

The source cluster namespace for SLB traffic switching.

default
slbId

string

No

The SLB instance ID. Required when the task is in the Initial state with SLB traffic switching. The type is determined by the prefix (lb- or nlb-).

lb-bp1xxxx
virtualServices

array<object>

No

The list of backend server group bindings.

object

No

The list of backend server group bindings.

virtualServiceGroupId

string

No

CLB VServerGroupId / NLB ServerGroupId

rsp-xxxx
virtualServiceGroupName

string

No

The group name.

80-tcp
port

integer

No

The port. Valid values: 1 to 65535.

80
protocol

string

No

The protocol. Required for CLB instances.

tcp
weight

integer

No

The traffic switching weight for the legacy flow. Valid values: 0 to 100. Takes effect when the target is set to Engine.

50
serviceName

string

No

The SLB service name.

nginx-ingress-lb
switchType

string

No

The traffic switching method. Required when advancing from the Initial state.

Valid values:

  • DNS :

    DNS-based traffic switching. Engine updates only support modifying the description.

  • SLB :

    SLB-based traffic switching that reuses the original cluster SLB with a full engine pipeline.

SLB
description

string

No

The task description. For DNS-based traffic switching, Engine updates only modify this field.

Migration test

Response elements

Element

Type

Description

Example

object

Schema of Response

requestId

string

Id of the request

E7357D40-2418-5D4B-AC2E-D0A3C5930C7F
code

string

The response status code.

200
message

string

The response message.

success

Examples

Success response

JSON format

{
  "requestId": "E7357D40-2418-5D4B-AC2E-D0A3C5930C7F",
  "code": "200",
  "message": "success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.