更新时间:2022-08-02 GMT+08:00

新增模板信息

功能介绍

新增源端模板信息

URI

POST /v1/sms/vm/template

请求消息

请求参数

请求参数如表1所示。

表1 参数说明

参数

是否必选

参数类型

描述

template

String

模板信息,请参见表2

disks

String

磁盘信息,请参见表7

表2 template信息

参数

是否必选

参数类型

描述

name

String

模板名称

is_template

Boolean

是否是模板,单击按钮保存时该值为true,没有单击保存模板直接创建任务时该值为false

region

String

区域

target_server_name

String

目的端名称

availability_zone

String

可用区

volumetype

String

磁盘类型

vpc

Object

Vpc信息,自动创建时为{},请参见表3

security_groups

Array

安全组,自动创建时为[],请参见表4

nics

Array

子网,自动创建时为[],请参见表5

flavors

Array

规格,自动创建时为[]。

publicip

Object

弹性公网IP,请参见表6

表3 vpc信息

参数

是否必选

参数类型

描述

id

String

VPC ID

name

String

VPC 名称

表4 security_groups信息

参数

是否必选

参数类型

描述

id

String

安全组ID

name

String

安全组名称

表5 nics信息

参数

是否必选

参数类型

描述

id

String

子网ID

name

String

名称

cidr

String

网关/掩码

ip

String

私有IP

表6 publicip信息

参数

是否必选

参数类型

描述

id

String

ID,新增必填

ip

String

弹性IP,新增必填

type

String

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

bandwidth_size

Integer

功能说明:带宽大小带宽(Mbit/s),取值范围为[1,2000]。

调整带宽时的最小单位会根据带宽范围不同存在差异。小于等于300Mbit/s:默认最小单位为1Mbit/s。300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。大于1000Mbit/s:默认最小单位为500Mbit/s。

说明:

如果share_type是PER,该参数必选项;如果share_type是WHOLE并且id有值,该参数会忽略。

bandwidth_share_type

String

带宽的共享类型。共享类型枚举:PER,表示独享。WHOLE,表示共享。默认使用PER

表7 disk信息

参数

是否必选

参数类型

描述

index

Integer

磁盘序号,从0开始

name

String

磁盘名称

disktype

String

磁盘类型,同volumetype字段

size

Integer

磁盘大小,GB

响应消息

表8 响应信息

参数

参数类型

描述

id

String

ID

示例

  • 请求示例

    POST /v1/sms/vm/template

    {
        "template": {       
            "name": "模板名称",
            "is_template":"false",// 创建任务为false,保存模板为true
            
            
            
            
            "region":"my-kualalumpur-1",
            
            "target_server_name":"目的端1",
            "availability_zone":"az1-dc1", //可用区名称
            "volumetype": "DESS_SSD_FC",
            "vpc": {
              "id":"0dae26c9-9a70-4392-93f3-87d53115d171",
              "name":"vpc1" 
            },
            "security_groups":[
              {
    	    "id":"507ca48f-814c-4293-8706-300564d54620", 
                "name":"default"
    	   }
             ], 
            "nics":[
              {
                "id":"157ee789-03ea-45b1-a698-76c92660dd83",
                "name": "subnet-1637",
                "cidr": "192.168.0.0/24",
    	    "ip":"192.168.0.0"
               }
            ],
            "flavors":c3.2xlarge.4,               
            "publicip":  {
                 "id":"1111",
                 "ip ":"x.x.x.x",
                 "type": "5_bgp",
                 "bandwidth_size":10,
                 "bandwidth_share_type":"PER"
            }
        },
        "disks":[
          {
            "index":0,
            "name":"磁盘01",
            "disktype":"DESS_SSD_FC",
            "size":40
         }
        ]
    }

  • 响应示例
    {
      "id": "aaaa-bbbb-cccc-dddd"
    }

状态码

状态码请参见状态码