Dapatkan Detail Skenario Resource melalui API GetTemplateScratch - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Mengambil detail skenario sumber daya.

Deskripsi operasi

Topik ini memberikan contoh cara mengkueri detail skenario sumber daya ts-7f7a704cf71c49a6**** di region China (Hangzhou) dan menampilkan data node sumber.

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

get

*TemplateScratch

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID region skenario sumber daya. Anda dapat memanggil DescribeRegions untuk mengkueri daftar region terbaru.	cn-hangzhou
TemplateScratchId	string	No	ID skenario sumber daya.	ts-7f7a704cf71c49a6****
ShowDataOption	string	No	Opsi tampilan data. Nilai yang valid: Sources: hanya menampilkan data node sumber. Nilai ini berlaku ketika TemplateScratchType diatur ke ArchitectureDetection. Source: hanya menampilkan data node sumber. Nilai ini berlaku ketika TemplateScratchType tidak diatur ke ArchitectureDetection. Provisions: hanya menampilkan data node baru. Nilai ini berlaku ketika TemplateScratchType tidak diatur ke ArchitectureDetection. All: menampilkan semua data. Untuk informasi selengkapnya tentang node sumber dan node baru, lihat Ikhtisar. Catatan Jika Anda tidak menentukan parameter ini, data node tidak ditampilkan secara default.	Source

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

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	A8E0EF98-6FBD-5656-8298-FC8194F0F7B7
TemplateScratch	object	Skenario sumber daya.
TemplateScratchId	string	ID skenario sumber daya.	ts-7f7a704cf71c49a6****
TemplateScratchType	string	Jenis skenario sumber daya. Nilai yang valid: ResourceImport: manajemen sumber daya. ArchitectureReplication: replikasi sumber daya.	ArchitectureReplication
Status	string	Status skenario sumber daya. Nilai yang valid: GENERATE_IN_PROGRESS: sedang dibuat. GENERATE_COMPLETE: telah dibuat. GENERATE_FAILED: gagal dibuat.	GENERATE_COMPLETE
StatusReason	string	Alasan mengapa skenario sumber daya gagal dibuat. Catatan Parameter ini hanya ditampilkan ketika Status diatur ke GENERATE_FAILED.	Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.
FailedCode	string	Kode status yang menunjukkan mengapa skenario sumber daya gagal dibuat. Catatan Parameter ini hanya ditampilkan ketika Status diatur ke GENERATE_FAILED.	InvalidZoneId
TemplateScratchData	object	Data skenario sumber daya.	See the response example.
PreferenceParameters	array<object>	Parameter konfigurasi skenario sumber daya.
	object
ParameterKey	string	The parameter name.	DeletionPolicy
ParameterValue	string	The parameter value.	Retain
Description	string	Deskripsi skenario sumber daya.	Copy VPC resources.
SourceResources	array<object>	Sumber daya asal.
	object	Sumber daya asal.
ResourceId	string	The resource ID.	vpc-m5e7cv7e9mz69sszb****
ResourceType	string	The resource type.	ALIYUN::ECS::VPC
RelatedResourceTypeFilter	array	The related resource type filters.
	string	The related resource type filter.	ALIYUN::ECS::VPC
SourceTag	object	Tag sumber.
ResourceTags	object	The source tags.	{"a": "b"}
ResourceTypeFilter	array	The resource type filters.
	string	The resource type filter.	ALIYUN::ECS::VPC
SourceResourceGroup	object	Grup sumber daya asal.
ResourceGroupId	string	The ID of the source resource group.	rg-acfmzawhxxc****
ResourceTypeFilter	array	The resource type filters.
	string	The resource type filter.	ALIYUN::ECS::VPC
LogicalIdStrategy	string	Strategi pembuatan ID logis. Nilai yang valid: LongTypePrefixAndIndexSuffix (default): prefiks tipe panjang dengan sufiks indeks. LongTypePrefixAndHashSuffix: prefiks tipe panjang dengan sufiks hash. ShortTypePrefixAndHashSuffix: prefiks tipe pendek dengan sufiks hash.	LongTypePrefixAndIndexSuffix
CreateTime	string	Waktu ketika skenario sumber daya dibuat. Waktu ditampilkan dalam UTC+0 dan mengikuti standar ISO 8601 tanpa akhiran Z. Format: YYYY-MM-DDThh:mm:ss.	2021-12-22T01:49:22
UpdateTime	string	Waktu ketika skenario sumber daya terakhir diperbarui. Waktu ditampilkan dalam UTC+0 dan mengikuti standar ISO 8601 tanpa akhiran Z. Format: YYYY-MM-DDThh:mm:ss.	2021-12-22T01:49:23
Stacks	array<object>	Daftar stack yang terkait dengan skenario sumber daya.
	object
StackId	string	The stack ID.	3708bf6a-3a67-44d4-9eb1-c56704b9****
RegionId	string	The region ID of the stack.	cn-hangzhou
UsageType	string	The purpose of the stack. Valid values: ResourceImport: resource management ArchitectureReplication: resource replication	ArchitectureReplication
StackProvision	object	Informasi penyediaan stack.
Creatable	boolean	Indicates whether the resource is replicated by calling the CreateStack operation. Valid values: true false	true
Importable	boolean	Indicates whether the resource is managed by calling the CreateChangeSet operation. Valid values: true false	false
ResourceGroupId	string	ID grup sumber daya.	rg-acfmzmhzoaad5oq

Contoh

Respons sukses

JSONformat

{
  "RequestId": "A8E0EF98-6FBD-5656-8298-FC8194F0F7B7",
  "TemplateScratch": {
    "TemplateScratchId": "ts-7f7a704cf71c49a6****",
    "TemplateScratchType": "ArchitectureReplication",
    "Status": "GENERATE_COMPLETE",
    "StatusReason": "Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.",
    "FailedCode": "InvalidZoneId",
    "TemplateScratchData": {
      "test": "test",
      "test2": 1
    },
    "PreferenceParameters": [
      {
        "ParameterKey": "DeletionPolicy",
        "ParameterValue": "Retain"
      }
    ],
    "Description": "Copy VPC resources.",
    "SourceResources": [
      {
        "ResourceId": "vpc-m5e7cv7e9mz69sszb****",
        "ResourceType": "ALIYUN::ECS::VPC",
        "RelatedResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      }
    ],
    "SourceTag": {
      "ResourceTags": {
        "a": "b"
      },
      "ResourceTypeFilter": [
        "ALIYUN::ECS::VPC"
      ]
    },
    "SourceResourceGroup": {
      "ResourceGroupId": "rg-acfmzawhxxc****",
      "ResourceTypeFilter": [
        "ALIYUN::ECS::VPC"
      ]
    },
    "LogicalIdStrategy": "LongTypePrefixAndIndexSuffix",
    "CreateTime": "2021-12-22T01:49:22",
    "UpdateTime": "2021-12-22T01:49:23",
    "Stacks": [
      {
        "StackId": "3708bf6a-3a67-44d4-9eb1-c56704b9****",
        "RegionId": "cn-hangzhou",
        "UsageType": "ArchitectureReplication"
      }
    ],
    "StackProvision": {
      "Creatable": true,
      "Importable": false
    },
    "ResourceGroupId": "rg-acfmzmhzoaad5oq"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.