TestDataSourceConnectivity - DataWorks - Centro de documentación de Alibaba Cloud

Prueba la conectividad de una fuente de datos en un grupo de recursos.

Descripción de la operación

Debe adquirir DataWorks Basic Edition o una edición superior para utilizar esta función.
Debe tener al menos uno de los siguientes roles en el espacio de trabajo de DataWorks:<br> propietario del inquilino, administrador del espacio de trabajo, desplegador, desarrollador, propietario del proyecto u operador.

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

dataworks:TestDataSourceConnectivity

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ResourceGroupId	string	Sí	El ID del grupo de recursos.	Serverless_res_group_524257424564736_6831777003XXXXX
DataSourceId	integer	Sí	El ID de la fuente de datos cuya conectividad de red desea probar.	144544
ProjectId	integer	Sí	El ID del espacio de trabajo de DataWorks.	10001

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	4CDF7B72-020B-542A-8465-21CFFA81****
Connectivity	object	Los detalles de la prueba de conectividad.
ConnectState	string	El resultado de la prueba de conectividad. Valores válidos: Connectable: la red puede conectarse. ConfigError: la red puede conectarse, pero la configuración es incorrecta. Unreachable: la red no puede conectarse. Unsupport: el escenario no es compatible. Por ejemplo, el grupo de recursos deseado se está inicializando.	Connectable
ConnectMessage	string	El mensaje de error que se devuelve si la prueba de conectividad falla. No se devuelve dicho mensaje si la prueba de conectividad se realiza correctamente.	Failed to connect to the database.
DetailLogs	array<object>	Los registros detallados de cada paso de la prueba de conectividad.
	object
StartTime	integer	La hora de inicio de un paso.	1730217600001
EndTime	integer	La hora de finalización de un paso.	1730217604002
Code	string	El código del elemento de prueba.	validate_input_parameters
Message	string	El nombre del paso.	Validate input parameters

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "4CDF7B72-020B-542A-8465-21CFFA81****",
  "Connectivity": {
    "ConnectState": "Connectable",
    "ConnectMessage": "连接数据库失败",
    "DetailLogs": [
      {
        "StartTime": 1730217600001,
        "EndTime": 1730217604002,
        "Code": "validate_input_parameters",
        "Message": "校验输入参数"
      }
    ]
  }
}

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.