跳转到主要内容
API Explorer|API Explorer
运维管理/迁移服务相关接口
GETMigration Service APIs起始版本 5.0.0同步需要认证

获取ZMigrate网关虚拟机实例

获取ZMigrate网关虚拟机实例

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

查询参数

请求参数

查询参数

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • managementVmInstanceUuidString必填

    管理云主机实例UUID。

  • gatewayVmInstancesList必填

    暂无描述。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    详情参考error

    • odeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

请求地址

GET/zstack/v1/zmigrate/vm-instances

/zstack/v1/zmigrate/vm-instances

操作 ID

GetZMigrateGatewayVmInstances

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/zmigrate/vm-instances?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "managementVmInstanceUuid": "ff04e1736ec6391f9a1f023b524d0a00", "gatewayVmInstances": [ { "uuid": "ff01ec80fd11327cba7519b66119d900", "name": "ZMigrateGatewayVmInstance", "description": "ZMigrate gateway vm instance for test" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史