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

Consulta tarefas com base em parâmetros especificados.

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:QueryTaskByParam

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. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10
KeyWord	string	Não	A palavra-chave para a consulta. Se você deixar em branco, todas as tarefas serão retornadas.	mesh-notification-788717
Status	integer	Não	O status da tarefa. Se você deixar em branco, tarefas em todos os estados serão retornadas.	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageSize	integer	O número de entradas por página.	10
RequestId	string	O ID da solicitação.	10A1AD70-E48E-476D-98D9-39BD92193837
PageNumber	integer	O número da página.	3
TotalCount	integer	O número total de entradas.	15
data	object
task	array<object>	Os dados retornados.
	object
ReceiversName	string	The recipient name.	TKP000442-333
TagName	string	The tag.	202201
TaskStatus	string	The task status. A value of 1 indicates that the email is sent.	1
CreateTime	string	The time when the task was created.	2022-04-18T10:36Z
RequestCount	string	The number of requests.	1
AddressType	string	The address type. 1: sender address. 0: random address.	0
UtcCreateTime	integer	The time when the task was created, in UTC format.	1569734892
TemplateName	string	The template name.	Short Simple
TaskId	string	The task ID.	1054296
IpPoolId	string	The ID of the dedicated IP address pool.	xxx
IpPoolName	string	The name of the dedicated IP address pool.	Test dedicated IP address pool 1
ConfigSetId	string	The configuration set ID.	xxx
ConfigSetName	string	The configuration set name.	xxx

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "PageNumber": 3,
  "TotalCount": 15,
  "data": {
    "task": [
      {
        "ReceiversName": "TKP000442-333",
        "TagName": "202201",
        "TaskStatus": "1",
        "CreateTime": "2022-04-18T10:36Z",
        "RequestCount": "1",
        "AddressType": "0",
        "UtcCreateTime": 1569734892,
        "TemplateName": "Short Simple",
        "TaskId": "1054296",
        "IpPoolId": "xxx",
        "IpPoolName": "Test dedicated IP address pool 1",
        "ConfigSetId": "xxx",
        "ConfigSetName": "xxx"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidKeyword.Malformed	The specified keyword is wrongly formed.
400	InvalidStatus.Malformed	The specified status is wrongly formed.
500	InternalError	The request processing has failed due to some unknown error.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.