QueryTaskByParam - Direct Mail - Centro de documentación de Alibaba Cloud

Consulta las tareas.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dm:QueryTaskByParam

get

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PageNo	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10.	10
KeyWord	string	No	La palabra clave. Valor predeterminado: all.	mesh-notification-788717
Status	integer	No	El estado. Valor predeterminado: all.	0

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
PageSize	integer	El número de entradas por página.	10
RequestId	string	El ID de la solicitud.	10A1AD70-E48E-476D-98D9-39BD92193837
PageNumber	integer	El número de página.	3
TotalCount	integer	El número total de entradas.	15
data	object
task	array<object>	Los resultados devueltos.
	object
ReceiversName	string	El nombre del destinatario.	TKP000442-333
TagName	string	La etiqueta.	202201
TaskStatus	string	El estado de la tarea. Valores válidos: 1: Enviado correctamente.	1
CreateTime	string	La hora de creación en formato ISO 8601, con precisión de minutos.	2022-04-18T10:36Z
RequestCount	string	El número de solicitudes.	1
AddressType	string	El tipo de dirección. Valores válidos: 1: Dirección del remitente. 0: Dirección aleatoria.	0
UtcCreateTime	integer	La hora de creación en formato UTC.	1569734892
TemplateName	string	El nombre de la plantilla.	Short Simple
TaskId	string	El ID de la tarea.	1054296
IpPoolId	string	El ID del pool de direcciones IP dedicadas.	xxx
IpPoolName	string	El nombre del pool de direcciones IP dedicadas.	Test dedicated IP address pool 1
ConfigSetId	string	El ID del conjunto de configuración.	xxx
ConfigSetName	string	El nombre del conjunto de configuración.	xxx

Ejemplos

Respuesta exitosa

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": "测试专属IP地址池1",
        "ConfigSetId": "xxx",
        "ConfigSetName": "xxx"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
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 error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.