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

检查资源栈模板参数

检查资源栈模板参数

POST/zstack/v1/cloudformation/stack/check

操作 ID

CheckStackTemplateParameters

起始版本

2.5.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • type
      String

      模板类型，默认为zstack

    • templateContent
      String

      模板内容，json字符串

    • uuid
      String必填

      模板的UUID

  • 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

  • parametes
    List必填

    详情参考parametes

    • paramName
      String必填

      参数名称

    • type
      String必填

      参数类型

    • defaultValue
      String必填

      默认值

    • description
      String必填

      资源的详细描述

    • noEcho
      Boolean必填

      是否在输出中显示

    • label
      String必填

      前端显示名称

    • constraintDescription
      String必填

      若校验失败，返回内容

    • resourceType
      String必填

      若参数为ZStack Cloud资源，返回资源类型，否则返回null