All Products
Search

This Product

    Resource Orchestration Service:UpdateTemplateScratch

    Document Center

    Resource Orchestration Service:UpdateTemplateScratch

    Last Updated:Jun 10, 2026

    Memperbarui skenario.

    Deskripsi operasi

    Resource replication scenario

    Resource Orchestration Service (ROS) allows you to update a resource replication scenario. The updates that you make to a resource replication scenario do not affect the stack that is generated by using the resource scenario. You can call the GenerateTemplateByScratch operation to generate a template for the resource scenario.

    Resource migration scenario

    • If you want to update a resource migration scenario in which the migrated source resources are retained, you can delete the source resources to manage the updated resource migration scenario. You can also call the GenerateTemplateByScratch operation to generate a template for the resource scenario.

      **

      Note Make sure that the source resources that you want to delete from a resource migration scenario are associated only with the resource scenario. Otherwise, the source resources fail to be deleted.

    • If you want to update a resource migration scenario in which the migrated source resources are deleted, you can only call the GenerateTemplateByScratch operation to generate a template for the resource scenario.

    Resource management scenario

    If you want to update a resource management scenario after you use the resource scenario to manage resources, you can only call the GenerateTemplateByScratch operation to generate a template for the resource scenario.

    Resource detection scenario

    After you update a resource detection scenario, ROS obtains the most recent data from Resource Center and renders the architecture diagram.

    This topic provides an example on how to update a resource scenario. In this example, the ID of a virtual private cloud (VPC) in a resource scenario whose ID is ts-7f7a704cf71c49a6**** is updated to vpc-bp1m6fww66xbntjyc****.

    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:UpdateTemplateScratch

    update

    *TemplateScratch

    acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID wilayah skenario.

    Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.

    cn-hangzhou
    TemplateScratchId

    string

    Yes

    ID skenario sumber daya.

    Nilai valid parameter permintaan ParameterKey dan ParameterValue bervariasi berdasarkan ID dari berbagai tipe skenario sumber daya. Untuk informasi lebih lanjut, lihat bagian "Informasi tambahan tentang parameter permintaan" pada topik ini.

    Catatan

    Anda dapat memanggil operasi ListTemplateScratches untuk mengkueri ID skenario sumber daya.

    ts-7f7a704cf71c49a6****
    Description

    string

    No

    Deskripsi skenario.

    Copy VPC resources.
    SourceResources

    array<object>

    No

    Sumber daya asal.

    Catatan

    Anda harus menentukan hanya salah satu parameter berikut: SourceResources, SourceTag, dan SourceResourceGroup.

    object

    No

    The source resource.

    ResourceId

    string

    Yes

    The resource ID.

    vpc-bp1m6fww66xbntjyc****
    ResourceType

    string

    Yes

    The resource type.

    ALIYUN::ECS::VPC
    SourceTag

    object

    No

    Tag asal.

    Catatan

    Anda harus menentukan hanya salah satu parameter berikut: SourceResources, SourceTag, dan SourceResourceGroup.

    ResourceTags

    object

    Yes

    The source tags. A tag contains a tag key and a tag value.

    If you want to specify only the tag key, you must leave the tag value empty. Example: {"TagKey": ""}.

    If you set TemplateScratchType to ArchitectureDetection, you can add up to 5 source tags. In other cases, you can add up to 10 source tags.

    {"a": "b"}
    ResourceTypeFilter

    array

    No

    The resource types for filtering resources.

    string

    No

    The resource type for filtering resources. If you specify the resource types, ROS scans only the resources that are of the specified types and have the specified tags. If you do not specify the resource types, ROS scans all resources that have the specified tags.

    You can specify up to 20 resource types.

    ALIYUN::ECS::VPC
    SourceResourceGroup

    object

    No

    Kelompok sumber daya asal.

    Catatan

    Anda harus menentukan hanya salah satu parameter berikut: SourceResources, SourceTag, dan SourceResourceGroup.

    ResourceGroupId

    string

    Yes

    The ID of the source resource group.

    rg-acfmzawhxxc****
    ResourceTypeFilter

    array

    No

    The resource types for filtering resources.

    string

    No

    The resource type for filtering resources. If you specify the resource types, ROS scans only the resources that are of the specified types and belong to the specified resource group. If you do not specify the resource types, ROS scans all resources that belong to the specified resource group.

    You can specify up to 20 resource types.

    ALIYUN::ECS::VPC
    PreferenceParameters

    array<object>

    No

    Parameter preferensi skenario sumber daya.

    object

    No

    The preference parameter of the scenario.

    ParameterKey

    string

    Yes

    The parameter name.

    For more information about the valid values of ParameterKey, see the "Additional information about request parameters" section of this topic.

    Catatan

    • PreferenceParameters is optional. If you specify PreferenceParameters, you must specify both ParameterKey and ParameterValue.

    • If you set TemplateScratchType to ResourceImport, you must set ParameterKey to DeletionPolicy.

    DeletionPolicy
    ParameterValue

    string

    Yes

    The parameter value. The value of ParameterValue varies based on the value of ParameterKey.

    For more information about the valid values of ParameterKey, see the "Additional information about request parameters" section of this topic.

    Catatan

    PreferenceParameters is optional. If you specify PreferenceParameters, you must specify both ParameterKey and ParameterValue.

    Retain
    LogicalIdStrategy

    string

    No

    Kebijakan yang digunakan untuk menghasilkan ID logis. Nilai valid:

    • LongTypePrefixAndIndexSuffix: awalan tipe panjang + akhiran tipe indeks

    • LongTypePrefixAndHashSuffix: awalan tipe panjang + akhiran tipe hash

    • ShortTypePrefixAndHashSuffix: awalan tipe pendek + akhiran tipe hash

    Catatan

    Jika Anda mengatur TemplateScratchType ke ArchitectureDetection, nilai default LogicalIdStrategy adalah LongTypePrefixAndHashSuffix. Dalam kasus lain, nilai default LogicalIdStrategy adalah LongTypePrefixAndIndexSuffix.

    LongTypePrefixAndIndexSuffix
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII dan panjangnya tidak boleh melebihi 64 karakter.

    Untuk informasi lebih lanjut, lihat Cara memastikan idempotensi.

    123e4567-e89b-12d3-a456-42665544****
    ExecutionMode

    string

    No

    Mode eksekusi. Nilai valid:

    • Async (default)

    • Sync

    Catatan

    Jika Anda memiliki cakupan (dalam OAuth) sumber daya yang luas, Sync membutuhkan waktu lebih lama. Jika Anda mengatur ExecutionMode ke Sync, kami menyarankan Anda menentukan ClientToken untuk mencegah timeout eksekusi.

    Sync
    ResourceGroupId

    string

    No

    ID kelompok sumber daya.

    rg-acfmxazb4ph6aiy****

    Informasi tambahan tentang parameter permintaan

    Untuk informasi lebih lanjut tentang parameter permintaan umum, lihat Parameter umum.

    Nilai valid parameter permintaan ParameterKey dan ParameterValue bervariasi berdasarkan tipe skenario sumber daya.

    Skenario replikasi sumber daya

    Tabel berikut menjelaskan nilai valid parameter permintaan ParameterKey dan ParameterValue ketika Anda mengatur TemplateScratchId ke ID skenario replikasi sumber daya.

    ParameterKeyParameterValue
    DeletionPolicyKebijakan penghapusan untuk sumber daya. Nilai valid:Retain: mempertahankan sumber daya ketika Anda menghapus stack tempat sumber daya direplikasi.Delete: menghapus sumber daya secara default ketika Anda menghapus stack tempat sumber daya direplikasi. Jika Anda mempertahankan sumber daya tertentu saat kotak dialog Hapus Stack muncul, sumber daya tersebut akan dipertahankan.
    RegionIdID wilayah tujuan tempat Anda ingin mereplikasi sumber daya. Jika Anda mengosongkan parameter ini, wilayah sumber daya asal digunakan untuk sumber daya yang direplikasi.Contoh: cn-shanghai.
    ZoneIdID zona tujuan tempat Anda ingin mereplikasi sumber daya. Jika Anda mereplikasi sumber daya di wilayah yang sama dan Anda mengosongkan parameter ini, zona sumber daya asal digunakan untuk sumber daya yang direplikasi. Jika Anda mereplikasi sumber daya lintas wilayah dan Anda mengosongkan parameter ini, sistem memfilter zona yang didukung oleh semua sumber daya.Contoh: cn-shanghai-b.
    VpcIdID VPC tujuan tempat Anda ingin mereplikasi sumber daya. Jika Anda mereplikasi sumber daya di wilayah yang sama dan Anda mengosongkan parameter ini, VPC sumber daya asal digunakan untuk sumber daya yang direplikasi. Jika Anda mereplikasi sumber daya lintas wilayah dan Anda mengosongkan parameter ini, sistem secara otomatis membuat VPC di wilayah tujuan.Contoh: vpc-bp1hye0s8b69xokfu****.
    VSwitchIdID vSwitch tujuan tempat Anda ingin mereplikasi sumber daya. Jika Anda mereplikasi sumber daya di wilayah yang sama dan Anda mengosongkan parameter ini, vSwitch sumber daya asal digunakan untuk sumber daya yang direplikasi. Jika Anda mereplikasi sumber daya lintas wilayah dan Anda mengosongkan parameter ini, sistem secara otomatis membuat vSwitch di wilayah tujuan.Contoh: vsw-bp11ufkwqwggtm1cj****.
    InstanceDataReplicationApakah akan mereplikasi data instans Elastic Compute Service (ECS). Nilai valid:true: mereplikasi data instans ECS. Jika Anda mereplikasi data di wilayah yang sama, sistem membuat image kustom untuk instans asal dan membuat instans berdasarkan image tersebut. Jika Anda mereplikasi data lintas wilayah, sistem membuat image kustom untuk instans asal, mereplikasi image ke wilayah tujuan, lalu membuat instans berdasarkan image tersebut.false: tidak mereplikasi data instans ECS.

    Catatan Jika Anda mengatur ParameterKey ke InstanceDataReplication dan ParameterValue ke true, kami menyarankan Anda mereplikasi sumber daya setelah instans asal dihentikan. Hal ini memastikan konsistensi data.

    Skenario manajemen sumber daya

    Tabel berikut menjelaskan nilai valid parameter permintaan ParameterKey dan ParameterValue ketika Anda mengatur TemplateScratchId ke ID skenario manajemen sumber daya.

    Catatan Untuk skenario manajemen sumber daya, Anda harus mengatur ParameterKey ke DeletionPolicy.

    ParameterKeyParameterValue
    DeletionPolicyKebijakan penghapusan untuk sumber daya. Nilai valid:Retain: mempertahankan sumber daya ketika Anda menghapus stack yang Anda gunakan untuk mengelola sumber daya.Delete: menghapus sumber daya secara default ketika Anda menghapus stack yang Anda gunakan untuk mengelola sumber daya. Jika Anda mempertahankan sumber daya tertentu saat kotak dialog Hapus Stack muncul, sumber daya tersebut akan dipertahankan.

    Skenario deteksi sumber daya

    Tabel berikut menjelaskan nilai valid parameter permintaan ParameterKey dan ParameterValue ketika Anda mengatur TemplateScratchId ke ID skenario deteksi sumber daya.

    ParameterKeyParameterValue
    RegionIdsSatu atau beberapa ID wilayah. Pisahkan beberapa ID wilayah dengan koma (,). Jika Anda mengosongkan parameter ini, wilayah skenario sumber daya digunakan. Anda tidak dapat menentukan RegionIds dan SourceResources secara bersamaan.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    221DA822-B8CF-50DF-A9D2-BA197BF97BD5
    TemplateScratchId

    string

    The ID of the scenario.

    ts-7f7a704cf71c49a6****

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "221DA822-B8CF-50DF-A9D2-BA197BF97BD5",
  "TemplateScratchId": "ts-7f7a704cf71c49a6****"
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.