Kueri template dengan ListTemplates - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Mengkueri templat. Mendukung berbagai metode pemfilteran.

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

oos:ListTemplates

get

Template

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

Template

acs:oos:{#regionId}:{#accountId}:template/{#templateName}

oos:tag
oos:TLSVersion

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-hangzhou
TemplateName	string	No	Nama templat. Semua templat yang namanya mengandung nama templat yang ditentukan akan dikembalikan.	MyTemplate
TemplateFormat	string	No	Format templat. Nilai valid: JSON YAML	YAML
ShareType	string	No	Tipe berbagi. Nilai valid: Public Private	Private
CreatedBy	string	No	Pembuat templat. Untuk templat resmi yang disediakan oleh Alibaba Cloud, nilainya adalah ACS. Untuk templat yang dibuat oleh pengguna, Anda dapat menentukan UID atau nama pengguna untuk memfilter templat.	ACS
CreatedDateBefore	string	No	Memfilter templat yang waktu pembuatannya lebih awal dari atau sama dengan pengatur waktu yang ditentukan. Format: YYYY-MM-DDThh:mm:ssZ	2019-05-16T10:26:14Z
CreatedDateAfter	string	No	Memfilter templat yang waktu pembuatannya lebih akhir dari atau sama dengan pengatur waktu yang ditentukan. Format: YYYY-MM-DDThh:mm:ssZ	2019-05-16T10:26:14Z
Tags	object	No	Tag dalam pasangan kunci-nilai. Jumlah pasangan kunci-nilai berkisar dari 1 hingga 20.	{"k1":"k2","k2":"v2"}
Category	string	No	Kategori templat, seperti TimerTrigger, EventTrigger, AlarmTrigger, atau Other.	TimerTrigger
MaxResults	integer	No	Jumlah entri per halaman. Nilai valid: 10 hingga 100. Nilai default: 50.	50
NextToken	string	No	Token yang digunakan untuk mengambil halaman hasil berikutnya. Nilai ini diperoleh dari tanggapan halaman saat ini jika masih ada hasil lainnya.	xxx
SortField	string	No	Bidang yang digunakan untuk mengurutkan hasil kueri. Nilai valid: TotalExecutionCount (default): jumlah total eksekusi Popularity: popularitas TemplateName: nama templat CreatedDate: pengatur waktu pembuatan UpdatedDate: pengatur waktu pembaruan	Popularity
SortOrder	string	No	Pesanan pengurutan. Nilai valid: Ascending: urutan naik Descending (default): urutan turun	Descending
HasTrigger	boolean	No	Apakah templat memiliki pemicu.	true
TemplateType	string	No	Tipe templat. Nilai valid: Automation: otomatisasi State: inventaris konfigurasi Package: paket perangkat lunak Valid values: Automation : Automation. State : State. Package : Package.	Automation
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmxsn4m4******
IsFavorite	boolean	No	Apakah templat ditambahkan ke favorit.	true
IsExample	boolean	No	Apakah templat merupakan templat contoh.	true

Elemen respons

Element	Type	Description	Example
	object
NextToken	string	Token yang digunakan untuk mengambil halaman hasil berikutnya. Nilai ini diperoleh dari tanggapan halaman saat ini jika masih ada hasil lainnya.	xxx
RequestId	string	ID permintaan.	BEF54BA-17B6-449F-A219-49ACB157E3
MaxResults	integer	Jumlah entri per halaman.	50
Templates	array<object>	Metadata templat.
	array<object>
Hash	string	Hash SHA-256 dari konten templat.	4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4
UpdatedDate	string	Pengatur waktu ketika templat terakhir diperbarui.	2019-05-16T10:26:14Z
UpdatedBy	string	Pengguna yang terakhir memperbarui templat.	root(13092000)
TemplateType	string	Tipe templat.	private
Tags	object	Tag dalam pasangan kunci-nilai. Jumlah pasangan kunci-nilai berkisar dari 1 hingga 20.	{"k1":"v1","k2":"v2"}
TemplateName	string	Nama templat.	MyTemplate
TemplateVersion	string	Versi templat, dalam format "v" diikuti oleh angka mulai dari 1.	v1
TemplateFormat	string	Format templat. Sistem menentukan formatnya, yaitu JSON atau YAML.	JSON
Popularity	integer	Popularitas templat publik. Nilainya berkisar dari 1 hingga 10. Nilai yang lebih tinggi menunjukkan popularitas yang lebih besar. Jika ShareType adalah Private, nilai bidang ini adalah `-1`. Catatan Bidang ini hanya bermakna jika ShareType adalah Public.	8
TotalExecutionCount	integer	Jumlah total eksekusi untuk template pribadi. Jika ShareType adalah Public, nilai bidang ini adalah `-1`. Catatan Bidang ini hanya bermakna jika ShareType adalah Private.	5
Description	string	Deskripsi templat.	Mengkueri instans dengan status tertentu
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmxsn4m4******
CreatedBy	string	Pembuat templat.	root(1309200)
CreatedDate	string	Pengatur waktu ketika templat dibuat.	2019-05-16T10:26:14Z
Category	string	Tipe templat.	TimerTrigger
HasTrigger	boolean	Menunjukkan apakah templat berhasil dipicu oleh Pemicu.	true
TemplateId	string	ID templat.	t-94753deed38
ShareType	string	Tipe berbagi templat. Templat yang dibuat oleh pengguna memiliki tipe berbagi Private. Nilai valid: Public Private	Public
IsFavorite	boolean	Apakah templat ditambahkan ke favorit.	true
Publisher	string	Penerbit.	aliyun
Constraints	string	Batasan.	{ "InstanceTypeFamilies": ["ecs.g8y", "ecs.c8y"], "ImageTypes": ["system"], "OSPlatforms": ["CentOS", "Ubuntu"], "OSVersions": ["CentOS7.9 64bit"] }
VersionName	string	Nama versi.	3

Contoh

Respons sukses

JSONformat

{
  "NextToken": "xxx",
  "RequestId": "BEF54BA-17B6-449F-A219-49ACB157E3",
  "MaxResults": 50,
  "Templates": [
    {
      "Hash": "4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4",
      "UpdatedDate": "2019-05-16T10:26:14Z",
      "UpdatedBy": "root(13092000)",
      "TemplateType": "private",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "TemplateName": "MyTemplate",
      "TemplateVersion": "v1",
      "TemplateFormat": "JSON",
      "Popularity": 8,
      "TotalExecutionCount": 5,
      "Description": "Mengkueri instans dengan status tertentu",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedBy": "root(1309200)",
      "CreatedDate": "2019-05-16T10:26:14Z",
      "Category": "TimerTrigger",
      "HasTrigger": true,
      "TemplateId": "t-94753deed38",
      "ShareType": "Public",
      "IsFavorite": true,
      "Publisher": "aliyun",
      "Constraints": "{\n  \"InstanceTypeFamilies\": [\"ecs.g8y\", \"ecs.c8y\"],\n  \"ImageTypes\": [\"system\"],\n  \"OSPlatforms\": [\"CentOS\", \"Ubuntu\"],\n  \"OSVersions\": [\"CentOS7.9 64bit\"]\n}",
      "VersionName": "3"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.