CreateDataCronClearOrder - Data Management - Centro de documentación de Alibaba Cloud

Crea un ticket de limpieza de datos históricos.

Descripción de la operación

Actualmente, esta API solo admite instancias de MySQL bajo el modo de control de Colaboración de Seguridad.

Para obtener más información sobre esta función, consulte Limpieza de datos históricos.

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

dms:CreateDataCronClearOrder

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Comment	string	Sí	El propósito u objetivo del cambio de datos. Esto reduce la comunicación innecesaria.	test
RelatedUserList	array	No	Las partes interesadas de esta operación. Todas las partes interesadas pueden ver los detalles del ticket y asistir en el proceso de aprobación. Los usuarios no relevantes, distintos de los administradores de Data Management (DMS) y los administradores de bases de datos (DBA), no tienen permiso para ver los detalles del ticket.
	integer	No	El ID de un usuario relacionado. Los usuarios especificados aquí pueden ver el ticket y colaborar en él. Los usuarios no incluidos en esta lista no pueden ver el ticket, a excepción de los administradores y los DBA.	243253
Param	object	Sí	Los parámetros del ticket.
Classify	string	No	El motivo del cambio de datos.	test
DbItemList	array<object>	Sí	Las bases de datos para las que desea limpiar datos históricos.
	object	No	Información de la base de datos.
DbId	integer	Sí	El ID de la base de datos. Puede llamar a la operación SearchDatabases para consultar el ID de la base de datos.	10****
Logic	boolean	Sí	Indica si la base de datos es una base de datos lógica. Valores válidos: true: La base de datos es una base de datos lógica. false: La base de datos no es una base de datos lógica.	false
CronFormat	string	Sí	La expresión crontab que puede utilizar para ejecutar la tarea a una hora especificada. Para obtener más información, consulte Expresión Crontab.	0 0 2 * * ?
CronClearItemList	array<object>	Sí	Las tablas para las que desea limpiar datos históricos.
	object	No	Información sobre las tablas de datos que se van a limpiar.
TableName	string	Sí	El nombre de la tabla. Puede llamar a la operación ListTables para consultar el nombre de la tabla.	t1
ColumnName	string	Sí	El nombre del campo.	gmt_create
RemainDays	integer	Sí	El periodo de retención de los datos históricos. Unidad: días. Por ejemplo, si establece el parámetro en 7, DMS elimina los datos que se han retenido durante más de siete días.	7
TimeUnit	string	No	El tipo de granularidad temporal. Si el parámetro ColumnName especifica un campo de tipo temporal, este parámetro es obligatorio. Valores válidos: MILLISECONDS: milisegundos SECONDS: segundos	MILLISECONDS
FilterSQL	string	No	Las condiciones de filtro.	where 1 = 1
specifyDuration	boolean	Sí	Especifica si se debe definir una hora de finalización para la tarea. Valores válidos: true: define una hora de finalización para la tarea. La tarea se suspende automáticamente después de esta hora de finalización. false: no define una hora de finalización para la tarea. La tarea se detiene después de que se limpian los datos históricos.	true
DurationHour	integer	No	La cantidad de tiempo dedicada a ejecutar la tarea. Unidad: horas. Nota Si el parámetro specifyDuration se establece en true, este parámetro es obligatorio.	4
AttachmentKey	string	No	La clave del archivo adjunto del ticket. El archivo adjunto proporciona más instrucciones para esta operación. Puede llamar a la operación GetUserUploadFileJob para consultar la clave del archivo adjunto.	order_attachement.txt
Tid	integer	No	El ID del inquilino. Nota El ID del inquilino se muestra cuando pasa el puntero sobre la imagen de perfil en la esquina superior derecha de la consola de DMS. Para obtener más información, consulte la sección Ver información sobre el inquilino actual del tema Administrar inquilinos de DMS.	123454324

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrorMessage	string	El mensaje de error.	UnknownError
ErrorCode	string	El código de error.	UnknownError
CreateOrderResult	array	El ID del ticket.
	integer	ID del ticket.	1341532

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    1341532
  ]
}

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.