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

Consulta la información de una tarea de sincronización de esquemas.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
OrderId	integer	Sí	El ID del ticket.	4324321
Tid	integer	No	El ID del inquilino. Nota Para ver el ID del inquilino, pase el puntero sobre la foto de perfil en la esquina superior derecha de la consola de Data Management (DMS). Para obtener más información, consulte Gestionar inquilinos de DMS.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	48602B78-0DDF-414C-8688-70CAB6070115
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
StructSyncJobDetail	object	Los detalles de la tarea de sincronización de esquemas.
JobStatus	string	El estado de la tarea. Valores válidos: NEW: La tarea fue creada. COMPARING: Se estaban comparando los esquemas de las tablas. COMPARE_BREAK: La comparación de esquemas se interrumpió. COMPARE_FINISH: La comparación finalizó. NOT_SCRIPTS: La comparación finalizó, pero no había ningún script ejecutable disponible. SUBMITED_DBTASK: La tarea fue enviada. DBTASK_SUCCESS: La tarea se completó. SUBMITED_WORKFLOW: El ticket fue enviado. WORKFLOW_SUCCESS: El ticket fue aprobado.	DBTASK_SUCCESS
Message	string	La descripción de la tarea.	test
TableAnalyzed	integer	El número de tablas que se han analizado.	2
TableCount	integer	El número total de tablas.	2
SqlCount	integer	El número total de sentencias SQL.	1
ExecuteCount	integer	El número de sentencias SQL que se han ejecutado.	1
SecurityRule	string	El tipo de regla de seguridad. Valores válidos: CANNOT_SYNC: No se puede realizar la sincronización. WITH_APPROVE: La sincronización de esquemas se puede realizar después de que se apruebe el ticket. Puede llamar a la operación SubmitStructSyncOrderApproval para enviar el ticket para su aprobación. WITHOUT_APPROVE: La sincronización de esquemas se puede realizar sin aprobación.	WITHOUT_APPROVE
DBTaskGroupId	integer	El ID del grupo de tareas SQL.	12345

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "48602B78-0DDF-414C-8688-70CAB6070115",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "StructSyncJobDetail": {
    "JobStatus": "DBTASK_SUCCESS",
    "Message": "test",
    "TableAnalyzed": 2,
    "TableCount": 2,
    "SqlCount": 1,
    "ExecuteCount": 1,
    "SecurityRule": "WITHOUT_APPROVE",
    "DBTaskGroupId": 12345
  }
}

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.