DescribeHistoryTasks - PolarDB - Centro de documentación de Alibaba Cloud

Consulta la lista de tareas históricas de PolarDB for MySQL.

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

polardb:DescribeHistoryTasks

get

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	No	El ID de la región. Nota Puede llamar a la operación DescribeRegions para consultar la información de la región.	cn-beijing
PageSize	integer	No	El número de entradas por página. Valores válidos: de 10 a 100. Valor predeterminado: 10.	10
PageNumber	integer	No	El número de página de los resultados de la consulta. Valores válidos: enteros positivos. Valor predeterminado: 1.	1
InstanceType	string	No	Actualmente, solo se admite Instance.	Instance
Status	string	No	El estado de la tarea. Valores válidos: Scheduled: En espera de ejecución. Running: En ejecución. Succeed: Completada. Cancelling: En cancelación. Canceled: Cancelada. Waiting: En espera de la hora programada. Separe varios estados con comas (,). Valor predeterminado: vacío, lo que indica que se incluyen todos los estados.	Running
InstanceId	string	No	El ID del recurso. Especifique este parámetro para consultar las tareas del recurso correspondiente. Separe varios ID con comas (,). Se admite un máximo de 30 ID. Valor predeterminado: vacío, lo que indica que no hay restricciones. Nota Actualmente, solo se admiten los ID de clúster.	pc-2zed3m89cw***
TaskId	string	No	El ID de la tarea. Separe varios ID de tarea con comas (,). Se admite un máximo de 30 ID. Valor predeterminado: vacío, lo que indica que no hay restricciones.	t-0mqi38ho0cgjv***
TaskType	string	No	El tipo de tarea. Especifique este parámetro para consultar tareas de un tipo específico. Separe varios tipos con comas (,). Se admite un máximo de 30 tipos. Valor predeterminado: vacío, lo que indica que no hay restricciones.	ChangeVariable
FromStartTime	string	Sí	El inicio del intervalo de tiempo para la hora de inicio de la tarea. Se consultan las tareas cuya hora de inicio es posterior a esta hora. Especifique la hora en el estándar ISO 8601 en el formato `yyyy-MM-ddTHH:mm:ssZ`. La hora debe estar en `UTC+0`. La hora más antigua admitida es 30 días antes de la hora actual. Un valor anterior a 30 días se convierte automáticamente a 30 días antes de la hora actual.	2025-01-02T11:31:03Z
ToStartTime	string	Sí	El fin del intervalo de tiempo para la hora de inicio de la tarea. Se consultan las tareas cuya hora de inicio es anterior a esta hora. Especifique la hora en el estándar ISO 8601 en el formato `yyyy-MM-ddTHH:mm:ssZ`. La hora debe estar en `UTC+0`.	2025-01-03T11:31:03Z
FromExecTime	integer	No	La duración mínima de ejecución. Filtra las tareas cuya duración de ejecución es mayor que este valor. Unidad: segundos. Valor predeterminado: 0, lo que indica que no hay restricciones.	0
ToExecTime	integer	No	La duración máxima de ejecución. Filtra las tareas cuya duración de ejecución es menor que este valor. Unidad: segundos. Valor predeterminado: 0, lo que indica que no hay restricciones.	0
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-************

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de la respuesta.
PageNumber	integer	El número de página de los resultados de la consulta.	1
RequestId	string	El ID de la solicitud.	F90D7C14-2D1C-5B88-9CD1-23AB2CF89***
PageSize	integer	El número de entradas por página.	10
TotalCount	string	El número total de tareas que cumplen las condiciones de filtro, independientemente de la paginación.	2
Items	array<object>	La lista de tareas.
	object	El objeto de la tarea.
Status	string	El estado de la tarea. Scheduled: En espera de ejecución. Running: En ejecución. Succeed: Completada. Failed: Fallida. Cancelling: En cancelación. Canceled: Cancelada. Waiting: En espera de la hora programada.	Succeed
TaskId	string	El ID de la tarea.	t-0mqt8qhnw04ipz0***
CurrentStepName	string	El nombre del paso actual que se está ejecutando. Un valor vacío indica que la tarea no ha comenzado.	finish_task
StartTime	string	La hora de inicio de la tarea. La hora está en el estándar ISO 8601 en el formato YYYY-MM-DDTHH:mm:ssZ. La hora se muestra en UTC.	2025-03-03T07:25:16Z
EndTime	string	La hora de finalización de la tarea. La hora está en el estándar ISO 8601 en el formato YYYY-MM-DDTHH:mm:ssZ. La hora se muestra en UTC.	2025-03-03T07:30:57Z
TaskType	string	El tipo de tarea.	ChangeVariable
RemainTime	integer	La duración restante estimada de ejecución. Unidad: segundos. Nota Este valor es solo de referencia. La duración real de ejecución puede variar.	0
Progress	number	El progreso actual.	100.0
RegionId	string	El ID de la región.	cn-beijing
InstanceType	string	El tipo de recurso.	Instance
InstanceId	string	El ID del recurso.	pc-2zed3m89cw***
InstanceName	string	El nombre del recurso.	pc-2zed3m89cw***
DbType	string	El tipo de base de datos.	polardb_mysql
Product	string	El producto.	polardb
TaskDetail	string	Los detalles de la tarea.	{\"steps\":[{\"step_name\":\"init_task\"},{\"step_name\":\"exec_task\"},{\"step_name\":\"finish_task\"}]}
ReasonCode	string	El motivo por el que se inició la tarea actual.	""
ActionInfo	string	La información de las operaciones permitidas. Nota Esta función no se admite.	{}
Uid	string	El ID del usuario al que pertenece el recurso.	1816563541899***
CallerSource	string	El origen de la solicitud. Valores válidos: System: sistema. User: usuario.	User
CallerUid	string	El ID del usuario solicitante. Cuando CallerSource se establece en User, este valor representa el UID del usuario.	1816563541899***

Ejemplos

Respuesta exitosa

JSON Formato

{
  "PageNumber": 1,
  "RequestId": "F90D7C14-2D1C-5B88-9CD1-23AB2CF89***",
  "PageSize": 10,
  "TotalCount": "2",
  "Items": [
    {
      "Status": "Succeed",
      "TaskId": "t-0mqt8qhnw04ipz0***",
      "CurrentStepName": "finish_task",
      "StartTime": "2025-03-03T07:25:16Z",
      "EndTime": "2025-03-03T07:30:57Z",
      "TaskType": "ChangeVariable",
      "RemainTime": 0,
      "Progress": 100,
      "RegionId": "cn-beijing",
      "InstanceType": "Instance",
      "InstanceId": "pc-2zed3m89cw***",
      "InstanceName": "pc-2zed3m89cw***",
      "DbType": "polardb_mysql",
      "Product": "polardb",
      "TaskDetail": "{\\\"steps\\\":[{\\\"step_name\\\":\\\"init_task\\\"},{\\\"step_name\\\":\\\"exec_task\\\"},{\\\"step_name\\\":\\\"finish_task\\\"}]}",
      "ReasonCode": "\"\"",
      "ActionInfo": "{}",
      "Uid": "1816563541899***",
      "CallerSource": "User",
      "CallerUid": "1816563541899***"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Param.Invalid	The parameter is invalid.	El parámetro no es válido.

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.