DescribeTemplates - 查詢所有編排模板 - Container Service for Kubernetes

編排模板是對一組Kubernetes叢集資源的定義和描述，以聲明性方式描述應用應該如何運行或者配置。您可以調用DescribeTemplates介面擷取已建立的編排模板的列表，並查詢編排模板的詳細資料，包括存取權限、YAML內容、標籤等。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cs:DescribeTemplates

get

*全部資源

*

無

請求文法

GET /templates HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
template_type	string	否	模板類型。當取值為`kubernetes`時將在控制台的編排模板頁面展示該模板。該參數不填寫或者取值為其他值時，控制台的編排模板頁面將不會展示該模板。推薦設定為`kubernetes`。	kubernetes
page_num	integer	否	對查詢結果進行分頁處理，指定返回第幾頁的資料。預設值： 1。	1
page_size	integer	否	對查詢結果進行分頁處理，指定每頁包含的資料條數。預設值：10。	10

返回參數

名稱	類型	描述	樣本值
	object	返回資料體。
templates	array<object>	模板列表。
	object	部署模板詳情。
acl	string	使用者部署模板的存取權限，取值： `private`：私人。 `public`：公用。 `shared`：可共用。	private
id	string	部署模板 ID。	874ec485-e7e6-4373-8a3b-47bde8******
name	string	部署模板名稱。	webserver
description	string	部署模板描述資訊。	a web server
tags	string	部署模板的標籤，如果不顯式指定，預設為模板名稱。	kubernetes
template	string	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	模板類型。當取值為 kubernetes 時將在控制台的編排模板頁面展示該模板。該參數不填寫或者取值為其他值時，控制台的編排模板頁面將不會展示該模板。	kubernetes
created	string	部署模板建立時間。	2025-04-25T16:56:33+08:00
updated	string	部署模板更新時間。	2025-04-25T16:56:33+08:00
template_with_hist_id	string	模板關聯的父模板 ID，用於實現模板多版本功能（同一模板的不同版本擁有相同的`template_with_hist_id`值）。	ad81d115-7c8b-47e7-a222-9c28d7******
page_info	object	分頁資訊。
page_number	integer	展示當前頁數。	20
page_size	integer	單頁最巨量資料條數。	3
total_count	integer	結果總數。	50

樣本

正常返回樣本

JSON格式

{
  "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
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。