AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 服务器迁移中心 开发参考 API参考 API目录 迁移源 DescribeSourceServers - 查询一个或多个迁移源信息

DescribeSourceServers - 查询一个或多个迁移源信息

更新时间：
产品详情
我的收藏

调用DescribeSourceServers查询一个或多个迁移源信息。

接口说明

接口说明

请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

smc:DescribeSourceServers

get

*SourceServer

acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceServerId}

 无 无

请求参数

名称

类型

必填

描述

示例值
JobId

string

否

迁移任务 ID。

j-bp19vlwm0tyigbmj****
State

string

否

迁移源状态。取值范围：

  • Unavailable：不可用，包括离线和出错。

  • Available：在线。

  • InUse：迁移中。

  • Deleting：删除中。

Available
Name

string

否

迁移源名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头，不能以 http://和 https://开头。可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。

默认值：空

testSourceServerName
PageNumber

integer

否

返回的迁移源列表的页码。起始值：1。

默认值：1。

1
PageSize

integer

否

分页查询时设置的每页行数。最大值：50。

默认值：10。

10
SourceId

array

否

迁移源 ID，可以输入多个。

s-bp1e2fsl57knvuug****

string

否

迁移源 ID，可以输入多个。

s-bp1e2fsl57knvuug****
ResourceGroupId

string

否

资源组 ID。

rg-acfmw3ty5y7****
Tag

array<object>

否

标签。

object

否

标签对象。

Key

string

否

为 SMC 资源指定的标签键。N 的取值范围：1~20

一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。

TestKey
Value

string

否

为 SMC 资源指定的标签值。N 的取值范围：1~20。

一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。

TestValue
RelatedJobType

array

否

关联任务类型。

string

否

关联任务类型。取值如下：

  • Not_Related：未关联任务。

  • Server：服务器迁移任务。

  • Os：操作系统迁移任务。

  • Cross_Zone：跨可用区迁移任务。

  • VMWare：VMWare 迁移任务。

  • Desktop：桌面任务。

Server
WorkgroupId

string

否

工作组 ID。

w-bp1ja22kdqphehlj****

返回参数

名称

类型

描述

示例值

object

信息集合。

SourceServers

object

SourceServer

array<object>

迁移源数组。

object

迁移源数组。

CreationTime

string

迁移源的注册时间。

2019-06-27T02:58:09Z
HeartbeatRate

integer

SMC 客户端（SMC Agent）心跳频率。单位：秒。

30
State

string

迁移源状态。

InUse
DataDisks

object

DataDisk

array<object>

迁移源的数据盘数组。

object

迁移源的数据盘数组。

Index

integer

数据盘顺序。

1
Size

integer

数据盘 N 大小。单位：GiB。

20
Parts

object

Part

array<object>

数据盘分区信息。

object

数据盘分区信息。

CanBlock

boolean

数据盘分区是否支持块复制。

false
SizeBytes

integer

数据盘分区大小。单位：Byte。

21474836480
Need

boolean

数据盘分区是否必须选择。

false
Device

string

数据盘分区设备标识。

1_0
Path

string

数据盘分区路径。

/home/data
Path

string

数据盘 N 路径。

/home/data
SystemDiskParts

object

SystemDiskPart

array<object>

系统盘分区信息。

object

系统盘分区信息。

CanBlock

boolean

系统盘分区是否支持块复制。

true
SizeBytes

integer

系统盘分区大小。单位：Byte。

254803968
Need

boolean

系统盘分区是否必须选择。

true
Device

string

系统盘分区设备标识符。

0_0
Path

string

系统盘分区路径。

/boot
KernelLevel

integer

内核版本级别。

1
SourceId

string

迁移源 ID。

s-bp1e2fsl57knvuug****
AgentVersion

string

SMC 客户端版本号。

1.5.2.3
StatusInfo

string

迁移源状态详细信息。该参数在迁移源状态为异常时返回。JSON 格式键值对，如：

- error_code：错误码。
- error_msg：错误信息。

{"error_code": "S1", "error_msg": "Rsync not found. Please install rsync."}
SystemDiskSize

integer

迁移源的系统盘大小。单位：GiB

40
Description

string

迁移源描述。

Server Source Imported By GotoAliyun.
ErrorCode

string

迁移源状态错误码。

SourceServer.Offline
JobId

string

最近一次的迁移任务 ID。

j-bp19vlwm0tyigbmj****
Platform

string

迁移源的系统平台。

OpenSUSE
ReplicationDriver

string

复制驱动器。默认值：SMT（迁云工具）

SMT
Name

string

迁移源的名称。

SourceServerName
SystemInfo

string

迁移源系统信息。JSON 格式键值对，可扩展，键值固定。大小不超过 1 KB。如：

agent_mode：运行模式。
agent_type：运行类型。
client_type：客户端类型。
hostname ：主机名。
ipv4：IPv4 地址。
ipv6： IPv6 地址。
cores：CPU 核数。
cpu_usage： CPU 使用率。
memory：内存。
memory_usage：内存使用率。

