功能介绍
创建 弹性伸缩 配置。
- 伸缩配置是伸缩组内实例(弹性 云服务器 )的模板,定义了伸缩组内待添加的实例的规格数据。
- 伸缩配置与伸缩组是解耦的,同一伸缩配置可以被多个伸缩组使用。
- 默认最多可以创建100个伸缩配置。
调试
您可以在API Explorer中调试该接口。
URI
POST /autoscaling-api/v1/{project_id}/scaling_configuration
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
scaling_configuration_name |
是 |
String |
伸缩配置名称(1-64个字符),只能包含中文、字母、数字、下划线或中划线。 |
instance_config |
是 |
Object |
参数 |
是否必选 |
参数类型 |
---|---|---|
instance_id |
否 |
String |
flavorRef |
否 |
String |
imageRef |
否 |
String |
disk |
否 |
|
key_name |
否 |
String |
personality |
否 |
|
public_ip |
否 |
|
user_data |
否 |
String |
metadata |
否 |
|
security_groups |
否 |
|
server_group_id |
否 |
String |
tenancy |
否 |
String |
dedicated_host_id |
否 |
String |
multi_flavor_priority_policy |
否 |
String |
market_type |
否 |
String |
对于Linux弹性 云服务 器,如果需要注入密码,只能使用userdata进行注入;对于Windows弹性云服务器,如果需要注入密码,只能通过元数据admin_pass进行注入。
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
size |
是 |
Integer |
磁盘大小,容量单位为GB。 系统盘输入大小范围为1~1024,且不小于 镜像 中系统盘的最小(min_disk属性)值。 数据盘输入大小范围为10~32768。 |
volume_type |
是 |
String |
云服务器系统盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。 目前支持“SATA”,“SAS”,“GPSSD”,“SSD”,“ESSD”。
当指定的云硬盘类型在avaliability_zone内不存在时,则创建云硬盘失败。 说明:
不同云服务器规格支持的磁盘类型不同,本文仅供参考,具体支持的磁盘类型请以控制台界面显示为准。 说明:
|
disk_type |
是 |
String |
标识系统盘还是数据盘,枚举值如下:
|
dedicated_storage_id |
否 |
String |
云服务器的磁盘可指定创建在用户的专属存储中,需要指定专属存储ID。 说明:
同一个伸缩配置中的磁盘需统一指定或统一不指定专属存储,不支持混用;当指定专属存储时,所有专属存储需要属于同一个可用区,且每个磁盘选择的专属存储支持的磁盘类型都需要和参数volume_type保持一致。 |
data_disk_image_id |
否 |
String |
指定特定ID的数据盘镜像,用以导出云服务器的数据盘。 |
snapshot_id |
否 |
String |
当选择使用整机镜像时,云服务器的系统盘及数据盘将通过整机备份恢复,需要指定磁盘备份的快照ID。 说明:
磁盘备份的快照ID可通过镜像的整机备份ID在CSBS查询单个备份中获得;一个伸缩配置中的每一个disk需要通过snapshot_id和整机备份中的磁盘备份一一对应。 |
metadata |
否 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
__system__encrypted |
否 |
String |
metadata中的表示加密功能的字段,0代表不加密,1代表加密。 该字段不存在时,云硬盘默认为不加密。 说明:
系统盘不支持加密。 |
__system__cmkid |
否 |
String |
用户主密钥ID,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。 说明:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
path |
是 |
String |
注入文件路径信息。
|
content |
是 |
String |
注入文件内容。 该值应指定为注入文件的内容进行base64格式编码后的信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ip_type |
是 |
String |
弹性IP地址类型。 类型枚举值:
|
bandwidth |
是 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
size |
否 |
Integer |
带宽(Mbit/s),按带宽分配取值范围为[1,2000],按流量分配取值范围为[1,300]。 说明:
|
share_type |
是 |
String |
带宽的共享类型。 共享类型枚举:
|
charging_mode |
否 |
String |
带宽的计费类型。 计费类型枚举:
若字段为其它值,会导致创建云服务器失败。
说明:
|
id |
否 |
String |
带宽ID,使用共享型带宽时,可以选择之前创建的共享带宽来创建弹性IP,详情请见查询带宽列表。 说明:
|
请求示例
POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration { "scaling_configuration_name": "as-config-tlzq", "instance_config": { "flavorRef": "s3.xlarge.4", "imageRef": "627a1223-2ca3-46a7-8d5f-7aef22c74ee6", "disk": [ { "size": 40, "volume_type": "SATA", "disk_type": "SYS" } ], "key_name": "100vm_key" , "security_groups": [{ "id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" }], "multi_flavor_priority_policy": "PICK_FIRST" } }
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
scaling_configuration_id |
String |
伸缩配置ID。 |
响应示例
{ "scaling_configuration_id": "f8327883-6a07-4497-9a61-68c03e8e72a2" }
返回值
- 正常
- 异常
返回值
说明
400 Bad Request
服务器未能处理请求。
401 Unauthorized
被请求的页面需要用户名和密码。
403 Forbidden
对被请求的页面访问禁止。
404 Not Found
服务器无法找到被请求的页面。
405 Method Not Allowed
请求中指定的方法不被允许。
406 Not Acceptable
服务器生成的响应无法被客户端所接受。
407 Proxy Authentication Required
用户必须首先使用代理服务器进行验证,这样请求才会被处理。
408 Request Timeout
请求超出了服务器的等待时间。
409 Conflict
由于冲突,请求无法被完成。
500 Internal Server Error
请求未完成。服务异常。
501 Not Implemented
请求未完成。服务器不支持所请求的功能。
502 Bad Gateway
请求未完成。服务器从上游服务器收到一个无效的响应。
503 Service Unavailable
请求未完成。系统暂时异常。
504 Gateway Timeout
网关超时。
错误码
请参考错误码。