GetTemplate - - Alibaba Cloud Documentation Center

Mengambil detail templat. Misalnya, Anda dapat memanggil operasi ini untuk menanyakan stack, grup stack, dan change set yang didefinisikan dalam templat kustom.

Pada contoh ini, detail templat dengan ID 5ecd1e10-b0e9-4389-a565-e4c15efc**** dan ID wilayah cn-hangzhou diambil.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kemudahan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Wajib	Contoh	Deskripsi
Action	String	Yes	GetTemplate	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke GetTemplate.
StackId	String	No	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	ID stack. Catatan Anda hanya boleh menentukan salah satu dari parameter berikut: StackId, ChangeSetId, StackGroupName, dan TemplateId.
RegionId	String	Yes	cn-hangzhou	ID wilayah tempat stack atau grup stack yang didefinisikan dalam templat berada. Anda dapat memanggil operasi DescribeRegions untuk menanyakan daftar wilayah terbaru.
ChangeSetId	String	No	1f6521a4-05af-4975-afe9-bc4b45ad****	ID change set. Catatan Anda hanya boleh menentukan salah satu dari parameter berikut: StackId, ChangeSetId, StackGroupName, dan TemplateId.
TemplateId	String	No	5ecd1e10-b0e9-4389-a565-e4c15efc****	ID templat. Parameter ini berlaku untuk templat bersama dan templat pribadi. Jika templat tersebut merupakan templat bersama, nilai parameter TemplateId sama dengan nilai parameter TemplateARN. Anda dapat menggunakan ID templat untuk menanyakan templat bersama. Catatan Anda hanya boleh menentukan salah satu dari parameter berikut: StackId, ChangeSetId, StackGroupName, dan TemplateId.
TemplateVersion	String	No	v1	Versi templat. Parameter ini hanya berlaku jika Anda menentukan parameter TemplateId. Jika templat tersebut merupakan templat bersama, Anda hanya dapat menentukan parameter ini jika menyetel parameter VersionOption ke AllVersions. Nilai yang valid: v1 hingga v100.
TemplateStage	String	No	Processed	Tahap templat. Parameter ini hanya berlaku jika Anda menentukan parameter StackId, ChangeSetId, atau StackGroupName. Nilai default: Processed. Nilai yang valid: Processed: mengembalikan templat yang telah diproses dan berisi transformasi. Original: mengembalikan templat asli yang Anda tentukan.
IncludePermission	String	No	Enabled	Menentukan apakah akan menanyakan informasi berbagi templat. Nilai default: Disabled. Nilai yang valid: Enabled Disabled Catatan Hanya pemilik templat yang dapat menanyakan informasi berbagi templat.
StackGroupName	String	No	MyStackGroup	Nama grup stack. Catatan Anda hanya boleh menentukan salah satu dari parameter berikut: StackId, ChangeSetId, StackGroupName, dan TemplateId.
IncludeTags	String	No	Enabled	Menentukan apakah akan menanyakan informasi tag. Nilai default: Disabled. Nilai yang valid: Enabled Disabled Catatan Parameter ini hanya berlaku jika Anda menentukan parameter TemplateId.

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

Parameter respons

