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

Consulta un origen de datos especificado por su ID de origen de datos.

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:

Tenant Owner, Workspace Administrator, Deployment, Developer, Project Owner u O&M Engineer

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	integer	Sí	El ID del origen de datos, que es el identificador único del origen de datos.	16035

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
RequestId	string	El ID de la solicitud. Se utiliza para localizar registros y solucionar problemas.	9252F32F-D855-549E-8898-61CF5A733050
DataSource	object	Los detalles del origen de datos.
Id	integer	El ID del origen de datos.	16738
ProjectId	integer	El ID del espacio de trabajo al que pertenece el origen de datos.	52660
Name	string	El nombre del origen de datos.	test
Type	string	El tipo del origen de datos.	hologres
ConnectionProperties	any	La configuración de conexión del origen de datos, que incluye el endpoint, la identidad de acceso y el contexto del entorno. El tipo de entorno del origen de datos (envType) es una propiedad miembro de este objeto. Valores válidos: Dev: entorno de desarrollo. Prod: entorno de producción. Los diferentes tipos de orígenes de datos tienen distintas especificaciones de propiedades según los distintos modos de configuración (ConnectionPropertiesMode). Para obtener más información, consulte Propiedades de conexión del origen de datos (ConnectionProperties).	{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
ConnectionPropertiesMode	string	La categoría en la que se agrega el origen de datos. Los diferentes tipos tienen distintos subtipos con diferentes restricciones de parámetros. Ejemplos: InstanceMode: modo de instancia. UrlMode: modo de cadena de conexión. CdhMode: modo CDH.	UrlMode
Description	string	La descripción del origen de datos.	test
CreateTime	integer	La hora en que se creó el origen de datos (marca de tiempo).	1698286929333
CreateUser	string	El ID del usuario que creó el origen de datos.	1107550004253538
ModifyTime	integer	La hora en que se modificó por última vez el origen de datos (marca de tiempo).	1698286929333
ModifyUser	string	El ID del usuario que modificó por última vez el origen de datos.	1107550004253538
QualifiedName	string	La clave única de negocio del origen de datos. Por ejemplo, el formato para un origen de datos de Hologres es `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`.	1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "DataSource": {
    "Id": 16738,
    "ProjectId": 52660,
    "Name": "test",
    "Type": "hologres",
    "ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n    \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n    \"database\": \"testdb\",\n    \"securityProtocol\": \"authTypeNone\",\n    \"authType\": \"Executor\",\n    \"authIdentity\": \"1107550004253538\"\n}",
    "ConnectionPropertiesMode": "UrlMode",
    "Description": "test",
    "CreateTime": 1698286929333,
    "CreateUser": "1107550004253538",
    "ModifyTime": 1698286929333,
    "ModifyUser": "1107550004253538",
    "QualifiedName": "1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb"
  }
}

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.