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

Consulta la información de la lista de plantillas mediante paginación.

Descripción de la operación

Consulta la información de la lista de plantillas mediante paginación.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PageNo	integer	No	El número de página actual. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 20.	20
KeyWord	string	No	La palabra clave del nombre de la plantilla. De forma predeterminada, se realiza una consulta paginada en todas las plantillas.	test
Status	integer	No	Obsoleto. Se conserva por compatibilidad con versiones anteriores.	Abandoned, historical reasons for compatibility
FromType	integer	No	Obsoleto. Se conserva por compatibilidad con versiones anteriores.	Abandoned, historical reasons for compatibility

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
PageSize	integer	El número de entradas por página.	20
RequestId	string	El ID de la solicitud.	10Axxxxxxxxxxxx37
PageNumber	integer	El número de página actual.	1
TotalCount	integer	El número total de entradas.	21
data	object
template	array<object>	La matriz de información de plantillas.
	object	La información de la plantilla.
TemplateComment	string	Los comentarios de revisión de la plantilla.	pass
UtcCreatetime	integer	La hora de creación en formato UTC.	1661830382
Smsrejectinfo	integer	Obsoleto. Se conserva por compatibilidad con versiones anteriores.	Abandoned, historical reasons for compatibility
SmsTemplateCode	integer	Obsoleto. Se conserva por compatibilidad con versiones anteriores.	Abandoned, historical reasons for compatibility
CreateTime	string	La hora de creación.	2019-09-29T13:28Z
TemplateStatus	string	El estado de la plantilla. Valores válidos: 0: borrador. 1: pendiente de revisión. 2: aprobada. 3: rechazada.	2
TemplateType	integer	Obsoleto. Se conserva por compatibilidad con versiones anteriores.	Abandoned, historical reasons for compatibility
TemplateName	string	El nombre de la plantilla.	test
SmsStatus	integer	Obsoleto. Se conserva por compatibilidad con versiones anteriores.	Abandoned, historical reasons for compatibility
TemplateId	string	El ID de la plantilla.	3xxxx8

Ejemplos

Respuesta exitosa

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 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.