Parameter	Type	Contoh	Deskripsi
TemplateARN	String	acs:ros::151266687691*:template/a52f81be-496f-4e1c-a286-8852ab54**	Nama Sumber Daya Alibaba Cloud (ARN) templat. Parameter ini hanya dikembalikan jika parameter TemplateId ditentukan.
Description	String	ROS template for create ECS instance.	Deskripsi templat. Parameter ini hanya dikembalikan jika parameter TemplateId ditentukan.
RequestId	String	B288A0BE-D927-4888-B0F7-B35EF84****	ID permintaan.
CreateTime	String	2020-11-18T08:49:26	Waktu pembuatan templat. Parameter ini hanya dikembalikan jika parameter TemplateId ditentukan. Catatan Jika parameter TemplateVersion ditentukan, waktu pembuatan templat dengan versi yang ditentukan oleh parameter TemplateVersion dikembalikan. Jika parameter TemplateVersion tidak ditentukan, waktu pembuatan templat dengan versi default dikembalikan.
StackGroupName	String	MyStackGroup	Nama grup stack. Parameter ini hanya dikembalikan jika parameter StackGroupName ditentukan.
TemplateVersion	String	v1	Versi templat. Parameter ini hanya dikembalikan jika parameter TemplateId ditentukan. Jika parameter TemplateVersion tidak ditentukan atau tidak berlaku, nilai parameter ini adalah versi default templat. Jika templat tersebut merupakan templat bersama, parameter ini hanya dikembalikan jika parameter VersionOption disetel ke AllVersions.
TemplateBody	String	{"ROSTemplateFormatVersion": "2015-09-01"}	Isi templat.
ChangeSetId	String	e85abe0c-6528-43fb-ae93-fdf8de22****	ID change set. Parameter ini hanya dikembalikan jika parameter ChangeSetId ditentukan.
OwnerId	String	151266687691****	ID Akun Alibaba Cloud tempat templat berada. Parameter ini hanya dikembalikan jika parameter TemplateId ditentukan.
UpdateTime	String	2020-12-07T06:11:48	Waktu terakhir templat diperbarui. Parameter ini hanya dikembalikan jika parameter TemplateId ditentukan. Catatan Jika parameter TemplateVersion ditentukan, waktu pembaruan terakhir templat dengan versi yang ditentukan oleh parameter TemplateVersion dikembalikan. Jika parameter TemplateVersion tidak ditentukan, waktu pembaruan terakhir templat dengan versi default dikembalikan.
Permissions	Array of Permission		Detail status berbagi templat. Parameter ini hanya dikembalikan jika parameter TemplateId ditentukan dan parameter IncludePermission disetel ke Enabled. Catatan Jika parameter TemplateVersion tidak ditentukan atau tidak berlaku, detail status berbagi templat dengan versi default dikembalikan. Jika parameter TemplateVersion ditentukan dan berlaku, detail status berbagi templat dengan versi yang ditentukan oleh parameter TemplateVersion dikembalikan.
VersionOption	String	AllVersions	Opsi versi untuk templat bersama. Parameter ini hanya dikembalikan jika parameter ShareOption disetel ke ShareToAccounts. Nilai yang valid: AllVersions: Semua versi templat dibagikan. Latest: Hanya versi templat terbaru yang dibagikan. Saat versi templat diperbarui, ROS memperbarui versi yang dibagikan menjadi versi terbaru. Current: Hanya versi templat default saat Anda mengonfigurasi berbagi templat yang dibagikan. Saat versi templat diperbarui, ROS tidak memperbarui versi yang dibagikan. Specified: Hanya versi templat tertentu yang dibagikan.
AccountId	String	142437958638****	ID Akun Alibaba Cloud tempat templat dibagikan.
ShareOption	String	ShareToAccounts	Opsi berbagi. Nilainya disetel ke ShareToAccounts, yang menunjukkan bahwa templat dibagikan ke satu atau beberapa Akun Alibaba Cloud.
TemplateVersion	String	v1	Versi templat bersama. Parameter ini hanya dikembalikan jika parameter ShareOption disetel ke ShareToAccounts dan parameter VersionOption disetel ke Specified atau Current. Nilai yang valid: v1 hingga v100.
ShareSource	String	ROS	Layanan yang digunakan untuk berbagi sumber daya. Nilai yang valid: ROS: Sumber daya dibagikan dari ROS melalui Konsol ROS atau dengan memanggil API ROS. ResourceDirectory: Sumber daya dibagikan ke akun dalam direktori sumber daya dari Resource Management menggunakan fitur berbagi sumber daya. Catatan Jumlah akun tempat sumber daya dibagikan dari ROS tidak bergantung pada jumlah akun tempat sumber daya dibagikan dari direktori sumber daya. Sumber daya yang dibagikan dari ROS tidak dapat menggantikan atau menimpa sumber daya yang dibagikan dari direktori sumber daya. Sumber daya yang dibagikan dari direktori sumber daya dapat menggantikan sumber daya yang dibagikan dari ROS.
TemplateName	String	MyTemplate	Nama templat. Parameter ini hanya dikembalikan jika parameter TemplateId ditentukan. Catatan Jika parameter TemplateVersion ditentukan, nama templat dengan versi yang ditentukan oleh parameter TemplateVersion dikembalikan. Jika parameter TemplateVersion tidak ditentukan, nama templat dengan versi default dikembalikan.
RegionId	String	cn-hangzhou	ID wilayah tempat stack atau grup stack yang didefinisikan dalam templat berada. Parameter ini hanya dikembalikan jika parameter StackId, ChangeSetId, atau StackGroupName ditentukan.
TemplateId	String	a52f81be-496f-4e1c-a286-8852ab54****	ID templat. Parameter ini hanya dikembalikan jika parameter TemplateId ditentukan. Jika templat tersebut merupakan templat bersama, nilai parameter ini sama dengan nilai parameter TemplateARN.
StackId	String	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	ID stack. Parameter ini hanya dikembalikan jika parameter StackId ditentukan.
ShareType	String	Private	Jenis berbagi templat. Parameter ini hanya dikembalikan jika parameter TemplateId ditentukan. Nilai yang valid: Private: Templat hanya dapat digunakan oleh pemilik templat. Shared: Templat dibagikan kepada pengguna lain.
ResourceGroupId	String	rg-acfmxazb4ph6aiy****	ID kelompok sumber daya.
Interface	String	{}	Deskripsi antarmuka web di Konsol ROS.
Tags	Array of Tags		Tag templat.
Key	String	usage	Kunci tag.
Value	String	test	Nilai tag.

