ListDataSources - - Centro de documentación de Alibaba Cloud

Consulta los orígenes de datos agregados a un espacio de trabajo de DataWorks.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda invocar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListDataSources	Operación que desea ejecutar. Establezca el valor en ListDataSources.
ProjectId	Long	Sí	1	ID del espacio de trabajo de DataWorks al que pertenecen los orígenes de datos. Llame a la operación ListProjects para obtener este ID.
Name	String	No	test	Nombre del origen de datos que desea consultar.
DataSourceType	String	No	rds	Tipo del origen de datos. Valores válidos: odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo
SubType	String	No	mysql	Subtipo del origen de datos. Este parámetro solo surte efecto si el parámetro DataSourceType se establece en rds. Si el parámetro DataSourceType se establece en rds, este parámetro puede tomar los valores mysql, sqlserver o postgresql.
Status	String	No	ENABLED	Estado del origen de datos. Valores válidos: ENABLED DISABLED
EnvType	Integer	No	1	Entorno en el que se utiliza el origen de datos. Valores válidos: 0 y 1. El valor 0 indica el entorno de desarrollo. El valor 1 indica el entorno de producción.
PageSize	Integer	No	10	Número de entradas por página. Valor máximo: 100. Valor predeterminado: 10.
PageNumber	Integer	No	1	Número de página. El valor de este parámetro debe ser un número entero mayor o igual a 1.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
HttpStatusCode	Integer	200	Código de estado HTTP devuelto.
RequestId	String	0bc14115159376359****	ID de la solicitud.
Success	Boolean	true	Indica si la solicitud fue exitosa.
Data	Object		Resultado de la consulta devuelto.
PageNumber	Integer	1	Número de página.
PageSize	Integer	20	Número de entradas por página. Valor máximo: 100. Valor predeterminado: 10.
TotalCount	Integer	233	Número total de orígenes de datos.
DataSources	Array of DataSources		Orígenes de datos.
Status	Integer	1	Estado del origen de datos. Valores válidos: 1: el origen de datos es accesible. 2: el origen de datos no es accesible.
ProjectId	Integer	123	ID del espacio de trabajo al que pertenece el origen de datos.
SubType	String	mysql	Subtipo del origen de datos. Este parámetro solo surte efecto si el valor de DataSourceType es rds. Si el valor de DataSourceType es rds, el valor de este parámetro puede ser mysql, sqlserver o postgresql.
GmtModified	String	Mar 17, 2021 4:09:32 PM	Hora de la última modificación del origen de datos. Ejemplo: Mar 17, 2021 4:09:32 PM.
EnvType	Integer	1	Entorno en el que se utiliza el origen de datos. Valores válidos: 0: entorno de desarrollo 1: entorno de producción
ConnectStatus	Integer	1	Estado del origen de datos. Valores válidos: 1: el origen de datos es accesible. 2: el origen de datos no es accesible.
Sequence	Integer	300	Número de secuencia del origen de datos. Los orígenes de datos se ordenan de forma descendente según el valor de este parámetro.
Description	String	a connection	Descripción del origen de datos.
DataSourceType	String	rds	Tipo del origen de datos. Valores válidos: odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo
GmtCreate	String	Mar 17, 2021 4:09:32 PM	Hora de creación del origen de datos. Ejemplo: Mar 17, 2021 4:09:32 PM.
DefaultEngine	Boolean	false	Indica si la instancia del motor de cómputo asociada al origen de datos es el motor de cómputo predeterminado que usan los orígenes de datos del mismo tipo.
Shared	Boolean	false	Indica si el origen de datos es compartido.
Operator	String	193543050****	ID de la cuenta de Alibaba Cloud con la que se modificó por última vez el origen de datos.
Name	String	abc	Nombre del origen de datos.
Content	String	{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}	Cadena de conexión de datos. El valor de este parámetro está en formato JSON. Ejemplos de cadenas de conexión de orígenes de datos comunes: MaxCompute `json { "pubEndpoint": "http://service.cn.maxcompute.aliyun.com/api", "accessId": "xxxxxxx", "securityToken": null, "endpoint": "http://service.cn.maxcompute.aliyun-inc.com/api", "accessKey": "*", "name": "PRE_PROJECT_A_engine", "project": "PRE_PROJECT_A", "vpcEndpoint": "http://service.cn.maxcompute.aliyun-inc.com/api", "region": "cn-shanghai", "authType": "2" }` mysql `json { "configType": "1", "database": "mysql_d111b", "instanceName": "rm-xxxxxx", "password": "", "rdsOwnerId": "12133xxxxxx", "tag": "rds", "username": "mysql_db111" }` sqlserver `json { "configType": "1", "jdbcUrl": "jdbc:sqlserver://rm-xxxxx.sqlserver.rds.aliyuncs.com:1433;DatabaseName=sqlserver_db1", "password": "", "tag": "public", "username": "sqlserver_db111" }` oss `json { "accessId": "LTAINbR9Uxxxx", "accessKey": "", "bucket": "bigxxx1223", "configType": "1", "endpoint": "http://oss-cn-hangzhou.aliyuncs.com", "tag": "public" }` postgresql `json { "configType": "1", "database": "cdp_xxx", "instanceName": "rm-xxxx", "password": "", "rdsOwnerId": "121xxxxx", "tag": "rds", "username": "cdp_xxx" }` ads `json { "configType": "1", "password": "*", "schema": "ads_demo", "tag": "public", "url": "ads-xxx-xxxx.cn-hangzhou-1.ads.aliyuncs.com:3029", "username": "lslslsls" }`
Id	Long	1	ID del origen de datos.
BindingCalcEngineId	Long	123	ID de la instancia del motor de cómputo asociada al origen de datos.
TenantId	Long	1234567	ID del inquilino.

