跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/弹性伸缩组相关接口
POSTAuto-Scaling Group Operations起始版本 3.1.0同步需要认证

创建伸缩组云主机模块

创建伸缩组云主机模块

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • vmInstanceNameString必填

      云主机名称

    • vmInstanceDescriptionString

      云主机描述

    • vmInstanceOfferingUuidString必填

      云主机实例规则

    • imageUuidString必填

      云主机镜像UUID

    • l3NetworkUuidsList必填

      云主机三层网络列表

    • rootDiskOfferingUuidString

      云主机根云盘规格

    • dataDiskOfferingUuidsList

      数据盘规格列表

    • vmInstanceZoneUuidString

      云主机所属地区

    • vmInstanceClusterUuidString

      云主机所属集群

    • hostUuidString

      物理机UUID

    • primaryStorageUuidForRootVolumeString

      根云盘主存储UUID

    • defaultL3NetworkUuidString必填

      云主机默认三层网络

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • typeString

      模板类型

    • resourceUuidString

      资源UUID。若指定，资源会使用该字段值作为UUID。

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryAutoScalingTemplateInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • typeString必填

      模板类型

    • stateString必填

      模板启用状态

    • systemTagsList必填

      系统标签。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

POST/zstack/v1/autoscaling/vmtemplate

/zstack/v1/autoscaling/vmtemplate

操作 ID

CreateAutoScalingVmTemplate

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/autoscaling/vmtemplate' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"vmInstanceName":"<vmInstanceName>","vmInstanceDescription":"<vmInstanceDescription>","vmInstanceOfferingUuid":"<vmInstanceOfferingUuid>","imageUuid":"<imageUuid>","l3NetworkUuids":["<l3NetworkUuids>"],"rootDiskOfferingUuid":"<rootDiskOfferingUuid>","dataDiskOfferingUuids":["<dataDiskOfferingUuids>"],"vmInstanceZoneUuid":"<vmInstanceZoneUuid>","vmInstanceClusterUuid":"<vmInstanceClusterUuid>","hostUuid":"<hostUuid>","primaryStorageUuidForRootVolume":"<primaryStorageUuidForRootVolume>","defaultL3NetworkUuid":"<defaultL3NetworkUuid>","name":"<name>","description":"<description>","type":"<type>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "name": "template", "description": "desc", "state": "Enabled" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史