RenderServicesByTemplate - 解析模板中的服务以及变量配置_云原生应用开发平台(CAP)-阿里云帮助中心

解析模板中的服务以及变量配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
devs:RenderServicesByTemplate	none	全部资源 ``	无	无

请求语法

POST /2023-07-14/templates/action/renderServices HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	模板配置
templateName	string	是	模板名称	start-springboot
parameters	object	否	模板参数	{"region":"cn-hangzhou"}
variableValues	TemplateVariableValueMap	否	模板变量
serviceNameChanges	object	否	服务名称变化，key 是模板原始服务名，value 是需要修改的目标服务名
	string	否	修改后的目标服务名称	{"originName": "newName"}
projectName	string	否	项目名称，用于在已有项目中通过模板新增服务的场景。当指定时，会检测模板中的服务名和指定项目中的服务是否存在命名冲突，如果冲突时会自动生成新的服务名称。	my-project

返回参数

名称	类型	描述	示例值
	object
services	object	解析后的服务集合
	ServiceConfig	服务配置
variables	object	解析后的变量集合
	Variable	变量配置
changedServiceNames	object	变化后的服务名称。key 是新的服务名称，value 是原始服务名称。通过这个字段，可以记录模板的原始服务名称，实现部署前的不断修改名称
	string	原始服务名称	demo-service

示例

正常返回示例

JSON格式

{
  "services": {
    "key": {
      "props": {
        "test": "test",
        "test2": 1
      },
      "source": {
        "template": {
          "downloadUrl": "https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6",
          "name": "start-springboot-cap"
        },
        "repository": {
          "repositoryName": "my-repository",
          "codeVersion": {
            "branch": "main",
            "commitID": "12721ec262d03a93809ba2bbc717963cb298ceca"
          },
          "filter": {
            "branch": {
              "name": "master"
            }
          }
        },
        "oss": {
          "bucket": "demo-bucket",
          "object": "demo-object"
        }
      },
      "build": {
        "default": {
          "cache": {
            "driver": "",
            "paths": [
              "~/.npm"
            ],
            "keyPath": {
              "3C75C832-0EAD-40D6-8FA1-2BA9171C926B": "~/.npm",
              "D256BB7A-1886-4A19-A75B-A1FDC23D5A00": "~/.cache"
            }
          },
          "languages": [
            "Python3.9"
          ],
          "rootPath": "./src",
          "steps": [
            {
              "run": "npm build"
            }
          ]
        }
      },
      "variables": {
        "key": {
          "value": "object_value",
          "sensitive": false,
          "encrypted": false
        }
      },
      "initialize": {
        "steps": [
          {
            "run": "npm build"
          }
        ]
      },
      "type": "Function",
      "finalize": {
        "steps": [
          {
            "run": "echo 'deleted'"
          }
        ]
      },
      "token": "9D72DE01-C732-49C0-8E85-FFD9D695436B",
      "component": "fc3@1.0.0",
      "artifact": {
        "name": "my-artifact",
        "checksum": "CRC-64 code"
      }
    }
  },
  "variables": {
    "key": {
      "value": "object_value",
      "sensitive": false,
      "encrypted": false
    }
  },
  "changedServiceNames": {
    "key": "demo-service"
  }
}

错误码

访问错误中心查看更多错误码。