All Products
Search
Document Center

Resource Orchestration Service:SetTemplatePermission

Last Updated:Jul 17, 2024

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /V2/SetTemplatePermission

GET /V2/SetTemplatePermission

Request parameters

ParameterTypeRequiredDescriptionExample
ShareOptionstringYes

The sharing option.

Valid values:

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

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
TemplateVersionstringNo

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
TemplateIdstringYes

The ID of the template.

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

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 (*).
  • stringYes

    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 (*).
  • 147322325937****

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

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    B288A0BE-D927-4888-B0F7-B35EF84B6E6F

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history