QueryTemplateByParam - Direct Mail: Central de Documentação do Alibaba Cloud

Consulta as informações da lista de modelos por paginação.

Descrição da operação

Consulta as informações da lista de modelos por paginação.

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

dm:QueryTemplateByParam

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNo	integer	Não	O número da página atual. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 20.	20
KeyWord	string	Não	A palavra-chave do nome do modelo. Por padrão, uma consulta paginada é realizada em todos os modelos.	test
Status	integer	Não	Obsoleto. Mantido para compatibilidade com versões anteriores.	Abandoned, historical reasons for compatibility
FromType	integer	Não	Obsoleto. Mantido para compatibilidade com versões anteriores.	Abandoned, historical reasons for compatibility

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
PageSize	integer	O número de entradas por página.	20
RequestId	string	O ID da solicitação.	10Axxxxxxxxxxxx37
PageNumber	integer	O número da página atual.	1
TotalCount	integer	O número total de entradas.	21
data	object
template	array<object>	A matriz de informações do modelo.
	object	As informações do modelo.
TemplateComment	string	The review comments for the template.	pass
UtcCreatetime	integer	The creation time in UTC format.	1661830382
Smsrejectinfo	integer	Deprecated. Retained for backward compatibility.	Abandoned, historical reasons for compatibility
SmsTemplateCode	integer	Deprecated. Retained for backward compatibility.	Abandoned, historical reasons for compatibility
CreateTime	string	The creation time.	2019-09-29T13:28Z
TemplateStatus	string	The template status. Valid values: 0: draft. 1: pending review. 2: approved. 3: rejected.	2
TemplateType	integer	Deprecated. Retained for backward compatibility.	Abandoned, historical reasons for compatibility
TemplateName	string	The template name.	test
SmsStatus	integer	Deprecated. Retained for backward compatibility.	Abandoned, historical reasons for compatibility
TemplateId	string	The template ID.	3xxxx8

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 20,
  "RequestId": "10Axxxxxxxxxxxx37",
  "PageNumber": 1,
  "TotalCount": 21,
  "data": {
    "template": [
      {
        "TemplateComment": "pass",
        "UtcCreatetime": 1661830382,
        "Smsrejectinfo": 0,
        "SmsTemplateCode": 0,
        "CreateTime": "2019-09-29T13:28Z",
        "TemplateStatus": "2",
        "TemplateType": 0,
        "TemplateName": "test",
        "SmsStatus": 0,
        "TemplateId": "3xxxx8"
      }
    ]
  }
}

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.