All Products
Search

This Product

    Resource Orchestration Service:SetTemplatePermission

    Document Center

    Resource Orchestration Service:SetTemplatePermission

    Last Updated:Jun 03, 2026

    Shares or unshares a template.

    Operation description

    In this example, the template whose ID is 5ecd1e10-b0e9-4389-a565-e4c15efc**** is shared with an Alibaba Cloud account. The ID of the Alibaba Cloud account is 151266687691****.

    Note

    The recipient Alibaba Cloud account (ID: 151266687691****) can authorize RAM users to use the shared 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

    ros:SetTemplatePermission

    update

    *Template

    acs:ros:{#regionId}:{#accountId}:template/{#TemplateId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ShareOption

    string

    Yes

    The sharing option.

    Valid values:

    • ShareToAccounts: shares the template with other Alibaba Cloud accounts.

    • CancelSharing: unshares the template.

    ShareToAccounts
    VersionOption

    string

    No

    The version option for the shared template. This parameter takes effect only if you set ShareOption to ShareToAccounts.

    Valid values:

    • AllVersions (default): shares all versions of the template.

    • Latest: shares only the latest version of template. When the version of the template is updated, ROS updates the shared version to the latest version.

    • Current: shares only the current version of the template. When the version of the template is updated, ROS does not update the shared version.

    • Specified: shares only the specified version of the template.

    Specified
    TemplateVersion

    string

    No

    The version of the shared template. This parameter takes effect only if you set ShareOption to ShareToAccounts and set VersionOption to Specified.

    Valid values: v1 to v100.

    v1
    TemplateId

    string

    Yes

    The ID of the template.

    5ecd1e10-b0e9-4389-a565-e4c15efc****
    AccountIds

    array

    Yes

    The Alibaba Cloud accounts with or from which you want to share or unshare the template.
    Valid values of N: 1, 2, 3, 4, and 5.

    Note

    • This parameter cannot be set to the ID of the Alibaba Cloud account that owns the template, or the RAM users of this Alibaba Cloud account.

    • When ShareOption is set to CancelSharing, you can unshare the template from all the specified Alibaba Cloud accounts by using an asterisk (*).

    151266687691****

    string

    No

    The Alibaba Cloud account with or from which you want to share or unshare the template.
    Valid values of N: 1, 2, 3, 4, and 5.

    Note

    • This parameter cannot be set to the ID of the Alibaba Cloud account that owns the template, or the RAM users of this Alibaba Cloud account.

    • When ShareOption is set to CancelSharing, you can unshare the template from all the specified Alibaba Cloud accounts by using an asterisk (*).

    100406424347****

    For more information about common request parameters, see Common parameters.

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    B288A0BE-D927-4888-B0F7-B35EF84B6E6F

    Examples

    Success response

    JSON format

    {
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.