主机迁移服务 SMS主机迁移服务 SMS

更新时间:2021/09/14 GMT+08:00
分享

新增模板信息

功能介绍

新增源端模板信息

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/vm/templates

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:16384

表2 请求Body参数

参数

是否必选

参数类型

描述

template

TemplateRequest object

模板信息

表3 TemplateRequest

参数

是否必选

参数类型

描述

name

String

模板名称

最小长度:0

最大长度:255

is_template

Boolean

是否是通用模板,如果模板关联一个任务,则不算通用模板

region

String

Region信息

最小长度:0

最大长度:255

projectid

String

项目ID

最小长度:0

最大长度:255

target_server_name

String

目标端服务器名称

最小长度:0

最大长度:255

availability_zone

String

可用区

最小长度:0

最大长度:255

volumetype

String

磁盘类型

枚举值:

  • SAS:高I/O
  • SSD:超高I/O
  • SATA:普通I/O

flavor

String

虚拟机规格

最小长度:0

最大长度:65535

vpc

VpcObject object

vpc对象

nics

Array of Nics objects

网卡信息,支持多个网卡,如果是自动创建,只填一个,id使用“autoCreate”

security_groups

Array of SgObject objects

安全组,支持多个安全组,如果是自动创建,只填一个,id使用“autoCreate”

publicip

PublicIp object

公网ip

disk

Array of TemplateDisk objects

磁盘信息

data_volume_type

String

数据盘磁盘类型

枚举值:

  • SAS:高I/O
  • SSD:超高I/O
  • SATA:普通I/O

target_password

String

目的端密码

最小长度:0

最大长度:1024

表4 VpcObject

参数

是否必选

参数类型

描述

id

String

虚拟私有云ID,如果是自动创建,填“autoCreate”

最小长度:1

最大长度:255

name

String

虚拟私有云名称

最小长度:1

最大长度:255

cidr

String

VPC的网段,默认192.168.0.0/16

最小长度:1

最大长度:255

表5 Nics

参数

是否必选

参数类型

描述

id

String

子网ID,如果是自动创建,使用"autoCreate"

最小长度:0

最大长度:255

name

String

子网名称

最小长度:0

最大长度:255

cidr

String

子网网关/掩码

最小长度:0

最大长度:255

ip

String

虚拟机IP地址,如果没有这个字段,自动分配IP

最小长度:0

最大长度:255

表6 SgObject

参数

是否必选

参数类型

描述

id

String

安全组ID

最小长度:0

最大长度:255

name

String

安全组名称

最小长度:0

最大长度:255

表7 PublicIp

参数

是否必选

参数类型

描述

type

String

弹性公网IP类型,默认为5_bgp

最小长度:0

最大长度:255

bandwidth_size

Integer

带宽大小,单位:Mbit/s

调整带宽时的最小单位会根据带宽范围不同存在差异。

小于等于300Mbit/s,默认最小单位为1Mbit/s。300Mbit/s~1000Mbit/s,默认最小单位为50Mbit/s。大于1000Mbit/s:默认最小单位为500Mbit/s。

最小值:1

最大值:2000

表8 TemplateDisk

参数

是否必选

参数类型

描述

index

Integer

磁盘序号,从0开始

最小值:0

最大值:2147483647

name

String

磁盘名称

最小长度:0

最大长度:255

disktype

String

磁盘类型,同volumetype字段

最小长度:0

最大长度:255

size

Long

磁盘大小,单位:GB

最小值:0

最大值:9223372036854775807

响应参数

状态码: 200

表9 响应Body参数

参数

参数类型

描述

id

String

服务端返回的新添加的模板的id

最小长度:0

最大长度:255

请求示例

  • 创建迁移任务(创建新服务器)时同时添加的模板
    POST https://{endpoint}/v3/vm/templates
    
    {
      "template" : {
        "name" : "",
        "is_template" : false,
        "region" : "region",
        "target_server_name" : "abcd",
        "availability_zone" : "availability_zone",
        "volumetype" : "",
        "vpc" : {
          "id" : "00cda768-ef7b-40ac-a555-84b0c2b85d89",
          "name" : "sms-1566979232(192.168.0.0/16)"
        },
        "security_groups" : [ {
          "id" : "00d57b53-c00b-4d0a-975b-0f3c4fcf93c8",
          "name" : "kubernetes.io-default-sg(入方向:udp/1-65535;tcp/22,1-65535,3389; 出方向:--)"
        } ],
        "nics" : [ {
          "id" : "b5891372-f48c-4b3c-9f7a-ab58da5baa93",
          "name" : "sms-1566979244(192.168.0.0/16)",
          "cidr" : "192.168.0.0/16",
          "ip" : ""
        } ],
        "flavor" : "s2.medium.2",
        "publicip" : {
          "type" : "5_bgp",
          "bandwidth_size" : 5,
          "bandwidth_share_type" : "PER"
        },
        "disks" : [ {
          "index" : 0,
          "name" : "system",
          "disktype" : "",
          "size" : 40,
          "$$hashKey" : "object:3065"
        } ]
      }
    }
  • 创建模板的参数
    POST https://{endpoint}/v3/vm-templates
    
    {
      "template" : {
        "name" : "xxxx",
        "is_template" : true,
        "region" : "region",
        "target_server_name" : "ggg-win16-t",
        "availability_zone" : "availability_zone",
        "target_password" : "Sms%2020$sre",
        "flavor" : "c3.medium.2",
        "vpc" : {
          "id" : "e7069fc1-e09e-4ded-8570-6b3bb2a5893b",
          "name" : "Migrate-SSd-1",
          "cidr" : "192.168.0.0/16"
        },
        "nics" : [ {
          "id" : "c5c7d1a2-a204-4cee-8f11-26ac97a50d13",
          "name" : "Migrate-SSd-35",
          "cidr" : "192.168.0.0/16",
          "ip" : ""
        } ],
        "security_groups" : [ {
          "id" : "003ae8fc-066a-45cd-8a9c-995b1def8c26",
          "name" : "Migrate-dddd"
        } ],
        "disk" : [ {
          "id" : "0",
          "index" : 0,
          "name" : "Disk 0",
          "diskType" : "SATA",
          "size" : 40,
          "device_use" : "BOOT"
        } ],
        "volumetype" : "SATA",
        "publicip" : {
          "type" : "5_g-vm",
          "bandwidth_size" : 10,
          "bandwidth_share_type" : "PER"
        }
      }
    }

响应示例

状态码: 200

OK

{
  "id" : "2bf4344f-8f1f-414e-bb1b-8c2f59ada67f"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品