调用DescribeSourceServers查询一个或多个迁移源信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
smc:DescribeSourceServers | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
JobId | string | 否 | 迁移任务 ID。 | j-bp19vlwm0tyigbmj**** |
State | string | 否 | 迁移源状态。取值范围:
| Available |
Name | string | 否 | 迁移源名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以 http://和 https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。 默认值:空 | testSourceServerName |
PageNumber | integer | 否 | 返回的迁移源列表的页码。起始值:1。 默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。最大值:50。 默认值:10。 | 10 |
SourceId | array | 否 | 迁移源 ID,可以输入多个。 | |
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 | 否 | 关联任务类型。取值如下:
| Server |
返回参数
示例
正常返回示例
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": 0,
"Offset": 0,
"Parts": {
"Part": [
{
"CanBlock": true,
"SizeBytes": 0,
"Path": "",
"Type": ""
}
]
}
},
"Data": {
"Data": [
{
"Size": 0,
"Offset": 0,
"Parts": {
"Part": [
{
"CanBlock": true,
"SizeBytes": 0,
"Path": "",
"Type": ""
}
]
}
}
]
}
},
"WorkgroupId": ""
}
]
},
"TotalCount": 1,
"PageSize": 10,
"RequestId": "410E6073-66D0-45D3-AB3E-4DC3F5E4****",
"PageNumber": 1
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbidden.Unauthorized | A required authorization for the specified action is not supplied. | 用户未授权操作指定的资源。 |
500 | InternalError | An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-27 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-05-30 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-07-28 | OpenAPI 错误码发生变更 | 查看变更详情 |