文档

DescribeTemplateAttribute - 查询指定编排模板的详情

更新时间:

编排模板是对一组Kubernetes集群资源的定义和描述,以声明性方式描述应用应该如何运行或者配置。您可以调用DescribeTemplateAttribute接口,查询目标编排模板的详细信息,包括访问权限、YAML内容、标签等。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DescribeTemplateAttributeRead
  • 全部资源
    *

请求语法

GET /templates/{TemplateId}

请求参数

名称类型必填描述示例值
TemplateIdstring

模板 ID。

874ec485-e7e6-4373-8a3b-47bde8a****
template_typestring

模板类型,其值可以是任意值。

  • 当取值是kubernetes时将在控制台的编排模板页面展示该模板。

  • 当取值是compose时将在控制台 Swarm 集群页面显示该模板(已废弃)。

  • 当取值非kubernetes时在控制台的编排模板页面将不会展示该模板,推荐使用kubernetes

默认值:kubernetes

kubernetes

返回参数

名称类型描述示例值
object []

编排模板详情。

idstring

编排模板 ID,每次变更都会有一个模板 ID。

72d20cf8-a533-4ea9-a10d-e7630d3d****
aclstring

编排模板访问权限。

private
namestring

编排模板名称。

web
templatestring

编排模板 YAML 内容。

apiVersion: V1\n***
template_typestring

模板类型,其值可以是任意值。

  • 当取值是kubernetes时将在控制台的编排模板页面展示该模板。

  • 当取值是compose时将在控制台 Swarm 集群页面显示该模板(已废弃)。

  • 当取值非kubernetes时在控制台的编排模板页面将不会展示该模板,推荐使用kubernetes

默认值:kubernetes

kubernetes
descriptionstring

编排模板描述信息。

test template
tagsstring

部署模板的标签。

sa
template_with_hist_idstring

编排模板唯一 ID,不随模板更新而改变。

874ec485-e7e6-4373-8a3b-47bde8ae****
createdstring

编排模板创建时间。

2020-09-16T19:21:29+08:00
updatedstring

编排模板更新时间。

2020-09-16T19:21:29+08:00

示例

正常返回示例

JSON格式

[
  {
    "id": "72d20cf8-a533-4ea9-a10d-e7630d3d****",
    "acl": "private",
    "name": "web",
    "template": "apiVersion: V1\\n***",
    "template_type": "kubernetes",
    "description": "test template",
    "tags": "sa",
    "template_with_hist_id": "874ec485-e7e6-4373-8a3b-47bde8ae****",
    "created": "2020-09-16T19:21:29+08:00",
    "updated": "2020-09-16T19:21:29+08:00"
  }
]

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)