ListTemplates - CloudOps Orchestration Service: Central de Documentação do Alibaba Cloud

Consulta modelos. Suporta múltiplos métodos de filtragem.

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

oos:ListTemplates

get

Template

acs:oos:{#regionId}:{#accountId}:template/*

Template

acs:oos:{#regionId}:{#accountId}:template/{#templateName}

oos:tag
oos:TLSVersion

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-hangzhou
TemplateName	string	Não	O nome do modelo. Todos os modelos cujos nomes contêm o nome do modelo especificado são retornados.	MyTemplate
TemplateFormat	string	Não	O formato do modelo. Valores válidos: JSON YAML	YAML
ShareType	string	Não	O tipo de compartilhamento. Valores válidos: Public Private	Private
CreatedBy	string	Não	O criador do modelo. Para modelos oficiais fornecidos pelo Alibaba Cloud, o valor é ACS. Para modelos criados por usuários, você pode especificar um UID ou um nome de usuário para filtrar modelos.	ACS
CreatedDateBefore	string	Não	Filtra modelos cuja hora de criação é anterior ou igual à hora especificada. Formato: YYYY-MM-DDThh:mm:ssZ	2019-05-16T10:26:14Z
CreatedDateAfter	string	Não	Filtra modelos cuja hora de criação é posterior ou igual à hora especificada. Formato: YYYY-MM-DDThh:mm:ssZ	2019-05-16T10:26:14Z
Tags	object	Não	As tags em pares chave-valor. O número de pares chave-valor varia de 1 a 20.	{"k1":"k2","k2":"v2"}
Category	string	Não	A categoria do modelo, como TimerTrigger, EventTrigger, AlarmTrigger ou Other.	TimerTrigger
MaxResults	integer	Não	O número de entradas por página. Valores válidos: 10 a 100. Valor padrão: 50.	50
NextToken	string	Não	O token usado para recuperar a próxima página de resultados. Este valor é obtido da resposta da página atual se houver mais resultados disponíveis.	xxx
SortField	string	Não	O campo usado para classificar os resultados da consulta. Valores válidos: TotalExecutionCount (padrão): número total de execuções Popularity: popularidade TemplateName: nome do modelo CreatedDate: hora de criação UpdatedDate: hora de atualização	Popularity
SortOrder	string	Não	A ordem de classificação. Valores válidos: Ascending: ordem crescente Descending (padrão): ordem decrescente	Descending
HasTrigger	boolean	Não	Especifica se o modelo possui um gatilho.	true
TemplateType	string	Não	O tipo de modelo. Valores válidos: Automation: automação State: inventário de configuração Package: pacote de software Valores válidos: Automation : Automation. State : State. Package : Package.	Automation
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmxsn4m4******
IsFavorite	boolean	Não	Especifica se o modelo foi adicionado aos favoritos.	true
IsExample	boolean	Não	Especifica se o modelo é um modelo de exemplo.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token usado para recuperar a próxima página de resultados. Este valor é obtido da resposta da página atual se houver mais resultados disponíveis.	xxx
RequestId	string	O ID da solicitação.	BEF54BA-17B6-449F-A219-49ACB157E3
MaxResults	integer	O número de entradas por página.	50
Templates	array<object>	Os metadados do modelo.
	array<object>
Hash	string	O hash SHA-256 do conteúdo do modelo.	4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4
UpdatedDate	string	A hora em que o modelo foi atualizado pela última vez.	2019-05-16T10:26:14Z
UpdatedBy	string	O usuário que atualizou o modelo pela última vez.	root(13092000)
TemplateType	string	O tipo de modelo.	private
Tags	object	As tags em pares chave-valor. O número de pares chave-valor varia de 1 a 20.	{"k1":"v1","k2":"v2"}
TemplateName	string	O nome do modelo.	MyTemplate
TemplateVersion	string	A versão do modelo, no formato "v" seguido por um número começando em 1.	v1
TemplateFormat	string	O formato do modelo. O sistema determina o formato, que é JSON ou YAML.	JSON
Popularity	integer	A popularidade do modelo público. O valor varia de 1 a 10. Um valor maior indica maior popularidade. Se ShareType for Private, o valor deste campo é `-1`. Nota Este campo é significativo apenas quando ShareType é Public.	8
TotalExecutionCount	integer	O número total de execuções para o modelo privado. Se ShareType for Public, o valor deste campo é `-1`. Nota Este campo é significativo apenas quando ShareType é Private.	5
Description	string	A descrição do modelo.	Descrever instâncias de determinado status
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmxsn4m4******
CreatedBy	string	O criador do modelo.	root(1309200)
CreatedDate	string	A hora em que o modelo foi criado.	2019-05-16T10:26:14Z
Category	string	O tipo de modelo.	TimerTrigger
HasTrigger	boolean	Indica se o modelo foi acionado com sucesso.	true
TemplateId	string	O ID do modelo.	t-94753deed38
ShareType	string	O tipo de compartilhamento do modelo. Modelos criados por usuários têm um tipo de compartilhamento Private. Valores válidos: Public Private	Public
IsFavorite	boolean	Especifica se o modelo foi adicionado aos favoritos.	true
Publisher	string	O publicador.	aliyun
Constraints	string	As restrições.	{ "InstanceTypeFamilies": ["ecs.g8y", "ecs.c8y"], "ImageTypes": ["system"], "OSPlatforms": ["CentOS", "Ubuntu"], "OSVersions": ["CentOS7.9 64bit"] }
VersionName	string	O nome da versão.	3

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "xxx",
  "RequestId": "BEF54BA-17B6-449F-A219-49ACB157E3",
  "MaxResults": 50,
  "Templates": [
    {
      "Hash": "4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4",
      "UpdatedDate": "2019-05-16T10:26:14Z",
      "UpdatedBy": "root(13092000)",
      "TemplateType": "private",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "TemplateName": "MyTemplate",
      "TemplateVersion": "v1",
      "TemplateFormat": "JSON",
      "Popularity": 8,
      "TotalExecutionCount": 5,
      "Description": "Descrever instâncias com determinado status",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedBy": "root(1309200)",
      "CreatedDate": "2019-05-16T10:26:14Z",
      "Category": "TimerTrigger",
      "HasTrigger": true,
      "TemplateId": "t-94753deed38",
      "ShareType": "Public",
      "IsFavorite": true,
      "Publisher": "aliyun",
      "Constraints": "{\n  \"InstanceTypeFamilies\": [\"ecs.g8y\", \"ecs.c8y\"],\n  \"ImageTypes\": [\"system\"],\n  \"OSPlatforms\": [\"CentOS\", \"Ubuntu\"],\n  \"OSVersions\": [\"CentOS7.9 64bit\"]\n}",
      "VersionName": "3"
    }
  ]
}

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.