All Products
Search

This Product

    Resource Orchestration Service:GetTemplate

    Document Center

    Resource Orchestration Service:GetTemplate

    Last Updated:Jun 10, 2026

    Mengkueri detail template berdasarkan stack, grup stack, change set, atau informasi template kustom apa pun.

    Deskripsi operasi

    Dalam contoh ini, detail template yang ID-nya 5ecd1e10-b0e9-4389-a565-e4c15efc**** dikueri. ID region dari template adalah cn-hangzhou.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ros:GetTemplate

    get

    stack

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

    template

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    StackId

    string

    No

    ID dari stack.

    Catatan

    Anda harus menentukan salah satu parameter berikut: StackId, ChangeSetId, StackGroupName, dan TemplateId.

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

    string

    No

    ID region dari stack atau grup stack yang menggunakan template. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar region terbaru.

    cn-hangzhou
    ChangeSetId

    string

    No

    ID dari change set.

    Catatan

    Anda harus menentukan salah satu parameter berikut: StackId, ChangeSetId, StackGroupName, dan TemplateId.

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

    string

    No

    ID dari template.

    Parameter ini berlaku untuk template yang dibagikan (shared) maupun privat. Jika template merupakan template yang dibagikan, nilai TemplateId sama dengan nilai TemplateARN. Anda dapat menggunakan ID template untuk mengkueri template yang dibagikan.

    Catatan

    Anda harus menentukan salah satu parameter berikut: StackId, ChangeSetId, StackGroupName, dan TemplateId.

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

    string

    No

    Versi template. Parameter ini hanya berlaku jika Anda menentukan TemplateId.
    Jika template merupakan template yang dibagikan, Anda hanya dapat menentukan parameter ini jika VersionOption diatur ke AllVersions. Untuk informasi selengkapnya, lihat SetTemplatePermission.

    Nilai yang valid: v1 hingga v100.

    v1
    TemplateStage

    string

    No

    Tahap template. Parameter ini hanya berlaku jika Anda menentukan StackId, ChangeSetId, atau StackGroupName.

    Nilai yang valid:

    • Processed (default): mengembalikan template yang telah diproses.

    • Original: mengembalikan template asli.

    Processed
    IncludePermission

    string

    No

    Menentukan apakah akan mengkueri informasi berbagi tentang template. Nilai yang valid:

    • Enabled

    • Disabled (default)

    Catatan

    Hanya pemilik template yang dapat mengkueri informasi berbagi suatu template.

    Enabled
    StackGroupName

    string

    No

    Nama dari grup stack.

    Catatan

    Anda harus menentukan salah satu parameter berikut: StackId, ChangeSetId, StackGroupName, dan TemplateId.

    MyStackGroup
    IncludeTags

    string

    No

    Menentukan apakah akan mengkueri informasi tentang tag. Nilai yang valid:

    • Enabled

    • Disabled (default)

    Catatan

    Parameter ini hanya berlaku jika Anda menentukan TemplateId.

    Enabled

    Untuk informasi selengkapnya tentang parameter permintaan umum, lihat Parameter umum.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    TemplateARN

    string

    Alibaba Cloud Resource Name (ARN) dari template. Parameter ini hanya dikembalikan jika Anda menentukan TemplateId.

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

    string

    Deskripsi template. Parameter ini hanya dikembalikan jika Anda menentukan TemplateId.

    ROS template for create ECS instance.
    RequestId

    string

    ID permintaan.

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

    string

    Waktu saat template dibuat. Parameter ini hanya dikembalikan jika Anda menentukan TemplateId.

    Catatan

    • Jika Anda menentukan TemplateVersion, waktu pembuatan template yang versinya ditentukan oleh TemplateVersion akan dikembalikan.

    • Jika Anda tidak menentukan TemplateVersion, waktu pembuatan template yang versinya merupakan versi default akan dikembalikan.

    2020-11-18T08:49:26
    StackGroupName

    string

    Nama dari grup stack. Parameter ini hanya dikembalikan jika Anda menentukan StackGroupName.

    MyStackGroup
    TemplateVersion

    string

    Versi template. Parameter ini hanya dikembalikan jika Anda menentukan TemplateId.
    Jika TemplateVersion tidak ditentukan atau tidak berlaku, versi default akan digunakan.

    Jika template merupakan template yang dibagikan, parameter ini hanya dikembalikan jika Anda mengatur VersionOption ke AllVersions.

    v1
    TemplateBody

    string

    Konten template.

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

    string

    ID dari change set. Parameter ini hanya dikembalikan jika Anda menentukan ChangeSetId.

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

    string

    ID akun Alibaba Cloud tempat template berada. Parameter ini hanya dikembalikan jika Anda menentukan TemplateId.

    151266687691****
    UpdateTime

    string

    Waktu saat template terakhir kali diperbarui. Parameter ini hanya dikembalikan jika Anda menentukan TemplateId.

    Catatan

    • Jika Anda menentukan TemplateVersion, waktu pembaruan terakhir dari template yang versinya ditentukan oleh TemplateVersion akan dikembalikan.

    • Jika Anda tidak menentukan TemplateVersion, waktu pembaruan terakhir dari template yang versinya merupakan versi default akan dikembalikan.

    2020-12-07T06:11:48
    Permissions

    array<object>

    Detail status berbagi dari template. Parameter ini hanya dikembalikan jika Anda menentukan TemplateId dan mengatur IncludePermission ke Enabled.

    Catatan

    • Jika TemplateVersion tidak ditentukan atau tidak berlaku, detail status berbagi dari template yang versinya merupakan versi default akan dikembalikan.

    • Jika TemplateVersion ditentukan dan berlaku, detail status berbagi dari template yang versinya ditentukan oleh TemplateVersion akan dikembalikan.

    object

    VersionOption

    string

    Opsi versi untuk template yang dibagikan. Parameter ini hanya dikembalikan jika Anda mengatur ShareOption ke ShareToAccounts.

    Nilai yang valid:

    • AllVersions: Semua versi template dibagikan.

    • Latest: Hanya versi template terbaru yang dibagikan. Saat versi template diperbarui, Resource Orchestration Service (ROS) memperbarui versi yang dibagikan ke versi terbaru.

    • Current: Hanya versi template terbaru yang dibagikan. Saat versi template diperbarui, ROS tidak memperbarui versi yang dibagikan.

    • Specified: Hanya versi template yang ditentukan yang dibagikan.

    AllVersions
    AccountId

    string

    ID akun Alibaba Cloud yang menerima template yang dibagikan.

    142437958638****
    ShareOption

    string

    Opsi berbagi.

    Nilai ShareToAccounts menunjukkan bahwa template dibagikan dengan satu atau lebih akun Alibaba Cloud.

    ShareToAccounts
    TemplateVersion

    string

    Versi template yang dibagikan. Parameter ini hanya dikembalikan jika Anda mengatur ShareOption ke ShareToAccounts dan mengatur VersionOption ke Specified atau Current.

    Nilai yang valid: v1 hingga v100.

    v1
    ShareSource

    string

    Layanan yang digunakan untuk berbagi sumber daya. Nilai yang valid:

    • ROS: Sumber daya dibagikan dari ROS menggunakan konsol ROS atau dengan memanggil API ROS.

    • ResourceDirectory: Sumber daya dibagikan dengan akun-akun dalam suatu direktori sumber daya dari Resource Management menggunakan fitur berbagi sumber daya.

    Catatan

    • Jumlah akun yang sumber dayanya dibagikan dari ROS terpisah dari jumlah akun yang sumber dayanya dibagikan dari direktori sumber daya.

    • Sumber daya yang dibagikan dari ROS tidak dapat menimpa atau menggantikan sumber daya yang dibagikan dari direktori sumber daya.

    • Sumber daya yang dibagikan dari direktori sumber daya dapat menimpa sumber daya yang dibagikan dari ROS.

    ROS
    TemplateName

    string

    Nama template. Parameter ini hanya dikembalikan jika Anda menentukan TemplateId.

    Catatan

    • Jika Anda menentukan TemplateVersion, nama template yang versinya ditentukan oleh TemplateVersion akan dikembalikan.

    • Jika Anda tidak menentukan TemplateVersion, nama template yang versinya merupakan versi default akan dikembalikan.

    MyTemplate
    RegionId

    string

    ID region dari stack atau grup stack yang menggunakan template. Parameter ini hanya dikembalikan jika Anda menentukan StackId, ChangeSetId, atau StackGroupName.

    cn-hangzhou
    TemplateId

    string

    ID template. Parameter ini hanya dikembalikan jika Anda menentukan TemplateId.

    Jika template merupakan template yang dibagikan, nilai parameter ini sama dengan nilai TemplateARN.

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

    string

    ID stack. Parameter ini hanya dikembalikan jika Anda menentukan StackId.

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

    ShareType

    string

    Jenis berbagi template. Parameter ini hanya dikembalikan jika Anda menentukan TemplateId.

    Nilai yang valid:

    • Private: Template adalah milik pemilik template.

    • Shared: Template dibagikan oleh pengguna lain.

    Private
    ResourceGroupId

    string

    ID grup sumber daya.

    rg-acfmxazb4ph6aiy****
    Interface

    string

    Deskripsi UI web di konsol ROS.

    {}
    Tags

    array<object>

    Tag dari template.

    object

    Tag template.

    Key

    string

    Kunci tag template.

    usage
    Value

    string

    Nilai tag template.

    test
    AdditionalInfo

    object

    Informasi tambahan untuk template publik.

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

    Contoh

    Respons sukses

    JSONformat

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

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.