{\"agent_mode\":\"daemon\",\"agent_type\":\"aliyun\",\"client_type\":\"\",\"cores\":\"2\",\"cpu_usage\":\"0.00\",\"hostname\":\"ixxxxxxxxxx\",\"ipv4\":\"10.0.0.1\",\"memory\":\"8.00\",\"memory_usage\":\"3.61\"}
Architecture

string

迁移源的系统架构。

x86_64
ResourceGroupId

string

资源组 ID。

rg-acfmw3ty5y7****
Tags

object

Tag

array<object>

标签信息。

object

标签对象。

Key

string

为 SMC 资源指定的标签键。N 的取值范围：1~20。

一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。

TestKey
Value

string

为 SMC 资源指定的标签值。N 的取值范围：1~20。

一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。

TestValue
Disks

object

磁盘信息。

System

object

系统盘信息。

Size

integer

迁移源系统盘的大小，单位：GiB。取值范围为 20~32768。

说明

参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为 500 GiB，实际占用 100 GiB，则该参数取值需大于 100 GiB。

100
Offset

integer

系统盘首个分区的起始偏移。单位：Byte。

1024
Parts

object

Part

array<object>

系统盘分区信息。

object

分区信息。

CanBlock

boolean

系统盘分区是否支持块复制。可能值：

  • true：系统盘分区支持块复制。

  • false：系统盘分区不支持块复制。

false
SizeBytes

integer

系统盘分区大小。单位：Byte。

21474836480
Path

string

系统盘分区路径。

/home/data
Type

string

系统盘分区类型。可能值：

  • Normal：普通分区。

  • System：系统分区。

  • Boot：启动分区。

Normal
Data

object

Data

array<object>

数据盘信息列表。

object

数据盘信息。

Size

integer

迁移源的数据磁盘大小。单位：GiB。

80
Offset

integer

数据盘首个分区的起始偏移。单位：Byte。

1024
Parts

object

Part

array<object>

数据盘分区信息。

object

数据盘分区信息。

CanBlock

boolean

数据盘分区是否开启块复制。可能值：

  • true：数据盘分区开启块复制。

  • false：数据盘分区不开启块复制。

false
SizeBytes

integer

数据盘分区大小。单位：Byte。

21474836480
Path

string

数据盘分区路径。

/home/data
Type

string

数据盘分区类型。可能值：

  • Normal：普通分区。

  • System：系统分区。

  • Boot：启动分区。

Normal
WorkgroupId

string

工作组 ID。

w-bp1ja22kdqphehlj****
TotalCount

integer

迁移源总数。

1
PageSize

integer

每页行数。

10
RequestId

string

请求 ID。

410E6073-66D0-45D3-AB3E-4DC3F5E4****
PageNumber

integer

迁移源列表的页码。

1

示例

正常返回示例

JSON格式

{
  "SourceServers": {
    "SourceServer": [
      {
        "CreationTime": "2019-06-27T02:58:09Z",
        "HeartbeatRate": 30,
        "State": "InUse",
        "DataDisks": {
          "DataDisk": [
            {
              "Index": 1,
              "Size": 20,
              "Parts": {
                "Part": [
                  {
                    "CanBlock": false,
                    "SizeBytes": 21474836480,
                    "Need": false,
                    "Device": "1_0",
                    "Path": "/home/data"
                  }
                ]
              },
              "Path": "/home/data"
            }
          ]
        },
        "SystemDiskParts": {
          "SystemDiskPart": [
            {
              "CanBlock": true,
              "SizeBytes": 254803968,
              "Need": true,
              "Device": "0_0",
              "Path": "/boot"
            }
          ]
        },
        "KernelLevel": 1,
        "SourceId": "s-bp1e2fsl57knvuug****",
        "AgentVersion": "1.5.2.3",
        "StatusInfo": "{\"error_code\": \"S1\", \"error_msg\": \"Rsync not found. Please install rsync.\"}",
        "SystemDiskSize": 40,
        "Description": "Server Source Imported By GotoAliyun.",
        "ErrorCode": "SourceServer.Offline",
        "JobId": "j-bp19vlwm0tyigbmj****",
        "Platform": "OpenSUSE",
        "ReplicationDriver": "SMT",
        "Name": "SourceServerName",
        "SystemInfo": "{\\\"agent_mode\\\":\\\"daemon\\\",\\\"agent_type\\\":\\\"aliyun\\\",\\\"client_type\\\":\\\"\\\",\\\"cores\\\":\\\"2\\\",\\\"cpu_usage\\\":\\\"0.00\\\",\\\"hostname\\\":\\\"ixxxxxxxxxx\\\",\\\"ipv4\\\":\\\"10.0.0.1\\\",\\\"memory\\\":\\\"8.00\\\",\\\"memory_usage\\\":\\\"3.61\\\"}",
        "Architecture": "x86_64",
        "ResourceGroupId": "rg-acfmw3ty5y7****",
        "Tags": {
          "Tag": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        },
        "Disks": {
          "System": {
            "Size": 100,
            "Offset": 1024,
            "Parts": {
              "Part": [
                {
                  "CanBlock": false,
                  "SizeBytes": 21474836480,
                  "Path": "/home/data",
                  "Type": "Normal"
                }
              ]
            }
          },
          "Data": {
            "Data": [
              {
                "Size": 80,
                "Offset": 1024,
                "Parts": {
                  "Part": [
                    {
                      "CanBlock": false,
                      "SizeBytes": 21474836480,
                      "Path": "/home/data",
                      "Type": "Normal"
                    }
                  ]
                }
              }
            ]
          }
        },
        "WorkgroupId": "w-bp1ja22kdqphehlj****"
      }
    ]
  },
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "410E6073-66D0-45D3-AB3E-4DC3F5E4****",
  "PageNumber": 1
}

错误码

HTTP status code

错误码

错误信息

描述
500 InternalError An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket. 内部错误，请重试。如果多次尝试失败，请提交工单。
403 Forbidden.Unauthorized A required authorization for the specified action is not supplied. 用户未授权操作指定的资源。

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

变更历史

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

上一篇：迁移源下一篇：ModifySourceServerAttribute - 修改一个迁移源的名称和描述