调用DescribeTemplates查询部署模板。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

get /templates http|https

请求参数

名称 类型 是否必选 示例值 描述
template_type String kubernetes

部署模板类型,目前一共有2种类型,分别是kubernetes和compose,默认为kubernetes。

返回数据

名称 类型 示例值 描述
page_info Object

分页信息。

page_number Long "20"

展示页数。

page_size Long "3"

单页大小。

total_count Long "50"

结果总数。

templates Array of templates

模板列表。

acl String "private"

用户部署模板的访问权限,private。

  • private:私有的。
  • public:公共的。
  • shared:可共享的。

默认为私有private。

created String "2020-06-10T16:30:16+08:00"

部署模板创建时间。

description String "a web server"

部署模板描述信息。

id String "874ec485-e7e6-4373-8a3b-47bde8ae789f"

部署模板ID。

name String "webserver"

部署模板名称。

tags String "kubernetes"

部署模板的标签,如果不显式指定了,默认为模板名称。

template String "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"

部署模板类型, 有2种值:

  • kubernetes:kubernetes标准模板。
  • compose:compose标准模板。
updated String "2020-06-10T16:30:16+08:00"

部署模板更新时间。

示例

请求示例

GET /templates HTTP/1.1
公共请求头

正常返回示例

XML 格式

<page_info>
    <page_number>20</page_number>
    <total_count>50</total_count>
    <page_size>3</page_size>
</page_info>
<templates>
    <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>
    <created>2020-06-10T16:30:16+08:00</created>
    <name>webserver</name>
    <description>a web server</description>
    <template_type>kubernetes</template_type>
    <acl>private</acl>
    <id>874ec485-e7e6-4373-8a3b-47bde8ae789f</id>
    <updated>2020-06-10T16:30:16+08:00</updated>
    <tags>kubernetes</tags>
</templates>

JSON 格式

{
    "page_info": {
        "page_number": "20",
        "total_count": "50",
        "page_size": "3"
    },
    "templates": [
        {
            "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",
            "created": "2020-06-10T16:30:16+08:00",
            "name": "webserver",
            "description": "a web server",
            "template_type": "kubernetes",
            "acl": "private",
            "id": "874ec485-e7e6-4373-8a3b-47bde8ae789f",
            "updated": "2020-06-10T16:30:16+08:00",
            "tags": "kubernetes"
        }
    ]
}

错误码

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