GetDataSourceConnectionInfo - Quick BI - Centro de documentación de Alibaba Cloud

Obtiene la información del origen de datos.

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

quickbi-public:GetDataSourceConnectionInfo

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DsId	string	Sí	El ID del origen de datos.	7AAB95D-***-*-4FC0C976

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	7AAB95D-***-*-4FC0C976
Result	object	La información del origen de datos.
Address	string	La dirección de la cadena de conexión a la base de datos (dominio o IP).	172...48
AuthLevel	string	El nivel de permisos: 0 -- Privado 1 -- Edición colaborativa (antiguo) 11 -- Edición colaborativa - Miembros del espacio 12 -- Edición colaborativa - Especificada para individuos	0
CreatorId	string	El ID de usuario de Quick BI del creador.	U240****0880C6095
DsId	string	El ID del origen de datos.	a201c85c-******
DsType	string	El tipo de origen de datos. Valores válidos: hive : Origen de datos Hive. vertica : Origen de datos Vertica. ppas : Origen de datos RDS PPAS. dm : Origen de datos DM7-Dameng. tsdb : Origen de datos TSDB. tdsql : Origen de datos TDSQL-H. mysql_hybrid : Origen de datos HybridDB for MySQL. sqlserver : Origen de datos sqlserver. postgresql : Origen de datos postgresql. garuda : Origen de datos garuda. adb_spark : Motor Spark del origen de datos adb. greenplum : Origen de datos greenplum. phoenix_thin : Origen de datos PHOENIX THIN. dla : Origen de datos DataLake Analytics. starrocks : Origen de datos StarRocks. mysql : Origen de datos mysql. hana : Origen de datos SAP HANA. mongodb : Origen de datos MongoDB. adb : ADB. hbase : Origen de datos HBASE. oscar : Origen de datos Sheng Tong. gbase : Origen de datos Gbase. oracle : Origen de datos oracle. sybase : Origen de datos SAP SYBASE IQ. dataphin : Origen de datos DataPhin-Multimotor. odps : Origen de datos odps. db2 : Origen de datos IBM DB2 (LUW) yida : Origen de datos de aplicación yida. clickhouse : Origen de datos ClickHouse. oceanbase_oracle : Origen de datos OceanBase_Oracle. presto : Origen de datos presto. polardb : Origen de datos polardb. dataphin_odps : Motor odps del origen de datos DataPhin. selectdb : Origen de datos SelectDB.	mysql
DsVersion	string	La versión del origen de datos.	5.7
Instance	string	La instancia de base de datos, que corresponde al nombre de la base de datos; para ODPS, es el proyecto.	rm*********t44ju1
InstanceId	string	El ID de la instancia.	rm*********t44ju1
ModifyUser	string	El ID de usuario de Quick BI del modificador.	U240****0880C6095
NoSasl	boolean	Indica si el origen de datos impala requiere autenticación para iniciar sesión: true - Requiere inicio de sesión con cuenta y contraseña false - No se requiere autenticación (valor predeterminado)	true
ParentDsType	string	El tipo de origen de datos principal para orígenes de datos multimotor.	dataphin
Port	string	El puerto.	3306
Project	string	Se utiliza para la visualización en el frontend al obtener los detalles de conexión para ODPS.	prod-ossdoc
Schema	string	El esquema de la base de datos; solo es necesario configurarlo para bases de datos que admiten esquemas.	Analysis
ShowName	string	El nombre para mostrar del origen de datos en el frontend.	0327
WorkspaceId	string	El ID del espacio de trabajo al que pertenece el origen de datos.	0de62-d-4720-8836-0cc****1394c
Success	boolean	Indica si la operación se realizó correctamente.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "7AAB95D-*****-****-*4FC0C976",
  "Result": {
    "Address": "172.**.**.48",
    "AuthLevel": "0",
    "CreatorId": "U240****0880C6095",
    "DsId": "a201c85c-******",
    "DsType": "mysql",
    "DsVersion": "5.7",
    "Instance": "rm*********t44ju1",
    "InstanceId": "rm*********t44ju1",
    "ModifyUser": "U240****0880C6095",
    "NoSasl": true,
    "ParentDsType": "dataphin",
    "Port": "3306",
    "Project": "prod-ossdoc",
    "Schema": "Analysis",
    "ShowName": "0327",
    "WorkspaceId": "0de6**2-d**-4720-8836-0cc****1394c"
  },
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Invalid.Parameter	The length of the parameter must not exceed 1000.
400	Access.Forbidden	Your instance version or access key is not allowed to call the API operation, only professional version supports calling.
400	Internal.System.Error	An internal system error occurred.
400	Instance.Expired	Your instance has expired.
400	Instance.Not.Exist	The specified instance does not exist.
400	Invalid.Organization	The specified organizational unit does not exist.
400	User.Not.In.Organization	The specified user is not in the organizational unit.
400	Invalid.Param.Error	The parameter is invalid.
400	Invalid.Parameter.Error	The parameter is invalid:%s.
400	Datasource.NotFound.Error	The specified data source does not exist: %s.
400	Application.Object.NotExist	The object you are operating does not exist or has been deleted.

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.