All Products
Search

This Product

    Logic Composer:GetTemplate

    Document Center

    Logic Composer:GetTemplate

    Last Updated:Dec 12, 2025

    Retrieves the details of an orchestration template.

    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

    composer:GetTemplate

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TemplateId

    string

    Yes

    The template ID.

    tp-uf6tbvhheciyxl

    Response elements

    Element

    Type

    Description

    Example

    object

    UpdateTime

    string

    The time when the template was last updated.

    2020-08-19T03:31:32.415Z
    TemplateOverview

    string

    The overview of the template. This is a JSON string.

    []
    TemplateConnector

    string

    A list of connectors used in the template, separated by commas.

    config,oss
    CreateTime

    string

    The time when the template was created.

    2020-08-19T03:31:32.415Z
    TemplateSummaryEn

    string

    The summary in English.

    This is a test template
    TemplateName

    string

    The title of the template.

    测试模板
    TemplateVersion

    integer

    The version of the template. The value is a number that increments from 0.

    0
    TemplateCreator

    string

    The publisher of the template.

    逻辑编排
    TemplateLocale

    string

    The language of the template. Currently, Chinese (zh) and English (en) are supported.

    zh
    RegionId

    string

    The region where the template is located.

    cn-shanghai
    TemplateDescription

    string

    The description of the template.

    该模板仅用于测试用途
    TemplateTag

    string

    The tag of the template.

    test,owner
    Definition

    string

    The definition of the template.

    {"actions": {},"schemaVersion":"2018-12-12","version": "1.0.0"}
    RequestId

    string

    The unique identifier of the current request.

    BCF7212F-9478-569A-B57C-8C1B5A560C2F
    TemplateSummary

    string

    A brief introduction to the template.

    这是一个测试模板
    TemplateId

    string

    The template ID.

    tp-uf6tbvhheciyxl

    Examples

    Success response

    JSON format

    {
  "UpdateTime": "2020-08-19T03:31:32.415Z",
  "TemplateOverview": "[]",
  "TemplateConnector": "config,oss",
  "CreateTime": "2020-08-19T03:31:32.415Z",
  "TemplateSummaryEn": "This is a test template",
  "TemplateName": "测试模板",
  "TemplateVersion": 0,
  "TemplateCreator": "逻辑编排",
  "TemplateLocale": "zh",
  "RegionId": "cn-shanghai",
  "TemplateDescription": "该模板仅用于测试用途",
  "TemplateTag": "test,owner",
  "Definition": "{\"actions\": {},\"schemaVersion\":\"2018-12-12\",\"version\": \"1.0.0\"}",
  "RequestId": "BCF7212F-9478-569A-B57C-8C1B5A560C2F",
  "TemplateSummary": "这是一个测试模板",
  "TemplateId": "tp-uf6tbvhheciyxl"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.