RenderServicesByTemplate-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

devs:RenderServicesByTemplate

none

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	Template configuration
templateName	string	Yes	Template name	start-springboot
parameters	object	No	Template parameters	{"region":"cn-hangzhou"}
variableValues	TemplateVariableValueMap	No	Template variables
serviceNameChanges	object	No	A map for renaming services. The key is the original service name from the template, and the value is the new service name.	{"svc1":"svc2"}
	string	No	New service name	{"originName": "newName"}
projectName	string	No	The name of the project to which services will be added. When a project name is provided, the operation checks for naming conflicts between services in the template and those already in the project. If a conflict is found, the operation automatically generates a unique service name.	my-project

Response elements

Element	Type	Description	Example
	object
services	object	A map of the parsed services.
	ServiceConfig	Service configuration
variables	object	A map of the parsed variables.
	Variable	Variable configuration
changedServiceNames	object	A map of changed service names where the key is the new service name and the value is the original service name. This tracking enables you to modify names multiple times before deployment.
	string	Original service name	demo-service

Examples

Success response

JSON format

{
  "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"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.