All Products
Search

This Product

    Resource Orchestration Service:GetTemplate

    Document Center

    Resource Orchestration Service:GetTemplate

    Last Updated:Oct 12, 2026

    Mengkueri detail templat dengan menentukan stack, Grup tumpukan, set perubahan, atau templat kustom.

    Deskripsi operasi

    Topik ini menyediakan contoh cara mengkueri detail templat yang ID-nya adalah 5ecd1e10-b0e9-4389-a565-e4c15efc**** di wilayah 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 stack.

    Catatan

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

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

    string

    No

    ID wilayah stack atau Grup tumpukan tempat templat berada. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.

    cn-hangzhou
    ChangeSetId

    string

    No

    ID set perubahan.

    Catatan

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

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

    string

    No

    ID templat.

    Template bersama dan pribadi didukung. Untuk Template bersama, TemplateId sama dengan TemplateARN. Gunakan nilai ini untuk kueri.

    Catatan

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

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

    string

    No

    Versi templat. Parameter ini hanya berlaku ketika TemplateId ditentukan.
    Untuk Template bersama, parameter ini hanya didukung ketika VersionOption diatur ke AllVersions. Untuk informasi selengkapnya, lihat SetTemplatePermission.

    Nilai valid: v1 hingga v65000, dan Draft. Nilai valid untuk Template bersama: v1 hingga v65000.

    v1
    TemplateStage

    string

    No

    Tahap templat. Parameter ini hanya berlaku ketika StackId, ChangeSetId, atau StackGroupName ditentukan.

    Nilai valid:

    • Processed: templat yang telah diparsing dan ditransformasi. Ini adalah nilai default.

    • Original: templat asli yang ditentukan oleh pengguna.

    Processed
    IncludePermission

    string

    No

    Apakah akan mengkueri informasi berbagi templat. Nilai valid:

    • Enabled: mengkueri informasi berbagi.

    • Disabled: tidak mengkueri informasi berbagi. Ini adalah nilai default.

    Catatan

    Hanya pemilik templat yang dapat mengkueri informasi berbagi.

    Enabled
    StackGroupName

    string

    No

    Nama Grup tumpukan.

    Catatan

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

    MyStackGroup
    IncludeTags

    string

    No

    Apakah akan mengkueri informasi tag. Nilai valid:

    • Enabled: mengkueri informasi tag.

    • Disabled: tidak mengkueri informasi tag. Ini adalah nilai default.

    Catatan

    Parameter ini hanya berlaku ketika TemplateId ditentukan.

    Enabled

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

    Elemen respons

    Element

    Type

    Description

    Example

    object

    TemplateARN

    string

    ARN templat. Parameter ini hanya dikembalikan ketika TemplateId ditentukan.

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

    string

    Deskripsi templat. Parameter ini hanya dikembalikan ketika TemplateId ditentukan.

    ROS template for create ECS instance.
    RequestId

    string

    ID permintaan.

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

    string

    Waktu pembuatan templat. Waktu ditampilkan dalam format YYYY-MM-DDThh:mm:ss. Parameter ini hanya dikembalikan ketika TemplateId ditentukan.

    Catatan

    • Jika TemplateVersion ditentukan, waktu pembuatan templat versi yang ditentukan akan dikembalikan.

    • Jika TemplateVersion tidak ditentukan, waktu pembuatan templat versi default akan dikembalikan.

    2020-11-18T08:49:26
    StackGroupName

    string

    Nama Grup tumpukan. Parameter ini hanya dikembalikan ketika StackGroupName ditentukan.

    MyStackGroup
    TemplateVersion

    string

    Versi templat. Parameter ini hanya dikembalikan ketika TemplateId ditentukan.
    Jika TemplateVersion tidak ditentukan atau tidak berlaku, parameter ini menunjukkan versi templat saat ini.

    Untuk Template bersama, parameter ini hanya dikembalikan ketika VersionOption diatur ke AllVersions.

    v1
    TemplateBody

    string

    Konten templat.

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

    string

    ID set perubahan. Parameter ini hanya dikembalikan ketika ChangeSetId ditentukan.

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

    string

    ID akun Alibaba Cloud tempat templat berada. Parameter ini hanya dikembalikan ketika TemplateId ditentukan.

    151266687691****
    UpdateTime

    string

    Waktu pembaruan terakhir templat. Waktu ditampilkan dalam format YYYY-MM-DDThh:mm:ss. Parameter ini hanya dikembalikan ketika TemplateId ditentukan.

    Catatan

    • Jika TemplateVersion ditentukan, waktu pembaruan terakhir templat versi yang ditentukan akan dikembalikan.

    • Jika TemplateVersion tidak ditentukan, waktu pembaruan terakhir templat akan dikembalikan.

    2020-12-07T06:11:48
    Permissions

    array<object>

    Status berbagi templat. Parameter ini hanya dikembalikan ketika TemplateId ditentukan dan IncludePermission diatur ke Enabled.

    Catatan

    • Jika TemplateVersion tidak ditentukan atau tidak berlaku, status berbagi templat akan dikembalikan.

    • Jika TemplateVersion ditentukan dan berlaku, status berbagi templat yang terkait dengan versi tersebut akan dikembalikan.

    object

    VersionOption

    string

    Opsi versi berbagi. Parameter ini hanya dikembalikan ketika ShareOption diatur ke ShareToAccounts.

    Nilai valid:

    • AllVersions: membagikan semua versi Template bersama.

    • Latest: hanya membagikan versi terbaru Template bersama. Ketika versi baru ditambahkan ke Template bersama, versi berbagi berubah sesuai untuk selalu tetap menjadi yang terbaru.

    • Current: hanya membagikan versi terbaru saat ini dari Template bersama. Ketika versi baru ditambahkan ke Template bersama, versi berbagi tetap tidak berubah.

    • Specified: hanya membagikan versi Template bersama yang ditentukan.

    AllVersions
    AccountId

    string

    Akun Alibaba Cloud tempat templat dibagikan.

    142437958638****
    ShareOption

    string

    Opsi berbagi.

    Nilai valid: ShareToAccounts, yang menunjukkan bahwa templat dibagikan ke akun Alibaba Cloud lain.

    ShareToAccounts
    TemplateVersion

    string

    Versi Template bersama. Parameter ini dikembalikan ketika ShareOption diatur ke ShareToAccounts dan VersionOption diatur ke Specified atau Current.

    Ketika parameter TemplateVersion diatur ke Draft, jika versi Draft ada, Draft akan dikembalikan. Jika versi Draft tidak ada atau telah dihapus, versi terbaru saat ini akan dikembalikan.

    Nilai valid: v1 hingga v65000, dan Draft.

    v1
    ShareSource

    string

    Sumber hubungan berbagi. Nilai valid:

    • ROS: hubungan berbagi dibuat menggunakan konsol atau API ROS.

    • ResourceDirectory: hubungan berbagi dibuat untuk akun dalam direktori sumber daya menggunakan fitur berbagi sumber daya di Resource Management.

    Catatan

    • Berbagi dari ROS dan berbagi dari Resource Directory memiliki kuota independen.

    • Berbagi dari Resource Directory tidak dapat dibatalkan atau ditimpa menggunakan konsol atau API ROS.

    • Berbagi dari Resource Directory dapat menimpa berbagi dari ROS.

    ROS
    TemplateName

    string

    Nama templat. Parameter ini hanya dikembalikan ketika TemplateId ditentukan.

    Catatan

    • Jika TemplateVersion ditentukan, nama templat yang terkait dengan versi tersebut akan dikembalikan.

    • Jika TemplateVersion tidak ditentukan, nama templat akan dikembalikan.

    MyTemplate
    RegionId

    string

    ID wilayah stack atau Grup tumpukan tempat templat berada. Parameter ini hanya dikembalikan ketika StackId, ChangeSetId, atau StackGroupName ditentukan.

    cn-hangzhou
    TemplateId

    string

    ID templat. Parameter ini hanya dikembalikan ketika TemplateId ditentukan.

    Untuk Template bersama, nilai yang dikembalikan sama dengan TemplateARN.

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

    string

    ID stack. Parameter ini hanya dikembalikan ketika StackId ditentukan.

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

    ShareType

    string

    Tipe berbagi templat. Parameter ini hanya dikembalikan ketika TemplateId ditentukan.

    Nilai valid:

    • Private: templat dimiliki oleh pengguna.

    • Shared: templat dibagikan oleh pengguna lain.

    Private
    ResourceGroupId

    string

    ID kelompok sumber daya.

    rg-acfmxazb4ph6aiy****
    Interface

    string

    Deskripsi antarmuka.

    {}
    Tags

    array<object>

    Tag templat.

    object

    Tag templat.

    Key

    string

    Kunci tag templat.

    usage
    Value

    string

    Nilai tag templat.

    test
    AdditionalInfo

    object

    Informasi tambahan templat 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": [
        "其他"
      ]
    },
    "Provider": "ROS",
    "Categories": [
      "Solution"
    ]
  }
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.