DocsICP FilingConsole
Documentation

CreateMigrationTask

Updated at:
Copy as MD
Product
My Favorites

Creates 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:CreateMigrationTask

create

*All Resource

*

 None None

Request syntax

POST /v1/migration-tasks HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
body

object

No

The request parameters.

clusterId

string

No

The ID of the source ACK cluster. The value must be the same as the cluster specified in the IngressInfo of the API. Note: This parameter is actually required. If this parameter is not specified, the API returns 400 InvalidParameter.IsEmpty.

c-xxxxxx
description

string

No

The description of the task. The description is stored only when the task is created.

migration from Nginx
environmentId deprecated

string

No

The ID of the destination environment. The value must be the same as the Ingress import environment of the API. Note: This parameter is actually required. If this parameter is not specified, the API returns 400 InvalidParameter.IsEmpty. You can call ListEnvironments to query existing environment IDs. CreateEnvironment has been deprecated.

env-xxxx
gatewayId

string

No

The ID of the destination gateway to which traffic is migrated.

gw-xxxx
httpApiId

string

No

The HTTP API ID. The API must have been imported as an Ingress type (HttpIngress) API. Note: This parameter is actually required. If this parameter is not specified, the API returns 400 InvalidParameter.IsEmpty.

api-xxxx
ingressClass

string

No

The Ingress class. If specified, the value must be the same as the API import configuration. Otherwise, an ingress class conflict error is returned.

nginx
migrationType

string

No

The migration type. [_single.params.body.props.migrationType.enum.Nginx Ingress]Nginx Ingress migration.

Valid values:

  • Nginx Ingress :

    Nginx Ingress 迁移

Nginx Ingress
watchNamespace

string

No

The watched namespace. If specified, the value must be the same as the API import configuration. Otherwise, a watchNamespace conflict error is returned.

default

Response elements

Element

Type

Description

Example

object

Schema of Response

code

string

The response status code.

200
data

object

The response data.

taskId

string

The task ID.

async-task-xxx
message

string

The response message.

success
requestId

string

The request ID.

019FD4D8-8A86-5FDE-B79F-357C69677DFB

Examples

Success response

JSON format

{
  "code": "200",
  "data": {
    "taskId": "async-task-xxx"
  },
  "message": "success",
  "requestId": "019FD4D8-8A86-5FDE-B79F-357C69677DFB"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.