Ejemplos

Ejemplos de solicitudes

http(s)://[Endpoint]/?Action=ListDataSources
&Name=test
&ProjectId=1
&RegionId=cn-shanghai
&<Common request parameters>

Ejemplos de respuestas exitosas

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>0bc14115159376359****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>233</TotalCount>
    <PageSize>20</PageSize>
    <PageNumber>1</PageNumber>
    <DataSources>
        <Status>1</Status>
        <Operator>193543050****</Operator>
        <ConnectStatus>1</ConnectStatus>
        <SubType>mysql</SubType>
        <Description>a connection</Description>
        <BindingCalcEngineId>123</BindingCalcEngineId>
        <ProjectId>123</ProjectId>
        <GmtModified>Mar 17, 2021 4:09:32 PM</GmtModified>
        <Sequence>300</Sequence>
        <Shared>false</Shared>
        <EnvType>1</EnvType>
        <Name>abc</Name>
        <DefaultEngine>false</DefaultEngine>
        <TenantId>1234567</TenantId>
        <GmtCreate>Mar 17, 2021 4:09:32 PM</GmtCreate>
        <Content>{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}</Content>
        <DataSourceType>rds</DataSourceType>
        <Id>1</Id>
    </DataSources>
</Data>
<Success>true</Success>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0bc14115159376359****",
  "HttpStatusCode" : 200,
  "Data" : {
    "TotalCount" : 233,
    "PageSize" : 20,
    "PageNumber" : 1,
    "DataSources" : {
      "Status" : 1,
      "Operator" : "193543050****",
      "ConnectStatus" : 1,
      "SubType" : "mysql",
      "Description" : "a connection",
      "BindingCalcEngineId" : 123,
      "ProjectId" : 123,
      "GmtModified" : "Mar 17, 2021 4:09:32 PM",
      "Sequence" : 300,
      "Shared" : false,
      "EnvType" : 1,
      "Name" : "abc",
      "DefaultEngine" : false,
      "TenantId" : 1234567,
      "GmtCreate" : "Mar 17, 2021 4:09:32 PM",
      "Content" : "{\"pubEndpoint\":\"http://service.cn.maxcompute.aliyun.com/api\",\"accessId\":\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\",\"securityToken\":null,\"endpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"accessKey\":\"***\",\"name\":\"PRE_PROJECT_A_engine\",\"project\":\"PRE_PROJECT_A\",\"vpcEndpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"region\":\"cn-shanghai\",\"authType\":\"2\"}",
      "DataSourceType" : "rds",
      "Id" : 1
    }
  },
  "Success" : true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	Se devuelve este mensaje de error porque el origen de datos especificado no existe.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	Se devuelve este mensaje de error porque el espacio de trabajo especificado no existe.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	Se devuelve este mensaje de error porque el usuario no está agregado al espacio de trabajo.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	Se devuelve este mensaje de error porque el usuario no es propietario ni administrador del espacio de trabajo.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	Se devuelve este mensaje de error porque el usuario no pertenece al inquilino.

Para consultar la lista de códigos de error, consulte Códigos de error del servicio.