ListTemplates - Resource Orchestration Service

Mengambil daftar templat privat dan templat bersama.

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

list

*Template

acs:ros:{#regionId}:{#accountId}:template/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Nomor halaman dari daftar templat. Nilai dimulai dari 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman untuk kueri terpaginasi. Nilai valid: 1 hingga 50. Nilai default: 10.	10
TemplateName	string	No	Nama templat. Parameter ini hanya berlaku ketika ShareType diatur ke Private. Nama dapat memiliki panjang hingga 255 karakter. Nama harus dimulai dengan angka atau huruf, dan hanya boleh mengandung angka, huruf, tanda hubung (-), serta garis bawah (_).	MyTemplate
ShareType	string	No	Tipe berbagi templat. Nilai valid: Private (default): Templat dimiliki oleh pengguna. Shared: Templat dibagikan oleh pengguna lain. Official: Templat merupakan templat resmi yang dibagikan.	Private
Tag	array<object>	No	Tag. Anda dapat menentukan hingga 20 tag.
	object	No	Tag.
Key	string	No	Kunci tag. Parameter ini hanya berlaku ketika ShareType diatur ke Private. Anda dapat menentukan hingga 20 kunci tag.	usage
Value	string	No	Nilai tag. Parameter ini hanya berlaku ketika ShareType diatur ke Private. Anda dapat menentukan hingga 20 nilai tag.	deploy
ResourceGroupId	string	No	ID kelompok sumber daya. Untuk informasi selengkapnya tentang kelompok sumber daya, lihat Apa itu kelompok sumber daya?.	rg-acfmxazb4ph6aiy****
IncludeTags	string	No	Menentukan apakah akan menanyakan informasi tag. Nilai valid: Enabled: menanyakan informasi tag. Disabled (default): tidak menanyakan informasi tag.	Enabled
Filters	array<object>	No	Filter.
	object	No	Filter.
Name	string	No	Nama filter. Anda dapat memilih satu atau beberapa nama untuk ditanyakan. Nilai valid: Categories: kategori templat DeployTypes: tipe penerapan ApplicationScenes: skenario aplikasi BasicServices: layanan dasar ResourceTypes: tipe resource TemplateNames: nama templat	Categories
Values	array	No	Daftar nilai filter.
	string	No	Daftar nilai filter. Nilai N dapat berkisar dari 1 hingga 10.	ROS

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

Elemen respons

Element	Type	Description	Example
	object
TotalCount	integer	Jumlah total templat.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
RequestId	string	ID permintaan.	C3A8413B-1F16-4DED-AC3E-61A00718DE8A
PageNumber	integer	Nomor halaman dari daftar templat. Nilai dimulai dari 1.	1
Templates	array<object>	Daftar templat.
	array<object>	Daftar templat.
TemplateARN	string	Nama Sumber Daya Alibaba Cloud (ARN) dari templat.	acs:ros::151266687691*:template/a52f81be-496f-4e1c-a286-8852ab54**
UpdateTime	string	Waktu saat templat terakhir diperbarui.	2019-10-15T08:17:14.000000
Description	string	Deskripsi templat.	test-description
CreateTime	string	Waktu saat templat dibuat.	2019-10-15T08:17:14.000000
TemplateName	string	Nama templat.	demo
TemplateVersion	string	Nama versi terbaru dari templat.	v1
TemplateId	string	ID templat.	4d4f5aa2-3260-4e47-863b-763fbb12****
OwnerId	string	ID Akun Alibaba Cloud tempat templat tersebut berada.	151266687691****
ShareType	string	Tipe berbagi templat. Nilai valid: Private: Templat dimiliki oleh pengguna. Shared: Templat dibagikan oleh pengguna lain.	Private
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmxazb4ph6aiy****
Tags	array<object>	Tag dari templat.
	object	Tag dari templat.
Key	string	Kunci tag dari templat.	usage
Value	string	Nilai tag dari templat.	test
AdditionalInfo	object	Informasi tambahan mengenai 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":["其他"]},"Provider":"ROS","Categories":["Solution"]}
TemplateUrl	string	URL templat.	https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "C3A8413B-1F16-4DED-AC3E-61A00718DE8A",
  "PageNumber": 1,
  "Templates": [
    {
      "TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
      "UpdateTime": "2019-10-15T08:17:14.000000",
      "Description": "test-description",
      "CreateTime": "2019-10-15T08:17:14.000000",
      "TemplateName": "demo",
      "TemplateVersion": "v1",
      "TemplateId": "4d4f5aa2-3260-4e47-863b-763fbb12****",
      "OwnerId": "151266687691****",
      "ShareType": "Private",
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "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"
        ]
      },
      "TemplateUrl": "https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.