ListDataSources - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListDataSources	Operação a ser executada. Defina o valor como ListDataSources.
ProjectId	Long	Sim	1	ID do workspace do DataWorks ao qual as fontes de dados pertencem. Chame a operação ListProjects para obter esse ID.
Name	String	Não	test	Nome da fonte de dados a ser consultada.
DataSourceType	String	Não	rds	Tipo da fonte de dados. Valores válidos: odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo
SubType	String	Não	mysql	Subtipo da fonte de dados. Este parâmetro só tem efeito se DataSourceType estiver definido como rds. Se DataSourceType for rds, este parâmetro poderá ser definido como mysql, sqlserver ou postgresql.
Status	String	Não	ENABLED	Status da fonte de dados. Valores válidos: ENABLED DISABLED
EnvType	Integer	Não	1	Ambiente de uso da fonte de dados. Valores válidos: 0 e 1. O valor 0 indica o ambiente de desenvolvimento; o valor 1 indica o ambiente de produção.
PageSize	Integer	Não	10	Número de entradas por página. Valor máximo: 100. Valor padrão: 10.
PageNumber	Integer	Não	1	Número da página. O valor deve ser um número inteiro maior ou igual a 1.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	Código de status HTTP retornado.
RequestId	String	0bc14115159376359****	ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
Data	Object		Resultado da consulta retornado.
PageNumber	Integer	1	Número da página.
PageSize	Integer	20	Número de entradas por página. Valor máximo: 100. Valor padrão: 10.
TotalCount	Integer	233	Número total de fontes de dados.
DataSources	Array of DataSources		Fontes de dados.
Status	Integer	1	Status da fonte de dados. Valores válidos: 1: A fonte de dados está acessível. 2: A fonte de dados está inacessível.
ProjectId	Integer	123	ID do workspace ao qual a fonte de dados pertence.
SubType	String	mysql	Subtipo da fonte de dados. Este parâmetro só tem efeito se o valor de DataSourceType for rds. Se o valor de DataSourceType for rds, o valor deste parâmetro poderá ser mysql, sqlserver ou postgresql.
GmtModified	String	Mar 17, 2021 4:09:32 PM	Hora da última modificação da fonte de dados. Exemplo: Mar 17, 2021 4:09:32 PM.
EnvType	Integer	1	Ambiente de uso da fonte de dados. Valores válidos: 0: ambiente de desenvolvimento 1: ambiente de produção
ConnectStatus	Integer	1	Status da fonte de dados. Valores válidos: 1: A fonte de dados está acessível. 2: A fonte de dados está inacessível.
Sequence	Integer	300	Número de sequência da fonte de dados. As fontes de dados são classificadas em ordem decrescente com base neste valor.
Description	String	a connection	Descrição da fonte de dados.
DataSourceType	String	rds	Tipo da fonte de dados. 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 criação da fonte de dados. Exemplo: Mar 17, 2021 4:09:32 PM.
DefaultEngine	Boolean	false	Indica se a instância do mecanismo de computação associada à fonte de dados é o mecanismo padrão usado por fontes de dados do mesmo tipo.
Shared	Boolean	false	Indica se a fonte de dados é compartilhada.
Operator	String	193543050****	ID da conta Alibaba Cloud que modificou a fonte de dados pela última vez.
Name	String	abc	Nome da fonte de dados.
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"}	String de conexão de dados. O valor deste parâmetro está no formato JSON. Exemplos de strings de conexão para fontes de dados comuns: 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 da fonte de dados.
BindingCalcEngineId	Long	123	ID da instância do mecanismo de computação associada à fonte de dados.
TenantId	Long	1234567	ID do locatário.

Exemplos

Solicitações de exemplo

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

Respostas de sucesso de exemplo

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	Erro retornado porque a fonte de dados especificada não existe.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	Erro retornado porque o workspace especificado não existe.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	Erro retornado porque o usuário não foi adicionado ao workspace.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	Erro retornado porque o usuário não é proprietário nem administrador do workspace.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	Erro retornado porque o usuário não pertence ao locatário.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.