DescribeTemplates - Container Service for Kubernetes - Alibaba Cloud Documentation Center

Template orkestrasi mendefinisikan dan mendeskripsikan sekumpulan resource kluster Kubernetes secara deklaratif, menentukan bagaimana aplikasi harus dijalankan atau dikonfigurasi. Anda dapat memanggil operasi DescribeTemplates untuk mengambil daftar template orkestrasi yang telah dibuat dan mengkueri informasi detail tentang template, termasuk izin akses, konten YAML, dan tag.

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

cs:DescribeTemplates

get

*全部资源

*

None

Sintaks permintaan

GET /templates HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
template_type	string	No	Jenis template. Jika nilai diatur ke `kubernetes`, template ditampilkan pada halaman Template Orkestrasi di konsol. Jika parameter ini dibiarkan kosong atau diatur ke nilai lain, template tidak ditampilkan pada halaman Template Orkestrasi di konsol. Disarankan untuk mengatur parameter ini ke `kubernetes`.	kubernetes
page_num	integer	No	Nomor halaman yang dikembalikan saat melakukan paginasi hasil kueri. Nilai default: 1.	1
page_size	integer	No	Jumlah entri per halaman saat melakukan paginasi hasil kueri. Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object	Badan respons.
templates	array<object>	Daftar template.
	object	Detail template orkestrasi.
acl	string	Izin akses untuk template deployment. Nilai yang valid: `private`: privat. `public`: publik. `shared`: berbagi.	private
id	string	ID template orkestrasi.	874ec485-e7e6-4373-8a3b-47bde8******
name	string	Nama template orkestrasi.	webserver
description	string	Deskripsi template orkestrasi.	a web server
tags	string	Tag template orkestrasi. Jika tidak ditentukan secara eksplisit, nilai default-nya adalah nama template.	kubernetes
template	string	Konten template dalam format YAML.	apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: nginx-deployment-basic\n labels:\n app: nginx\nspec:\n replicas: 2\n selector:\n matchLabels:\n app: nginx\n template:\n metadata:\n labels:\n app: nginx\n spec:\n containers:\n - name: nginx\n image: busybox:latest\n ports:\n - containerPort: 80
template_type	string	Jenis template. Jika nilai diatur ke kubernetes, template ditampilkan pada halaman Template Orkestrasi di konsol. Jika parameter ini dibiarkan kosong atau diatur ke nilai lain, template tidak ditampilkan pada halaman Template Orkestrasi di konsol.	kubernetes
created	string	Waktu saat template orkestrasi dibuat.	2025-04-25T16:56:33+08:00
updated	string	Waktu saat template orkestrasi terakhir diperbarui.	2025-04-25T16:56:33+08:00
template_with_hist_id	string	ID template induk yang terkait dengan template. Parameter ini digunakan untuk mengimplementasikan pembuatan versi template. Versi yang berbeda dari template yang sama memiliki nilai `template_with_hist_id` yang sama.	ad81d115-7c8b-47e7-a222-9c28d7******
page_info	object	Informasi paginasi.
page_number	integer	Nomor halaman saat ini.	20
page_size	integer	Jumlah maksimum entri per halaman.	3
total_count	integer	Total jumlah entri yang dikembalikan.	50

Contoh

Respons sukses

JSONformat

{
  "templates": [
    {
      "acl": "private",
      "id": "874ec485-e7e6-4373-8a3b-47bde8******",
      "name": "webserver",
      "description": "a web server",
      "tags": "kubernetes",
      "template": "apiVersion: apps/v1\\nkind: Deployment\\nmetadata:\\n  name: nginx-deployment-basic\\n  labels:\\n    app: nginx\\nspec:\\n  replicas: 2\\n  selector:\\n    matchLabels:\\n      app: nginx\\n  template:\\n    metadata:\\n      labels:\\n        app: nginx\\n    spec:\\n      containers:\\n      - name: nginx\\n        image: busybox:latest\\n        ports:\\n        - containerPort: 80",
      "template_type": "kubernetes",
      "created": "2025-04-25T16:56:33+08:00",
      "updated": "2025-04-25T16:56:33+08:00",
      "template_with_hist_id": "ad81d115-7c8b-47e7-a222-9c28d7******"
    }
  ],
  "page_info": {
    "page_number": 20,
    "page_size": 3,
    "total_count": 50
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.