Contoh

Permintaan contoh

http(s)://ros.aliyuncs.com/?Action=GetTemplate
&RegionId=cn-hangzhou
&TemplateId=5ecd1e10-b0e9-4389-a565-e4c15efc****
&IncludePermission=Enabled
&<Common request parameters>

Respons sukses contoh

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetTemplateResponse>
    <TemplateARN>acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****</TemplateARN>
    <Description>ROS template for create ECS instance.</Description>
    <RequestId>B288A0BE-D927-4888-B0F7-B35EF84****</RequestId>
    <CreateTime>2020-11-18T08:49:26</CreateTime>
    <StackGroupName>MyStackGroup</StackGroupName>
    <TemplateVersion>v1</TemplateVersion>
    <TemplateBody>{"ROSTemplateFormatVersion": "2015-09-01"}</TemplateBody>
    <ChangeSetId>e85abe0c-6528-43fb-ae93-fdf8de22****</ChangeSetId>
    <OwnerId>151266687691****</OwnerId>
    <UpdateTime>2020-12-07T06:11:48</UpdateTime>
    <Permissions>
        <VersionOption>AllVersions</VersionOption>
        <AccountId>142437958638****</AccountId>
        <ShareOption>ShareToAccounts</ShareOption>
        <TemplateVersion>v1</TemplateVersion>
        <ShareSource>ROS</ShareSource>
    </Permissions>
    <TemplateName>MyTemplate</TemplateName>
    <RegionId>cn-hangzhou</RegionId>
    <TemplateId>a52f81be-496f-4e1c-a286-8852ab54****</TemplateId>
    <StackId>4a6c9851-3b0f-4f5f-b4ca-a14bf691****</StackId>
    <ShareType>Private</ShareType>
    <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
    <Interface>{}</Interface>
    <Tags>
        <Key>usage</Key>
        <Value>test</Value>
    </Tags>
</GetTemplateResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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****",
  "ShareType" : "Private",
  "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
  "Interface" : "{}",
  "Tags" : [ {
    "Key" : "usage",
    "Value" : "test"
  } ]
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.

Kode status HTTP	Kode kesalahan	Pesan kesalahan	Deskripsi
404	ChangeSetNotFound	The ChangeSet ({name}) of Stack ({stack}) could not be found.	Pesan kesalahan yang dikembalikan karena change set yang ditentukan tidak ada. name menunjukkan nama atau ID change set, dan stack menunjukkan nama atau ID stack.
404	ChangeSetNotFound	The ChangeSet {ID} could not be found.	Pesan kesalahan yang dikembalikan karena change set yang ditentukan tidak ada. ID menunjukkan ID change set.
404	StackNotFound	The Stack ({name}) could not be found.	Pesan kesalahan yang dikembalikan karena stack tidak ada. name menunjukkan nama atau ID stack.
404	TemplateNotFound	The Template { ID } could not be found.	Pesan kesalahan yang dikembalikan karena templat yang ditentukan tidak ada. ID menunjukkan ID templat.
404	TemplateNotFound	The Template { ID } with version { version } could not be found.	Pesan kesalahan yang dikembalikan karena templat atau versi templat yang ditentukan tidak ada. ID menunjukkan ID templat. version menunjukkan versi templat.
404	StackGroupNotFound	The StackGroup ({name}) could not be found.	Pesan kesalahan yang dikembalikan karena grup stack yang ditentukan tidak ada. name menunjukkan nama grup stack.