跳转到主要内容
API Explorer|API Explorer
资源中心/资源编排/资源编排相关接口
POSTCloudFormation Operations起始版本 2.5.0同步需要认证

预览资源栈

预览资源栈

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • typeString

      可选。

    • templateContentString

      模板内容

    • uuidString

      模板的UUID

    • parametersString

      参数列表，json字符串

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • previewPreviewResourceStruct必填

    详情参考preview

    • conditionsMap必填

      条件的执行结果

    • actionsList必填

      详情参考actions

      • resourceNameString必填

        资源类型

      • actionNameString必填

        行为名称

      • roundint必填

        第几轮执行，从0开始计算

      • inDegreeSet必填

        依赖的行为列表

      • actionsObject必填

        执行操作的参数列表

请求地址

POST/zstack/v1/cloudformation/stack/preview

/zstack/v1/cloudformation/stack/preview

操作 ID

PreviewResourceStack

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/cloudformation/stack/preview' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"type":"<type>","templateContent":"<templateContent>","uuid":"<uuid>","parameters":"<parameters>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "preview": { "actions": [ { "resourceName": "WebServer1", "actionName": "org.zstack.sdk.CreateVmInstanceAction", "round": 0.0, "inDegree": [], "actions": { "name": "vm", "instanceOfferingUuid": "f524c10459ce32f0b70a1c0878769b2d", "imageUuid": "66296cfc1c6d36fa8405788cb2fb85a0", "l3NetworkUuids": [ "e99fce59e6463758aef45bdfc5579203" ], "strategy": "InstantStart", "timeout": -1.0, "pollingInterval": -1.0 } } ], "conditions": { "WithDataVolume": false } } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史