すべてのプロダクト
Search

このプロダクト

    :GetTemplate

    ドキュメントセンター

    :GetTemplate

    最終更新日:Jun 03, 2026

    スタックやスタックグループ、変更セット、または任意のカスタムテンプレート情報をもとに、テンプレートの詳細を取得します。

    操作説明

    この例では、ID が 5ecd1e10-b0e9-4389-a565-e4c15efc**** のテンプレートの詳細を照会します。 テンプレートのリージョン ID は cn-hangzhou です。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ros:GetTemplate

    get

    stack

    acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

    template

    acs:ros:*:{#accountId}:template/{#templateId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    StackId

    string

    任意

    スタックの ID です。

    説明

    StackId、ChangeSetId、StackGroupName、TemplateId のいずれか 1 つを指定する必要があります。

    4a6c9851-3b0f-4f5f-b4ca-a14bf691****
    RegionId

    string

    任意

    テンプレートを使用するスタックまたはスタックグループのリージョン ID です。DescribeRegions API を呼び出して、最新のリージョンリストを取得できます。

    cn-hangzhou
    ChangeSetId

    string

    任意

    変更セットの ID です。

    説明

    StackId、ChangeSetId、StackGroupName、TemplateId のいずれか 1 つを指定する必要があります。

    1f6521a4-05af-4975-afe9-bc4b45ad****
    TemplateId

    string

    任意

    テンプレートの ID です。

    このパラメーターは、共有テンプレートとプライベートテンプレートに適用されます。テンプレートが共有テンプレートの場合、TemplateId の値は TemplateARN の値と同じです。テンプレート ID を使用して共有テンプレートを照会できます。

    説明

    StackId、ChangeSetId、StackGroupName、TemplateId のいずれか 1 つを指定する必要があります。

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

    string

    任意

    テンプレートのバージョンです。このパラメーターは、TemplateId を指定した場合にのみ有効です。
    テンプレートが共有テンプレートの場合、VersionOption を AllVersions に設定した場合にのみ、このパラメーターを指定できます。詳細については、「SetTemplatePermission API」をご参照ください。

    有効な値は v1～v100 です。

    v1
    TemplateStage

    string

    任意

    テンプレートのステージです。このパラメーターは、StackId、ChangeSetId、または StackGroupName を指定した場合にのみ有効です。

    有効な値：

    • Processed (デフォルト)：処理済みのテンプレートを返します。

    • Original：オリジナルのテンプレートを返します。

    Processed
    IncludePermission

    string

    任意

    テンプレートの共有情報を照会するかどうかを指定します。有効な値：

    • Enabled

    • Disabled (デフォルト)

    説明

    テンプレートの共有情報を照会できるのは、テンプレートの所有者のみです。

    Enabled
    StackGroupName

    string

    任意

    スタックグループの名前です。

    説明

    StackId、ChangeSetId、StackGroupName、TemplateId のいずれか 1 つを指定する必要があります。

    MyStackGroup
    IncludeTags

    string

    任意

    タグの情報を照会するかどうかを指定します。有効な値：

    • Enabled

    • Disabled (デフォルト)

    説明

    このパラメーターは、TemplateId を指定した場合にのみ有効です。

    Enabled

    共通リクエストパラメータの詳細は、「共通パラメータ」をご参照ください。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TemplateARN

    string

    テンプレートの Alibaba Cloud リソースネーム (ARN) です。このパラメーターは、TemplateId を指定した場合にのみ返されます。

    acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****
    Description

    string

    テンプレートの説明です。このパラメーターは、TemplateId を指定した場合にのみ返されます。

    ROS template for create ECS instance.
    RequestId

    string

    リクエストの ID です。

    B288A0BE-D927-4888-B0F7-B35EF84****
    CreateTime

    string

    テンプレートが作成された時刻です。このパラメーターは、TemplateId を指定した場合にのみ返されます。

    説明

    • TemplateVersion を指定した場合、TemplateVersion で指定したバージョンのテンプレートの作成時刻が返されます。

    • TemplateVersion を指定しない場合、デフォルトバージョンのテンプレートの作成時刻が返されます。

    2020-11-18T08:49:26
    StackGroupName

    string

    スタックグループの名前です。このパラメーターは、StackGroupName を指定した場合にのみ返されます。

    MyStackGroup
    TemplateVersion

    string

    テンプレートのバージョンです。このパラメーターは、TemplateId を指定した場合にのみ返されます。
    TemplateVersion が指定されていない、または有効でない場合は、デフォルトバージョンが使用されます。

    テンプレートが共有テンプレートの場合、このパラメーターは VersionOption を AllVersions に設定した場合にのみ返されます。

    v1
    TemplateBody

    string

    テンプレートの内容です。

    {"ROSTemplateFormatVersion": "2015-09-01"}
    ChangeSetId

    string

    変更セットの ID です。このパラメーターは、ChangeSetId を指定した場合にのみ返されます。

    e85abe0c-6528-43fb-ae93-fdf8de22****
    OwnerId

    string

    テンプレートが属する Alibaba Cloud アカウントの ID です。このパラメーターは、TemplateId を指定した場合にのみ返されます。

    151266687691****
    UpdateTime

    string

    テンプレートが最後に更新された時刻です。このパラメーターは、TemplateId を指定した場合にのみ返されます。

    説明

    • TemplateVersion を指定した場合、TemplateVersion で指定したバージョンのテンプレートの最終更新時刻が返されます。

    • TemplateVersion を指定しない場合、デフォルトバージョンのテンプレートの最終更新時刻が返されます。

    2020-12-07T06:11:48
    Permissions

    array<object>

    テンプレートの共有状態の詳細です。このパラメーターは、TemplateId を指定し、IncludePermission を Enabled に設定した場合にのみ返されます。

    説明

    • TemplateVersion が指定されていない、または有効でない場合は、デフォルトバージョンのテンプレートの共有状態の詳細が返されます。

    • TemplateVersion が指定され、かつ有効な場合は、TemplateVersion で指定したバージョンのテンプレートの共有状態の詳細が返されます。

    object

    VersionOption

    string

    共有テンプレートのバージョンオプションです。このパラメーターは、ShareOption を ShareToAccounts に設定した場合にのみ返されます。

    有効な値：

    • AllVersions：すべてのテンプレートバージョンが共有されます。

    • Latest：最新のテンプレートバージョンのみが共有されます。テンプレートのバージョンが更新されると、ROS は共有バージョンを最新バージョンに更新します。

    • Current：最新のテンプレートバージョンのみが共有されます。テンプレートのバージョンが更新されても、ROS は共有バージョンを更新しません。

    • Specified：指定したテンプレートバージョンのみが共有されます。

    AllVersions
    AccountId

    string

    テンプレートの共有先である Alibaba Cloud アカウントの ID です。

    142437958638****
    ShareOption

    string

    共有オプションです。

    ShareToAccounts は、テンプレートが 1 つ以上の Alibaba Cloud アカウントと共有されることを示します。

    ShareToAccounts
    TemplateVersion

    string

    共有テンプレートのバージョンです。このパラメーターは、ShareOption を ShareToAccounts に設定し、VersionOption を Specified または Current に設定した場合にのみ返されます。

    有効な値：v1 ～ v100。

    v1
    ShareSource

    string

    リソース共有に使用されるサービスです。有効な値：

    • ROS：ROS コンソールを使用するか、または ROS API を呼び出すことで、ROS からリソースが共有されます。

    • ResourceDirectory：リソース共有機能を使用して、Resource Management からリソースディレクトリ内のアカウントにリソースが共有されます。

    説明

    • ROS から共有されるリソースの共有先アカウント数は、リソースディレクトリから共有されるリソースの共有先アカウント数とは独立しています。

    • ROS から共有されるリソースは、リソースディレクトリから共有されるリソースを上書きまたはオーバーライドできません。

    • リソースディレクトリから共有されるリソースは、ROS から共有されるリソースを上書きできます。

    ROS
    TemplateName

    string

    テンプレートの名前です。このパラメーターは、TemplateId を指定した場合にのみ返されます。

    説明

    • TemplateVersion を指定した場合、TemplateVersion で指定したバージョンのテンプレート名が返されます。

    • TemplateVersion を指定しない場合、デフォルトバージョンのテンプレート名が返されます。

    MyTemplate
    RegionId

    string

    テンプレートを使用するスタックまたはスタックグループのリージョン ID です。このパラメーターは、StackId、ChangeSetId、または StackGroupName を指定した場合にのみ返されます。

    cn-hangzhou
    TemplateId

    string

    テンプレートの ID です。このパラメーターは、TemplateId を指定した場合にのみ返されます。

    テンプレートが共有テンプレートの場合、このパラメーターの値は TemplateARN の値と同じです。

    a52f81be-496f-4e1c-a286-8852ab54****
    StackId

    string

    スタックの ID です。このパラメーターは、StackId を指定した場合にのみ返されます。

    4a6c9851-3b0f-4f5f-b4ca-a14bf691****

    ShareType

    string

    テンプレートの共有タイプです。このパラメーターは、TemplateId を指定した場合にのみ返されます。

    有効な値：

    • Private：テンプレートはテンプレートの所有者に属します。

    • Shared：テンプレートは他のユーザーによって共有されています。

    Private
    ResourceGroupId

    string

    リソースグループの ID です。

    rg-acfmxazb4ph6aiy****
    Interface

    string

    ROS コンソールにおける Web UI の説明です。

    {}
    Tags

    array<object>

    テンプレートのタグです。

    object

    テンプレートのタグです。

    Key

    string

    テンプレートのタグキーです。

    usage
    Value

    string

    テンプレートのタグ値です。

    test
    AdditionalInfo

    object

    公開テンプレートの補足情報です。

    {"DeploymentDuration":null,"Title":"Self-Built_ElasticSearch_Snapshot_Saved_To_OSS","Labels":{"ResourceTypes":["ALIYUN::ECS::Instance","ALIYUN::ECS::SecurityGroup","ALIYUN::ECS::VPC","ALIYUN::ECS::VSwitch","ALIYUN::OSS::Bucket","ALIYUN::ROS::WaitCondition","ALIYUN::ROS::WaitConditionHandle"],"DeployTypes":["ROS"],"ApplicationScenes":["other"]},"Provider":"ROS","Categories":["Solution"]}

    例

    成功レスポンス

    JSONJSON

    {
  "TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
  "Description": "ROS template for create ECS instance.",
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84****",
  "CreateTime": "2020-11-18T08:49:26",
  "StackGroupName": "MyStackGroup",
  "TemplateVersion": "v1",
  "TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
  "ChangeSetId": "e85abe0c-6528-43fb-ae93-fdf8de22****",
  "OwnerId": "151266687691****",
  "UpdateTime": "2020-12-07T06:11:48",
  "Permissions": [
    {
      "VersionOption": "AllVersions",
      "AccountId": "142437958638****",
      "ShareOption": "ShareToAccounts",
      "TemplateVersion": "v1",
      "ShareSource": "ROS"
    }
  ],
  "TemplateName": "MyTemplate",
  "RegionId": "cn-hangzhou",
  "TemplateId": "a52f81be-496f-4e1c-a286-8852ab54****",
  "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****\t",
  "ShareType": "Private",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "Interface": "{}",
  "Tags": [
    {
      "Key": "usage",
      "Value": "test"
    }
  ],
  "AdditionalInfo": {
    "DeploymentDuration": null,
    "Title": "Self-Built_ElasticSearch_Snapshot_Saved_To_OSS",
    "Labels": {
      "ResourceTypes": [
        "ALIYUN::ECS::Instance",
        "ALIYUN::ECS::SecurityGroup",
        "ALIYUN::ECS::VPC",
        "ALIYUN::ECS::VSwitch",
        "ALIYUN::OSS::Bucket",
        "ALIYUN::ROS::WaitCondition",
        "ALIYUN::ROS::WaitConditionHandle"
      ],
      "DeployTypes": [
        "ROS"
      ],
      "ApplicationScenes": [
        "other"
      ]
    },
    "Provider": "ROS",
    "Categories": [
      "Solution"
    ]
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。