跳转到主要内容
API Explorer|API Explorer
裸金属管理/裸金属模板相关接口
PUTBare Metal Template Related Interfaces起始版本 3.4.0同步需要认证

修改预配置模板状态

修改预配置模板状态

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • stateEventString必填

    状态事件。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryPreconfigurationTemplateInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • distributionString必填

      适用操作系统发行版

    • typeString必填

      模板类型

    • contentString必填

      模板内容

    • md5sumString必填

      模板MD5

    • isPredefinedBoolean必填

      是否系统预置

    • stateString必填

      状态

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

PUT/zstack/v1/baremetal/preconfigurations/{uuid}/actions

/zstack/v1/baremetal/preconfigurations/{uuid}/actions

操作 ID

ChangePreconfigurationTemplateState

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/baremetal/preconfigurations/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"stateEvent":"<stateEvent>","systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "edf8b9576a5d408fb135c20aa7dcefd3", "name": "centos_7_x86_64_mini_v1.cfg", "description": "centos-7-minimal kickstart file", "distribution": "centos-7-x86_64", "type": "kickstart", "content": "...", "md5sum": "f79f67ab6c3445029b187d14bf7e3b99", "isPredefined": false, "state": "Enabled", "createDate": "Aug 15, 2025 5:33:55 AM", "lastOpDate": "Aug 15, 2025 5:33:55 AM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史