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

Obtiene una lista de orígenes de datos que coinciden con las condiciones de filtro especificadas.

Descripción de la operación

Debe adquirir DataWorks Basic Edition o una edición superior para utilizar esta operación.
Para invocar esta operación, debe tener uno de los siguientes roles en DataWorks:

Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator y Data Governance Administrator

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	Sí	El ID del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya a la página Espacio de trabajo para consultar el ID. Debe configurar este parámetro para especificar el espacio de trabajo de DataWorks al que se aplica la operación de API.	17820
Name	string	No	El nombre del origen de datos. Se admite la coincidencia aproximada por nombre de origen de datos.	test
Types	array	No	Los tipos de origen de datos. Este parámetro especifica una condición de filtro. Puede especificar varios tipos de origen de datos.
	string	No	El tipo de origen de datos.	mysql
EnvType	string	No	El entorno en el que se utilizan los orígenes de datos. Valores válidos: Dev: entorno de desarrollo Prod: entorno de producción	Prod
PageNumber	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
SortBy	string	No	El campo que desea utilizar para ordenar los orígenes de datos. Valores válidos: CreateTime: hora de creación Id: ID del origen de datos Name: nombre del origen de datos Valor predeterminado: CreateTime.	CreateTime
Order	string	No	El orden en el que desea ordenar los orígenes de datos. Valores válidos: Desc: orden descendente Asc: orden ascendente Valor predeterminado: Desc.	Desc
Tags	string	No	La etiqueta del origen de datos. Este parámetro especifica una condición de filtro. Puede especificar varias etiquetas, que tienen una relación lógica AND. Por ejemplo, puede consultar los orígenes de datos que contienen las siguientes etiquetas: `["tag1", "tag2", "tag3"]`. Si no configura este parámetro o lo deja vacío, no se realiza el filtrado basado en etiquetas. Puede especificar hasta 10 etiquetas.	["tag1", "tag2", "tag3"]

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	7BE1433F-6D55-5D86-9344-CA6F7DD19B13
PagingInfo	object	La información de paginación.
TotalCount	integer	El número total de entradas que cumplen las condiciones.	131
PageSize	integer	El número de entradas por página.	10
PageNumber	integer	El número de página.	1
DataSources	array<object>	Los grupos de orígenes de datos. Cada elemento de la matriz indica un grupo de orígenes de datos. Cada grupo de orígenes de datos contiene orígenes de datos en el entorno de desarrollo (si los hay) y en el entorno de producción.
	array<object>	La información sobre el grupo de orígenes de datos, incluidos los orígenes de datos en el entorno de desarrollo (si los hay) y el entorno de producción. Los orígenes de datos en el entorno de desarrollo y el entorno de producción tienen el mismo nombre y tipo de origen de datos, pero diferentes ID de origen de datos.
Name	string	El nombre del origen de datos.	test
Type	string	El tipo del origen de datos.	mysql
DataSource	array<object>	Los orígenes de datos. Cada elemento es la información de un único origen de datos con un ID de origen de datos único.
	object	La información sobre el origen de datos.
Id	integer	El ID del origen de datos.	16035
ConnectionProperties	any	Las configuraciones de conexión del origen de datos, incluidas la dirección de conexión, la identidad de acceso y la información del entorno. El parámetro envType especifica el entorno en el que se utiliza el origen de datos. Valores válidos del parámetro envType: Dev: entorno de desarrollo Prod: entorno de producción Los parámetros que debe configurar para el origen de datos varían según el modo en el que se añade el origen de datos. Para obtener más información, consulte Información 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	El modo en el que se añade el origen de datos. El modo varía según el tipo de origen de datos. Valores válidos: InstanceMode: modo de instancia UrlMode: modo de cadena de conexión	UrlMode
Description	string	La descripción del origen de datos.	test
CreateTime	integer	La hora en la que se añadió el origen de datos. Este valor es una marca de tiempo UNIX.	1648711113000
CreateUser	string	El ID del usuario que añadió el origen de datos.	1624387842781448
ModifyTime	integer	La hora en la que se modificó por última vez el origen de datos. Este valor es una marca de tiempo UNIX.	1648711113000
ModifyUser	string	El ID del usuario que modificó el origen de datos.	1624387842781448
QualifiedName	string	La clave de negocio única del origen de datos. Por ejemplo, la clave de negocio única de un origen de datos de Hologres tiene el formato `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`.	1648711121000:cn-beijing:odps:yongxunQA_beijing_standard

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "7BE1433F-6D55-5D86-9344-CA6F7DD19B13",
  "PagingInfo": {
    "TotalCount": 131,
    "PageSize": 10,
    "PageNumber": 1,
    "DataSources": [
      {
        "Name": "test",
        "Type": "mysql",
        "DataSource": [
          {
            "Id": 16035,
            "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": 1648711113000,
            "CreateUser": "1624387842781448",
            "ModifyTime": 1648711113000,
            "ModifyUser": "1624387842781448",
            "QualifiedName": "1648711121000:cn-beijing:odps:yongxunQA_beijing_standard"
          }
        ]
      }
    ]
  }
}

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.