DescribeTemplates - : Central de Documentação do Alibaba Cloud

Consulta todos os modelos de implantação de aplicativos.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Sintaxe da solicitação

GET /templates?template_type=String&page_num=Long&page_size=Long HTTP/1.1 
Content-Type:application/json

Parâmetros da solicitação

Tabela 1. Parâmetros de consulta da solicitação
Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
template_type	String	Sim	kubernetes	Tipo dos modelos a consultar. É possível definir este parâmetro com um valor personalizado. Se definido como `kubernetes`, o modelo aparece na página Templates no console do Container Service for Kubernetes (ACK). Se definido como `compose`, o modelo não aparece na página Templates no console do ACK. Valor padrão: `kubernetes`.
page_num	Long	Não	1	Número da página a retornar. Valor padrão: 1.
page_size	Long	Não	10	Quantidade de entradas a retornar por página. Valor padrão: 10.

Sintaxe da resposta

HTTP/1.1 200
Content-Type:application/json
{
  "templates" : [ {
    "acl" : "String",
    "id" : "String",
    "name" : "String",
    "description" : "String",
    "tags" : "String",
    "template" : "String",
    "template_type" : "String",
    "created" : "String",
    "updated" : "String",
    "template_with_hist_id" : "String"
  } ],
  "page_info" : {
    "page_number" : Long,
    "page_size" : Long,
    "total_count" : Long
  }
}

Parâmetros da resposta

Tabela 2. Parâmetros do corpo da resposta
Parâmetro	Tipo	Exemplo	Descrição
templates	Array of template		Lista de modelos retornados.
acl	String	private	Política de controle de acesso do modelo. Valores válidos: `private`: modelo privado. `public`: modelo público. `shared`: modelo compartilhável. Valor padrão: `private`.
id	String	874ec485-e7e6-4373-8a3b-47bde8ae789f	ID do modelo.
name	String	webserver	Nome do modelo.
description	String	a web server	Descrição do modelo.
tags	String	kubernetes	Tag do modelo. Por padrão, corresponde ao nome do modelo.
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	Conteúdo do modelo em formato YAML.
template_type	String	kubernetes	Tipo do modelo. O valor pode ser personalizado. Se definido como `kubernetes`, o modelo aparece na página Templates no console do ACK. Se definido como `compose`, o modelo aparece na página Container Service - Swarm no console. No entanto, o Container Service for Swarm foi descontinuado.
created	String	2020-06-10T16:30:16+08:00	Data e hora de criação do modelo.
updated	String	2020-06-10T16:30:16+08:00	Data e hora da última atualização do modelo.
template_with_hist_id	String	ad81d115-7c8b-47e7-a222-9c28d7f6e588	ID do modelo pai. O valor de `template_with_hist_id` permanece igual em todas as versões do modelo, permitindo gerenciar diferentes versões.
page_info	object		Detalhes de paginação.
page_number	Long	20	Número da página retornada.
page_size	Long	3	Número máximo de entradas retornadas por página.
total_count	Long	50	Número total de entradas retornadas.

Exemplos

Exemplos de solicitações

GET /templates?template_type=kubernetes&page_num=1&page_size=10 HTTP/1.1 
Content-Type:application/json

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

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

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "templates" : [ {
    "acl" : "private",
    "id" : "874ec485-e7e6-4373-8a3b-47bde8ae789f",
    "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" : "2020-06-10T16:30:16+08:00",
    "updated" : "2020-06-10T16:30:16+08:00",
    "template_with_hist_id" : "ad81d115-7c8b-47e7-a222-9c28d7f6e588"
  } ],
  "page_info" : {
    "page_number" : 20,
    "page_size" : 3,
    "total_count" : 50
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.