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

Consulta uma lista de modelos privados e compartilhados.

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

ros:ListTemplates

list

*Template

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página da lista de modelos. O valor começa em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página para uma consulta paginada. Valores válidos: 1 a 50. Valor padrão: 10.	10
TemplateName	string	Não	O nome do modelo. Este parâmetro só entra em vigor quando ShareType é definido como Private. O nome pode ter até 255 caracteres. Deve começar com um dígito ou uma letra e pode conter dígitos, letras, hifens (-) e sublinhados (_).	MyTemplate
ShareType	string	Não	O tipo de compartilhamento do modelo. Valores válidos: Private (padrão): O modelo é de propriedade do usuário. Shared: O modelo é compartilhado por outros usuários. Official: O modelo é um modelo oficial compartilhado.	Private
Tag	array<object>	Não	As tags. Você pode especificar até 20 tags.
	object	Não	A tag.
Key	string	Não	A chave da tag. Este parâmetro só entra em vigor quando ShareType é definido como Private. Você pode especificar até 20 chaves de tag.	usage
Value	string	Não	O valor da tag. Este parâmetro só entra em vigor quando ShareType é definido como Private. Você pode especificar até 20 valores de tag.	deploy
ResourceGroupId	string	Não	O ID do grupo de recursos. Para obter mais informações sobre grupos de recursos, consulte O que é um grupo de recursos?.	rg-acfmxazb4ph6aiy****
IncludeTags	string	Não	Especifica se as informações de tag devem ser consultadas. Valores válidos: Enabled: consulta as informações de tag. Disabled (padrão): não consulta as informações de tag.	Enabled
Filters	array<object>	Não	O filtro.
	object	Não	O filtro.
Name	string	Não	O nome do filtro. Você pode selecionar um ou mais nomes para consultar. Valores válidos: Categories: categoria do modelo DeployTypes: tipo de implantação ApplicationScenes: cenário de aplicação BasicServices: serviço básico ResourceTypes: tipo de recurso TemplateNames: nome do modelo	Categories
Values	array	Não	A lista de valores de filtro.
	string	Não	A lista de valores de filtro. O valor de N pode ser de 1 a 10.	ROS

Para obter mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de modelos.	1
PageSize	integer	O número de entradas retornadas por página.	10
RequestId	string	O ID da solicitação.	C3A8413B-1F16-4DED-AC3E-61A00718DE8A
PageNumber	integer	O número da página da lista de modelos. O valor começa em 1.	1
Templates	array<object>	A lista de modelos.
	array<object>	A lista de modelos.
TemplateARN	string	O Alibaba Cloud Resource Name (ARN) do modelo.	acs:ros::151266687691*:template/a52f81be-496f-4e1c-a286-8852ab54**
UpdateTime	string	A hora da última atualização do modelo.	2019-10-15T08:17:14.000000
Description	string	A descrição do modelo.	test-description
CreateTime	string	A hora em que o modelo foi criado.	2019-10-15T08:17:14.000000
TemplateName	string	O nome do modelo.	demo
TemplateVersion	string	O nome da versão mais recente do modelo.	v1
TemplateId	string	O ID do modelo.	4d4f5aa2-3260-4e47-863b-763fbb12****
OwnerId	string	O ID da conta Alibaba Cloud à qual o modelo pertence.	151266687691****
ShareType	string	O tipo de compartilhamento do modelo. Valores válidos: Private: O modelo é de propriedade do usuário. Shared: O modelo é compartilhado por outros usuários.	Private
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmxazb4ph6aiy****
Tags	array<object>	As tags do modelo.
	object	As tags do modelo.
Key	string	The tag key of the template.	usage
Value	string	The tag value of the template.	test
AdditionalInfo	object	As informações suplementares sobre o modelo público.	{"DeploymentDuration":null,"Title":"Self-Built_ElasticSearch_Snapshot_Saved_To_OSS","Labels":{"ResourceTypes":["ALIYUN::ECS::Instance","ALIYUN::ECS::SecurityGroup","ALIYUN::ECS::VPC","ALIYUN::ECS::VSwitch","ALIYUN::OSS::Bucket","ALIYUN::ROS::WaitCondition","ALIYUN::ROS::WaitConditionHandle"],"DeployTypes":["ROS"],"ApplicationScenes":["other"]},"Provider":"ROS","Categories":["Solution"]}
TemplateUrl	string	A URL do modelo.	https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "C3A8413B-1F16-4DED-AC3E-61A00718DE8A",
  "PageNumber": 1,
  "Templates": [
    {
      "TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
      "UpdateTime": "2019-10-15T08:17:14.000000",
      "Description": "test-description",
      "CreateTime": "2019-10-15T08:17:14.000000",
      "TemplateName": "demo",
      "TemplateVersion": "v1",
      "TemplateId": "4d4f5aa2-3260-4e47-863b-763fbb12****",
      "OwnerId": "151266687691****",
      "ShareType": "Private",
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "Tags": [
        {
          "Key": "usage",
          "Value": "test"
        }
      ],
      "AdditionalInfo": {
        "DeploymentDuration": null,
        "Title": "Self-Built_ElasticSearch_Snapshot_Saved_To_OSS",
        "Labels": {
          "ResourceTypes": [
            "ALIYUN::ECS::Instance",
            "ALIYUN::ECS::SecurityGroup",
            "ALIYUN::ECS::VPC",
            "ALIYUN::ECS::VSwitch",
            "ALIYUN::OSS::Bucket",
            "ALIYUN::ROS::WaitCondition",
            "ALIYUN::ROS::WaitConditionHandle"
          ],
          "DeployTypes": [
            "ROS"
          ],
          "ApplicationScenes": [
            "other"
          ]
        },
        "Provider": "ROS",
        "Categories": [
          "Solution"
        ]
      },
      "TemplateUrl": "https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml"
    }
  ]
}

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.