DescribeTemplates - Container Service for Kubernetes: Central de Documentação do Alibaba Cloud

Um modelo de orquestração define e descreve um grupo de recursos do Kubernetes. Ele descreve de forma declarativa a configuração de uma aplicação ou como uma aplicação é executada. Você pode chamar a operação de API DescribeTemplates para consultar modelos de orquestração e suas informações detalhadas, incluindo permissões de acesso, conteúdo YAML e tags.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cs:DescribeTemplates

get

*全部资源

*

Nenhuma

Sintaxe da solicitação

GET /templates HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
template_type	string	Não	O tipo de modelo. Este parâmetro pode ser definido com um valor personalizado. Se o parâmetro for definido como `kubernetes`, o modelo será exibido na página Modelos no console. Se você definir o parâmetro como `compose`, o modelo não será exibido na página Modelos no console. Valor padrão: `kubernetes`.	kubernetes
page_num	integer	Não	O número da página. Valor padrão: 1.	1
page_size	integer	Não	O número de entradas por página. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
templates	array<object>	A lista de modelos retornada.
	object
acl	string	A política de controle de acesso do modelo. Valores válidos: `private`: O modelo é privado. `public`: O modelo é público. `shared`: O modelo pode ser compartilhado. Valor padrão: `private`.	private
id	string	O ID do modelo.	874ec485-e7e6-4373-8a3b-47bde8******
name	string	O nome do modelo.	webserver
description	string	A descrição do modelo.	a web server
tags	string	A tag do modelo. Por padrão, o valor é o nome do modelo.	kubernetes
template	string	O conteúdo do modelo no formato 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	O tipo de modelo. Este parâmetro pode ser definido com um valor personalizado. Se o parâmetro for definido como `kubernetes`, o modelo será exibido na página Modelos no console. Se o parâmetro for definido como `compose`, o modelo será exibido na página Container Service - Swarm no console. No entanto, o Container Service for Swarm foi descontinuado.	kubernetes
created	string	A hora em que o modelo foi criado.	2025-04-25T16:56:33+08:00
updated	string	A hora em que o modelo foi atualizado.	2025-04-25T16:56:33+08:00
template_with_hist_id	string	O ID do modelo pai. O valor de `template_with_hist_id` é o mesmo para cada versão do modelo. Isso permite que você gerencie diferentes versões do modelo.	ad81d115-7c8b-47e7-a222-9c28d7******
page_info	object	As informações de paginação.
page_number	integer	O número da página.	20
page_size	integer	O número de entradas por página.	3
total_count	integer	O número total de entradas retornadas.	50

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.