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

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

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

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • typeString

      类型

    • templateContentString

      资源编排内容(Json)

    • uuidString

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

    • parametersString

      参数列表(Json)

    • preparametersString

      预渲染参数列表(Json)

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • resourcesList必填

    详情参考resources

    • resourceNameString必填

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

    • resourceTypeString必填

      ZStack Cloud中的资源类型

    • deletePolicyString必填

      删除策略

    • descriptionString必填

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

    • inDegreeSet必填

      依赖的资源列表

    • actionString必填

      后续的操作行为

    • propertiesMap必填

      操作参数

    • resultsObject必填

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

    • createdboolean必填

      是否己创建

    • mockFailedboolean必填

      测试用于mock失败

    • typeResourceType必填

      详情参考type

      • nameString必填

        资源类型(Resource或者Action)

      • ordinalint必填

        暂无描述。

请求地址

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

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

操作 ID

DecodeStackTemplate

永久链接

请求示例

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>"]}'

响应示例

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 } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史