You need to enable JavaScript to run this app.
导航

DescribeMigrationSources

最近更新时间2024.02.01 17:16:53

首次发布时间2023.07.18 10:22:41

调用DescribeMigrationSources接口,查询迁移源信息。

请求参数

名称类型是否必填示例值描述
ActionStringDescribeMigrationSources要执行的操作,取值: DescribeMigrationSources。
VersionString2020-04-01API的版本,取值: 2020-04-01。

Order

String

Desc

排序顺序,取值:

  • Desc:降序
  • Asc:升序

OrderByColumn

String

CreatedAt

排序字段,取值:

  • CreatedAt:按导入时间排序
PageNumberInteger1分页数。

PageSize

Integer

10

页表大小。

  • 取值范围:1~100
  • 默认值:10

ProjectName

String

project_a

迁移源所属项目,一个迁移源只能归属于一个项目。

  • 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。
  • 长度限制在64个字符以内。

SourceId

String

s-3tiegs1y963****

迁移源ID,可在导入迁移源时或调用本接口查询获取。

根据迁移源ID查询迁移源信息时,需要传入该参数。

SourceName

String

s-ycg9hd3nf8r****

迁移源名称,最大长度为255个字符。

根据迁移源名称查询迁移源信息时,需要传入该参数。

SourceState

String

Online

迁移源状态,取值:

  • Online:在线
  • Offline:离线
  • Migrating:迁移中
  • Error:异常

TagFilters.N.Key

String

TagFilters.1.Key=k1

根据标签查询资源时指定的标签键。

  • 参数 - N:表示标签键的序号,取值范围:1~10。
  • 多个标签键之间用&分隔,不允许重复。

说明

  • 不传则表示查询所有标签。
  • 传入空字符串时,则返回错误码InvalidTagFilterKey.Malformed

TagFilters.N.Values.N

String

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

根据标签查询资源时指定的标签值。

  • 第一个N:表示标签键的序号,取值范围:1~10。
  • 第二个N:表示标签值的序号,取值范围:1~3。
  • 多个标签值之间用&分隔。

说明

  • 如果传入该参数,则必须先传入TagFilters.N.Key
  • 不传则表示查询同一标签键下的所有标签值。
  • 传入空字符串时,表示查询标签值为空的标签。

返回数据

名称类型示例值描述
PageNumberInteger321分页数。
PageSizeInteger3210页表大小。
SourcesArray of Struct-符合条件的迁移源信息。具体请参见下表“ Sources 结构 ”。
TotalCountInteger321迁移源总数。

Sources 结构

名称类型示例值描述
AgentVersionStringlinux-1.4迁移Agent版本号。
CreatedAtString2023-06-01T10:27:16+08:00迁移源导入时间。
DiskInfoArray of Struct-迁移源磁盘信息。具体请参见下表“ DiskInfo 结构 ”。
HostnameStringlocalhost.localdomain迁移源主机名。
ImageInfoStruct-迁移源镜像信息。具体请参见下表“ImageInfo 结构”。
LastMigrationJobInfoStruct-最后一次迁移任务信息。具体请参见下表“LastMigrationJobInfo 结构”。
ProjectNameStringproject_a迁移源所属项目。
PrivateIpAddressString172.xx.xx.xxx迁移源私网IP。
PublicIpAddressString119.x.xxx.xxx迁移源公网IP。
SourceIdStrings-ycg9hd3nfb8r****迁移源ID。
SourceNameStrings-ycg9hd3nfb8r****迁移源名称。
SourceStateStringMigrating迁移源状态。
SystemInfoStruct-迁移源系统信息。具体请参见下表“SystemInfo 结构”。
InstanceInfoStruct-迁移源实例信息。具体请参见下表“InstanceInfo 结构”。
TagsArray of Struct-迁移源标签信息。具体请参见下表“Tags 结构”。

DiskInfo 结构

名称类型示例值描述
DiskIndexInteger320磁盘下标,系统盘为 0,数据盘从1开始。
DiskSizeInteger3220磁盘容量,单位GB。
PartitionsArray of Struct-磁盘分区信息。具体请参见下表“Partitions 结构”。
Partitions 结构
名称类型示例值描述
FileSystemFormatStringvfat文件系统格式。

Mountpoint

String

/boot/efi

分区挂载点。

允许为空,即不挂载。

PartitionIndexInteger320分区下标,从0开始。
PartitionSizeInteger64209715200分区容量,单位Bytes。

ImageInfo 结构

名称类型示例值描述

BootMode

String

BIOS

系统启动模式,取值:

  • UEFI
  • BIOS

OS

String

Linux

操作系统,取值:

  • Linux
  • Windows
PlatformStringCentos操作系统平台。
PlatformVersionString7.9.2009操作系统版本号。
KernelVersionString3.10.0-1160.102.1.el7.x86_64内核版本。
VirtualizationSystemStringkvm虚拟化系统。

LastMigrationJobInfo 结构

名称类型示例值描述

DestinationType

String

ECSInstance

最近一次迁移任务目标类型。取值:

  • ECSInstance:云服务器实例。
  • ECSImage:云服务器镜像。
  • ECSSystem:云服务器操作系统。
MigrationJobIdStringjob-3tiegs1y963****最近一次迁移任务ID。
MigrationJobNameStringVMware迁移最近一次迁移任务名称。

MigrationJobState

String

Replicating

最近一次迁移任务状态,取值:

  • Preparing:准备中
  • Replicating:迁移中
  • Success:已完成
  • Failed:失败
  • Waiting:等待中
  • Cleaning:清理中
