跳转到主要内容
ZStack
资源中心/资源编排/资源编排相关接口

从资源编排模板解析成资源关系图

从资源编排模板解析成资源关系图

POST/zstack/v1/cloudformation/stack/preview/resource

操作 ID

DecodeStackTemplate

起始版本

3.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • type
      String

      类型

    • templateContent
      String

      资源编排内容(Json)

    • uuid
      String

      资源编排模板的UUID，唯一标示该资源

    • parameters
      String

      参数列表(Json)

    • preparameters
      String

      预渲染参数列表(Json)

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

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

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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

  • resources
    List必填

    详情参考resources

    • resourceName
      String必填

      资源编排模板中的资源名称

    • resourceType
      String必填

      ZStack Cloud中的资源类型

    • deletePolicy
      String必填

      删除策略

    • description
      String必填

      资源编排模板中的资源描述

    • inDegree
      Set必填

      依赖的资源列表

    • action
      String必填

      后续的操作行为

    • properties
      Map必填

      操作参数

    • results
      Object必填

      操作完成后的结果，若还未执行操作，则为空

    • created
      boolean必填

      是否己创建

    • mockFailed
      boolean必填

      测试用于mock失败

    • type
      ResourceType必填

      详情参考type

      • name
        String必填

        资源类型(Resource或者Action)

      • ordinal
        int必填

        ordinal数量。