Skip to main content
API Explorer|API Explorer
Resource Center/CloudFormation Operations
POSTCloudFormation OperationsSince 3.0.0SynchronousAuth Required

DecodeStackTemplate

DecodeStackTemplate

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • typeString

      Optional. The template type.

    • templateContentString

      Optional. The template content.

    • uuidString

      Optional. The template UUID.

    • parametersString

      Optional. The request parameters in JSON format.

    • preparametersString

      Optional. The pre-rendered request parameters in JSON format.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

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

    • codeStringRequired

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

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

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

  • resourcesListRequired

    For more information, see resources.

    • resourceNameStringRequired

      The resource name in the stack template.

    • resourceTypeStringRequired

      The resource type.

    • deletePolicyStringRequired

      The deletion policy.

    • descriptionStringRequired

      The resource description in the stack template.

    • inDegreeSetRequired

      The dependent resources.

    • actionStringRequired

      The action.

    • propertiesMapRequired

      The properties.

    • resultsObjectRequired

      The operation results. An empty string is returned if no operation is performed.

    • createdbooleanRequired

      Indicates whether the resources are created.

    • mockFailedbooleanRequired

      Indicates whether mock failed.

    • typeResourceTypeRequired

      For more information, see type.

      • nameStringRequired

        The resource type.

      • ordinalintRequired

        No description provided.

Endpoint

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

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

Operation ID

DecodeStackTemplate

Permalink

Request Example

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

Response Example

200
{ "resources": [ { "resourceName": "WebServer", "resourceType": "VmInstance", "deletePolicy": "Retain", "inDegree": [ "l3", "instanceOfferingUuid", "addDns", "imageUuid" ], "properties": { "uuid": "d55161ef863942d8a53a4f8448074749" }, "type": "Resource", "created": false, "mockFailed": false }, { "resourceName": "l3", "resourceType": "L3Network", "inDegree": [ "l2NetworkUuid" ], "properties": { "uuid": "d55161ef863942d8a53a4f8448074749" }, "type": "Resource", "created": false, "mockFailed": false }, { "resourceName": "addIpRange", "inDegree": [ "l3" ], "properties": { "uuid": "d55161ef863942d8a53a4f8448074749" }, "type": "Action", "created": false, "mockFailed": false }, { "resourceName": "addDns", "inDegree": [ "l3", "addIpRange" ], "properties": { "uuid": "d55161ef863942d8a53a4f8448074749" }, "type": "Action", "created": false, "mockFailed": false }, { "resourceName": "imageUuid", "resourceType": "Image", "inDegree": [], "properties": { "uuid": "d55161ef863942d8a53a4f8448074749" }, "type": "Resource", "created": true, "mockFailed": false }, { "resourceName": "instanceOfferingUuid", "resourceType": "InstanceOffering", "inDegree": [], "properties": { "uuid": "d55161ef863942d8a53a4f8448074749" }, "type": "Resource", "created": true, "mockFailed": false }, { "resourceName": "l2NetworkUuid", "resourceType": "L2Network", "inDegree": [], "properties": { "uuid": "d55161ef863942d8a53a4f8448074749" }, "type": "Resource", "created": true, "mockFailed": false } ] }

Change History

This API has no change history records yet.

View all change history