GetMigrationTask - 获取迁移任务

更新时间:
复制 MD 格式

获取迁移任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:GetMigrationTask

get

*全部资源

*

无 无

请求语法

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

路径参数

名称

类型

必填

描述

示例值

taskId

string

否

迁移任务 ID

mt-xxxxxxxx

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

Id of the request

42EAF9DB-9082-5F11-8EE1-C2357906DA0F

code

string

响应码。

200

message

string

响应消息。

success

data

object

响应数据。

taskId

string

任务 ID

mt-xxxxxxxx

userId

string

任务归属用户 ID

1234567890

gatewayId

string

目标网关 ID

gw-xxxx

gatewayName

string

目标网关名称;查询失败时兜底为 -(不阻断主任务信息返回)

my-gateway

apiId

string

关联的 HTTP API ID

api-xxxx

apiName

string

API 名称(可能为空)

ingress-api

envId

string

目标环境 ID

env-xxxx

status

string

任务状态

枚举值:

  • FlowSwitchCompleted :

    流量切换中

  • Failed :

    迁移失败

  • Completed :

    迁移完成

  • FlowSwitchPreCheck :

    流量切换中

  • Initial :

    路由迁移(向导第 2 步)

  • FlowSwitch :

    流量切换中(向导第 3 步)

  • FlowSwitchCheck :

    流量切换中

FlowSwitch

clusterId

string

源 ACK 集群 ID

c-xxxxxx

clusterName

string

源集群名称;按 gatewayId+clusterId 反查服务来源,失败兜底 -

my-cluster

clusterNamespace

string

源集群命名空间(SLB 切流时选择)

default

slbId

string

切流的 SLB 实例 ID

lb-bp1xxxx

virtualServices

array<object>

SLB 虚拟服务器组列表

object

SLB 虚拟服务器组列表

virtualServiceGroupId

string

后端组 ID

rsp-xxxx

virtualServiceGroupName

string

名称

80-tcp

port

integer

端口

80

protocol

string

协议,CLB 必填

tcp

weight

integer

旧流程 APIG 侧 Service 权重(0-100)

50

serviceName

string

选中的 SLB Service 名称

nginx-ingress-lb

migrationType

string

迁移类型

枚举值:

  • Nginx Ingress :

    Nginx Ingress 迁移

Nginx Ingress

switchType

string

切流方式

枚举值:

  • DNS :

    域名解析切流

  • SLB :

    复用原集群 SLB 切流

SLB

description

string

任务描述

workspace api monitor test

ingressConfig

object

Ingress 配置

ingressClass

string

监听的 Ingress Class

nginx

watchNamespace

string

监听 Ingress 的命名空间。

default

createTime

integer

创建时间(Unix 秒级时间戳,前端 ×1000 后格式化)

1756262400

示例

正常返回示例

JSON格式

{
  "requestId": "42EAF9DB-9082-5F11-8EE1-C2357906DA0F",
  "code": "200",
  "message": "success",
  "data": {
    "taskId": "mt-xxxxxxxx",
    "userId": "1234567890",
    "gatewayId": "gw-xxxx",
    "gatewayName": "my-gateway",
    "apiId": "api-xxxx",
    "apiName": "ingress-api",
    "envId": "env-xxxx",
    "status": "FlowSwitch",
    "clusterId": "c-xxxxxx",
    "clusterName": "my-cluster",
    "clusterNamespace": "default",
    "slbId": "lb-bp1xxxx",
    "virtualServices": [
      {
        "virtualServiceGroupId": "rsp-xxxx",
        "virtualServiceGroupName": "80-tcp",
        "port": 80,
        "protocol": "tcp"
      }
    ],
    "weight": 50,
    "serviceName": "nginx-ingress-lb",
    "migrationType": "Nginx Ingress",
    "switchType": "SLB",
    "description": "workspace api monitor test",
    "ingressConfig": {
      "ingressClass": "nginx",
      "watchNamespace": "default"
    },
    "createTime": 1756262400
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。