调用DescribeTemplates API查询所有编排模板-容器服务 Kubernetes 版 ACK-阿里云

编排模板是对一组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	long	否	对查询结果进行分页处理，指定返回第几页的数据。默认值： 1。	1
page_size	long	否	对查询结果进行分页处理，指定每页包含的数据条数。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object	返回数据体。
templates	array<object>	模板列表。
template	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	long	展示当前页数。	20
page_size	long	单页最大数据条数。	3
total_count	long	结果总数。	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
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史