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

Crea un ticket para exportar un conjunto de resultados SQL.

Descripción de la operación

Solo las instancias de base de datos con el modo de control establecido en Colaboración segura pueden invocar esta API.

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

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ParentId	integer	No	El ID del ticket principal.	877****
Comment	string	Sí	El propósito u objetivo del ticket. Este parámetro ayuda a reducir la comunicación innecesaria.	业务测试
AttachmentKey	string	No	La clave del archivo adjunto que proporciona más instrucciones para el ticket. Puede invocar la operación GetUserUploadFileJob para obtener la clave del archivo adjunto.	order_attachment.txt
RelatedUserList	array	No	Las partes interesadas involucradas en esta operación.
	integer	No	El ID de usuario de la parte interesada. Este ID es un ID de usuario y no el ID de una cuenta de Alibaba Cloud. Las partes interesadas involucradas en esta exportación. Todas las partes interesadas especificadas pueden ver los detalles del ticket y participar en el proceso de aprobación. Los usuarios no relacionados, excepto los administradores de Data Management (DMS) y los administradores de bases de datos (DBA), no tienen permiso para ver los detalles del ticket.	2452345113****
PluginParam	object	Sí	Los parámetros del ticket.
AffectRows	integer	Sí	El número estimado de filas de datos que se verán afectadas.	1
Classify	string	Sí	El motivo del ticket de exportación.	测试
InstanceId	integer	Sí	El ID de la instancia.	132****
DbId	integer	Sí	El ID de la base de datos.	18****
Logic	boolean	Sí	Especifica si la base de datos es una base de datos lógica. Valores válidos: true false Nota Si establece este parámetro en true, la base de datos que especifique debe ser una base de datos lógica.	true
IgnoreAffectRows	boolean	Sí	Especifica si se debe omitir la verificación. Valores válidos: true false	true
IgnoreAffectRowsReason	string	No	El motivo para omitir la verificación. Este parámetro es obligatorio si establece IgnoreAffectRows en true.	仅测试，不影响业务，无需校验
ExeSQL	string	Sí	Las sentencias SQL que se pueden ejecutar.	SELECT * FROM DMS_test LIMIT 20;
Watermark	object	No	La información sobre las marcas de agua.
WatermarkTypes	array	No	Los métodos mediante los cuales se incrusta la marca de agua.
	string	No	El método mediante el cual se incrusta la marca de agua. Valores válidos: DATA: incrusta información de identificación en los datos. FILE: incrusta información de identificación en los archivos. Para obtener más información sobre las marcas de agua, consulte Uso de marcas de agua de datos.	DATA
Keys	array	No	Una o más claves principales o claves únicas.
	string	No	Las claves principales o claves únicas. Separe varias claves con comas (,).	ID
ColumnName	string	No	El campo en el que se incrustará la marca de agua.	user_number
DataWatermark	string	No	La información que se incrustará como marca de agua en los datos.	测试
FileWatermark	string	No	La información que se incrustará como marca de agua en los archivos.	测试
Tid	integer	No	El ID del inquilino. Nota Para ver el ID del inquilino, pase 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 "Gestión de inquilinos de DMS".	3***
RealLoginUserUid	string	No	El UID de la cuenta de Alibaba Cloud que realmente invoca la API.	21400447956867****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud. Puede usar el ID para consultar registros y solucionar problemas.	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
ErrorCode	string	El código de error.	UnknownError
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
CreateOrderResult	object
CreateOrderResult	array	El contenido del ticket.
	integer	El ID del ticket.	819****
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true false	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "CreateOrderResult": {
    "CreateOrderResult": [
      0
    ]
  },
  "Success": true
}

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.