ListScheduledTasks - OpenSearch - Centro de documentación de Alibaba Cloud

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

opensearch:ListScheduledTask

list

*ScheduledTask

acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

Ninguna

Sintaxis de la solicitud

GET /v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
appGroupIdentity	string	Sí	El nombre de la aplicación.	my_app_group_name

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
type	string	No	El tipo de tarea programada. Valores válidos: wipe: limpieza de datos fork: reindexación check-status: verificación del estado de la aplicación index: reindexación	wipe
pageNumber	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

Parámetros de consulta

Campo	Tipo	Obligatorio	Ejemplo	Descripción
id	String	No	"2f12c585-5873-11ea-974a-7cd30ad3e268"	El ID de la tarea.
enabled	Boolean	No	true	Especifica si la tarea programada está habilitada.
updated	Integer	No	1582706232	La marca de tiempo de la última actualización de la tarea programada.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
totalCount	integer	El número total de tareas programadas.	1
requestId	string	El ID de la solicitud.	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	array<object>
	object	La información sobre la tarea programada. Para obtener más información, consulte ScheduledTask.	[]

Ejemplos

Respuesta exitosa

JSON Formato

{
  "totalCount": 1,
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    []
  ]
}

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.