ProjectNameStringproject_a迁移任务所属项目。

SystemInfo 结构

名称类型示例值描述

Architecture

String

x86_64

CPU架构。

目前只支持x86_64类型。

CPUInteger322实例CPU核数。
CPUUsageFloat3210CPU使用率,以百分比为单位,例如:10表示CPU使用率为10%。
MemoryInteger641019027456内存大小,单位Bytes。
MemoryUsageFloat3247.86内存使用率,以百分比为单位,例如:47.86表示内存使用率为47.86%。

InstanceInfo 结构

名称类型示例值描述

InnerInstance

Boolean

true

源实例是否为火山引擎云服务器实例。取值:

  • true:表示源实例为火山引擎云服务器实例。
  • false:表示源实例非火山引擎云服务器实例。
InstanceIdStringi-3teco18f1w5a71****源实例在火山引擎的实例ID。
RegionIdStringcn-beijing源实例在火山引擎的地域。

Virtio11Install

Boolean

true

源实例是否安装Virtio1.1驱动,取值:

  • true:已安装
  • false:未安装

Tags 结构

名称类型示例值描述

Key

String

Key=k1

根据标签查询资源时指定的标签键。

ValueStringValue=v1根据标签查询资源时指定的标签值。

请求示例

GET /?Action=DescribeMigrationSources&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: smc

返回示例

{
    "ResponseMetadata":{
        "RequestId":"202306021637410F150Dxxxxx",
        "Action":"DescribeMigrationSources",
        "Version":"2020-04-01",
        "Service":"smc",
        "Region":"cn-beijing"
    },
    "Result":{
        "TotalCount":1,
        "PageNumber":1,
        "PageSize":10,
        "Sources":[
            {
                "SourceId":"s-ycg9hd3nfb8rx6****",
                "SourceName":"s-ycg9hd3nfb8r****",
                "Hostname":"localhost.localdomain",
                "CreatedAt":"2023-06-01T10:27:16+08:00",
                "SourceState":"Migrating",
                "PublicIpAddress":"119.x.xxx.xxx",
                "PrivateIpAddress":"172.xx.xx.xxx",
                "AgentVersion":"linux-1.4",
                "ProjectName":"project_a",
                "SystemInfo":{
                    "CPU":1,
                    "Memory":1019027456,
                    "CPUUsage":4,
                    "MemoryUsage":47.86,
                    "Architecture":"x86_64"
                },
                "ImageInfo":{
                    "OS":"Linux",
                    "Platform":"CentOS",
                    "PlatformVersion":"7.9.2009",
                    "BootMode":"UEFI",
                    "VirtualizationSystem":"",
                    "KernelVersion":"3.10.0-1160.102.1.el7.x86_64"
                },
                "InstanceInfo":{
                    "InnerInstance":"true",
                    "InstanceId":"i-3teco18f1w5a71****",
                    "RegionId":"cn-beijing",
                    "Virtio11Install":true
                },
                "DiskInfo":[
                    {
                        "DiskIndex":0,
                        "DiskSize":20,
                        "Partitions":[
                            {
                                "PartitionIndex":0,
                                "PartitionSize":209715200,
                                "Mountpoint":"/boot/efi",
                                "FileSystemFormat":"vfat"
                            },
                            {
                                "PartitionIndex":1,
                                "PartitionSize":1073741824,
                                "Mountpoint":"/boot",
                                "FileSystemFormat":"xfs"
                            },
                            {
                                "PartitionIndex":2,
                                "PartitionSize":20189282304,
                                "Mountpoint":"",
                                "FileSystemFormat":"LVM2_member"
                            }
                        ]
                    }
                ],
                "Tags":[
                    {
                        "Key":"k1",
                        "Value":"v1"
                    }
                ],
                "LastMigrationJobInfo":{
                    "DestinationType":"ECSInstance",
                    "ProjectName":"project_a",
                    "MigrationJobId":"job-ycg9hghuv7****",
                    "MigrationJobName":"VMware迁移",
                    "MigrationJobState":"Replicating"
                }
            }
        ]
    }
}

错误码

HttpCode错误码错误信息描述
400InvalidOrder.MalformedThe specified Order is malformed.指定的Order不合法。
400InvalidOrderByColumn.MalformedThe specified OrderByColumn is malformed.指定的OrderByColumn不合法。
400InvalidSourceName.MalformedThe specified SourceName is malformed.指定的SourceName不合法。
400InvalidSourceState.MalformedThe specified SourceState is malformed.指定的SourceState不合法。
400InvalidProjectName.MalformedThe specified ProjectName is malformed.指定的ProjectName不合法。
400InvalidTagFilterKey.ConflictThe specified TagFilterKey already exists.指定的过滤标签键已存在。
400InvalidTagFilterKey.MalformedThe specified TagFilterKey is malformed.指定的标签键不合法。
400InvalidTagFilterValue.MalformedThe specified TagFilterValue already exists.指定的过滤标签值已存在。
400LimitExceeded.MaximumTagFilterKeysYou've reached the limit on the number of TagFilterKeys that you can set.指定的标签过滤键超过最大限制。
400LimitExceeded.MaximumTagFilterResultsYou've reached the limit on the number of resources that you can describe by TagFilters.通过标签过滤出的资源数量超过上限。
400LimitExceeded.MaximumTagFilterValuesYou've reached the limit on the number of TagFilterValues that you can set.指定的标签过滤值超过最大限制。