Skip to main content
ZStack
Resource Center/CloudFormation Operations

CreateResourceStack

CreateResourceStack

POST/zstack/v1/cloudformation/stack

Operation ID

CreateResourceStack

Since

2.5.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • name
      StringRequired

      The resource name.

    • description
      String

      Optional. The detailed description of the resource.

    • type
      String

      Optional. The stack type. Default type: zstack.

    • rollback
      Boolean

      Optional. Whether to roll back if stack creation fails. By default, rollback is performed on failure.

    • templateContent
      String

      Optional. The stack content, which is a JSON string.Note: Make sure that at least one of templateContent and templateUuid is not null.

    • templateUuid
      String

      Optional. The template UUID.Note: Make sure that at least one of templateContent and templateUuid is not null.

    • parameters
      StringRequired

      The parameters in the stack. The parameters are JSON strings.

    • resourceUuid
      String

      Optional. The resource UUID.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventory
    ResourceStackInventoryRequired

    See inventory.

    • uuid
      StringRequired

      The resource UUID.

    • name
      StringRequired

      The resource name.

    • description
      StringRequired

      The detailed description of the resource.

    • version
      StringRequired

      The stack version.

    • type
      StringRequired

      The stack type. Default type: zstack.

    • templateContent
      StringRequired

      The stack content, which is a JSON string.

    • paramContent
      StringRequired

      The parameters in the stack. The parameters are JSON strings.

    • status
      StringRequired

      The stack status.

    • reason
      StringRequired

      The reason for stack creation failure.

    • enableRollback
      booleanRequired

      Whether to roll back if stack creation fails.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.