Gunakan GetTemplateSummary untuk mengkueri informasi template - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Mengkueri informasi tentang sumber daya template dengan menggunakan template, stack, grup stack, atau change set yang relevan.

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

get

Stack

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
StackId	string	No	ID stack. Anda hanya dapat menentukan salah satu dari parameter berikut: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, dan StackGroupName.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
TemplateBody	string	No	Struktur yang berisi badan template. Badan template harus memiliki panjang 1 hingga 524.288 byte. Jika panjang badan template melebihi batas atas, kami sarankan Anda menambahkan parameter ke badan permintaan HTTP POST untuk mencegah kegagalan permintaan yang disebabkan oleh URL yang terlalu panjang. Anda hanya dapat menentukan salah satu dari parameter berikut: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, dan StackGroupName.	{"ROSTemplateFormatVersion":"2015-09-01"}
RegionId	string	No	ID region dari stack atau grup stack yang menggunakan template. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar region terbaru. Parameter ini hanya berlaku ketika salah satu dari parameter berikut ditentukan: StackId, ChangeSetId, dan StackGroupName.	cn-hangzhou
TemplateId	string	No	ID template. Parameter ini berlaku untuk template bersama dan pribadi. Anda hanya dapat menentukan salah satu dari parameter berikut: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, dan StackGroupName.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateURL	string	No	URL file yang berisi badan template. URL harus mengarah ke template yang berada di server web HTTP atau HTTPS atau di bucket Object Storage Service (OSS), seperti oss://ros/template/demo atau oss://ros/template/demo?RegionId=cn-hangzhou. Badan template dapat memiliki panjang hingga 524.288 byte. Catatan Jika Anda tidak menentukan ID region dari bucket OSS, nilai RegionId akan digunakan. Anda hanya dapat menentukan salah satu dari parameter berikut: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, dan StackGroupName. URL dapat memiliki panjang hingga 1.024 byte.	oss://ros/template/demo
ChangeSetId	string	No	ID dari change set. Anda hanya dapat menentukan salah satu dari parameter berikut: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, dan StackGroupName.	1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateVersion	string	No	Versi template. Parameter ini berlaku ketika TemplateId ditentukan.	v1
StackGroupName	string	No	Nama grup stack. Anda hanya dapat menentukan salah satu dari parameter berikut: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, dan StackGroupName.	my-stack-group
Parameters	array<object>	No	Parameter yang didefinisikan dalam template.
	object	No
ParameterKey	string	No	Nama parameter N yang didefinisikan dalam template. Jika Anda tidak menentukan nama dan nilai parameter, Resource Orchestration Service (ROS) menggunakan nama dan nilai default yang didefinisikan dalam template. Nilai maksimum N: 200. Catatan Parameter Parameters bersifat opsional. Jika Anda menentukan Parameters, Anda harus menentukan Parameters.N.ParameterKey dan Parameters.N.ParameterValue.	InstanceId
ParameterValue	string	No	Nilai parameter N yang didefinisikan dalam template. Nilai maksimum N: 200. Catatan Parameter Parameters bersifat opsional. Jika Anda menentukan Parameters, Anda harus menentukan Parameters.N.ParameterKey dan Parameters.N.ParameterValue.	i-rotp2e20whfrs2****
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 dapat memiliki panjang hingga 64 karakter, dan dapat berisi huruf, angka, tanda hubung (-), dan garis bawah (_). Untuk informasi lebih lanjut, lihat Memastikan idempotensi.	123e4567-e89b-12d3-a456-42665544****

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

Elemen respons

Element	Type	Description	Example
	object
ResourceTypes	array	Semua tipe sumber daya yang digunakan dalam template.
	string	Tipe sumber daya yang digunakan dalam template.	["ALIYUN::ECS::VPC"]
Description	string	Deskripsi dari template stack.	No description
Parameters	array<object>	Deklarasi parameter dalam template.
	object	Deklarasi parameter dalam template.	[{"Description":"", "Label":"Name", "NoEcho":"false", "ParameterKey":"Name", "Type":"String"}]
RequestId	string	ID permintaan.	B288A0BE-D927-4888-B0F7-B35EF84B6E6
Version	string	Versi template.	2015-09-01
Metadata	object	Metadata yang didefinisikan dalam template.	{"key": "value"}
ResourceIdentifierSummaries	array<object>	Ringkasan pengenal sumber daya. Ringkasan menjelaskan sumber daya yang ingin Anda impor dan properti yang digunakan untuk mengidentifikasi sumber daya selama impor. Misalnya, VpcId adalah properti pengenal dari ALIYUN::ECS::VPC.
	object
ResourceType	string	Tipe sumber daya. Catatan Fitur impor sumber daya didukung untuk tipe sumber daya tersebut.	ALIYUN::ECS::VPC
LogicalResourceIds	array	ID logis dari semua sumber daya dengan tipe yang ditentukan oleh ResouceType dalam template.
	string	ID logis dari sumber daya dengan tipe yang ditentukan oleh ResouceType dalam template.	["Vpc"]
ResourceIdentifiers	array	Properti sumber daya. Anda dapat menggunakan properti sumber daya untuk mengidentifikasi sumber daya yang ingin Anda kelola. Misalnya, VpcId adalah properti pengenal dari ALIYUN::ECS::VPC.
	string	Properti sumber daya. Anda dapat menggunakan properti sumber daya untuk mengidentifikasi sumber daya yang ingin Anda kelola. Misalnya, VpcId adalah properti pengenal dari ALIYUN::ECS::VPC.	["VpcId"]

Contoh

Respons sukses

JSONformat

{
  "ResourceTypes": [
    "[\"ALIYUN::ECS::VPC\"]"
  ],
  "Description": "No description",
  "Parameters": [
    [
      {
        "Description": "",
        "Label": "Name",
        "NoEcho": "false",
        "ParameterKey": "Name",
        "Type": "String"
      }
    ]
  ],
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
  "Version": "2015-09-01",
  "Metadata": {
    "key": "value"
  },
  "ResourceIdentifierSummaries": [
    {
      "ResourceType": "ALIYUN::ECS::VPC",
      "LogicalResourceIds": [
        "[\"Vpc\"]"
      ],
      "ResourceIdentifiers": [
        "[\"VpcId\"]"
      ]
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.