Todos os produtos
Search
Central de documentação

DataWorks:ListConnections

Última atualização: Oct 28, 2026

Consulta uma lista de fontes de dados.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

ProjectId

integer

Sim

O ID do workspace ao qual a fonte de dados pertence. Você pode chamar a operação ListProjects para obter o ID do workspace.

76086

Name

string

Não

O nome da fonte de dados a ser consultada.

abc

ConnectionType

string

Não

O tipo da string de conexão. Valores válidos:

  • odps

  • mysql

  • rds

  • oss

  • sqlserver

  • polardb

  • oracle

  • mongodb

  • emr

  • postgresql

  • analyticdb_for_mysql

  • hybriddb_for_postgresql

  • holo

rds

SubType

string

Não

O subtipo da string de conexão. Este parâmetro se aplica a cenários em que um tipo pai contém subtipos. As seguintes combinações são suportadas:

  • Tipo pai: rds

  • Subtipos: mysql, sqlserver ou postgresql.

mysql

Status

string

Não

O status da fonte de dados. Valores válidos:

  • ENABLED: Normal.

  • DISABLED: Desativado.

ENABLED

EnvType

integer

Não

O ambiente ao qual a fonte de dados pertence. Valores válidos:

  • 0: Ambiente de desenvolvimento.

  • 1: Ambiente de produção.

1

PageSize

integer

Não

O número de entradas a serem retornadas em cada página. Valor padrão: 10. Valor máximo: 100.

10

PageNumber

integer

Não

O número da página para a consulta paginada. Valores válidos: números inteiros maiores ou iguais a 1.

1

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

HttpStatusCode

integer

O código de status HTTP.

200

RequestId

string

O ID da solicitação.

0bc14115159376359****

Success

boolean

Indica se a solicitação foi bem-sucedida.

true

Data

object

Os resultados da consulta paginada das strings de conexão.

PageNumber

integer

O número da página.

1

PageSize

integer

O número de entradas a serem retornadas em cada página. Valor padrão: 10. Valor máximo: 100.

20

TotalCount

integer

O número total de fontes de dados.

3

Connections

array<object>

A lista de strings de conexão.

object

Status

integer

O status da fonte de dados. Valores válidos:

  • 1: Normal.

  • 2: Desativado.

1

ConnectionType

string

O 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

mysql

ProjectId

integer

O ID do workspace associado à fonte de dados.

123

SubType

string

O subtipo da fonte de dados. Este parâmetro se aplica a cenários em que um tipo pai contém subtipos. As seguintes combinações são suportadas:

  • Tipo pai: rds

  • Subtipos: mysql, sqlserver ou postgresql.

mysql

GmtModified

string

A hora em que a fonte de dados foi modificada. Exemplo: Mar 17, 2021 4:09:32 PM.

Mar 17, 2021 4:09:32 PM

EnvType

integer

O ambiente onde a fonte de dados reside. Valores válidos:

  • 0: Ambiente de desenvolvimento.

  • 1: Ambiente de produção.

1

ConnectStatus

integer

O status da fonte de dados. Valores válidos:

  • 1: Normal.

  • 2: Desativado.

1

Sequence

integer

O campo de ordenação. As fontes de dados são classificadas em ordem decrescente com base neste campo.

300

Description

string

A descrição da fonte de dados.

a connection

GmtCreate

string

A hora em que a fonte de dados foi criada. Exemplo: Mar 17, 2021 4:09:32 PM.

Mar 17, 2021 4:09:32 PM

DefaultEngine

boolean

Indica se o mecanismo associado à fonte de dados é o mecanismo padrão do mesmo tipo.

false

Shared

boolean

Indica se a fonte de dados é compartilhada.

false

Operator

string

O ID do usuário do Alibaba Cloud que modificou a fonte de dados pela última vez.

193543050****

Name

string

O nome da fonte de dados.

abc

Content

string

As informações detalhadas sobre a fonte de dados. Os exemplos a seguir mostram o conteúdo de fontes de dados comuns:

  • odps

{
  "accessId": "xssssss",
  "accessKey": "xsaxsaxsa",
  "authType": 2,
  "endpoint": "http://service.odps.aliyun.com/api",
  "project": "xsaxsax",
  "tag": "public"
}
  • mysql

{
  "database": "xsaxsa",
  "instanceName": "rm-xsaxsa",
  "password": "xsaxsa",
  "rdsOwnerId": "xasxsa",
  "regionId": "cn-shanghai",
  "tag": "rds",
  "username": "xsaxsa"
}
  • rds

{
  "configType": 1,
  "tag": "rds",
  "database": "xsaxsa",
  "username": "xsaxsa",
  "password": "xssaxsa$32050",
  "instanceName": "rm-xsaxs",
  "rdsOwnerId": "11111111"
}
  • oss

{
  "accessId": "sssssxx",
  "accessKey": "xsaxaxsaxs",
  "bucket": "xsa-xs-xs",
  "endpoint": "http://oss-cn-shanghai.aliyuncs.com",
  "tag": "public"
}
  • sqlserver

{
  "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",
  "password": "sdasda$fs",
  "tag": "public",
  "username": "sxaxacdacdd"
}
  • polardb

{
  "clusterId": "pc-sdadsadsa",
  "database": "dsadsadsa",
  "ownerId": "121212122",
  "password": "sdasdafssa",
  "region": "cn-shanghai",
  "tag": "polardb",
  "username": "asdadsads"
}
  • oracle

{
  "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",
  "password": "sxasaxsa",
  "tag": "public",
  "username": "sasfadfa"
}
  • mongodb

{
  "address": "[\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\"]",
  "database": "admin",
  "password": "sadsda@",
  "tag": "public",
  "username": "dsadsadas"
}
  • emr

{
  "accessId": "xsaxsa",
  "emrClusterId": "C-dsads",
  "emrResourceQueueName": "default",
  "emrEndpoint": "emr.aliyuncs.com",
  "accessKey": "dsadsad",
  "emrUserId": "224833315798889783",
  "name": "sasdsadsa",
  "emrAccessMode": "simple",
  "region": "cn-shanghai",
  "authType": "2",
  "emrProjectId": "FP-sdadsad"
}
  • postgresql

{
  "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",
  "password": "sdadsads",
  "tag": "public",
  "username": "sdsasda"
}
  • analyticdb_for_mysql

{
  "instanceId": "am-sadsada",
  "database": "xsxsx",
  "username": "xsxsa",
  "password": "asdadsa",
  "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"
}
  • hybriddb_for_postgresql

{
  "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",
  "database": "xsaxsaxas",
  "password": "xsaxsaxsa@11",
  "instanceId": "gp-xsaxsaxsa",
  "port": "541132",
  "ownerId": "xsaxsaxsas",
  "username": "sadsad"
}
  • holo

{
  "accessId": "xsaxsaxs",
  "accessKey": "xsaxsaxsa",
  "database": "xsaxsaxsa",
  "instanceId": "xsaxa",
  "tag": "aliyun"
}
  • kafka

{
  "instanceId": "xsax-cn-xsaxsa",
  "regionId": "cn-shanghai",
  "tag": "aliyun",
  "ownerId": "1212121212112"
}

{\"database\":\"xxx\",\"instanceName\":\"xxx\",\"password\":\"xxx\",\"rdsOwnerId\":\"xxx\",\"tag\":\"rds\",\"username\":\"xxx\"}

Id

integer

O ID da fonte de dados.

1

BindingCalcEngineId

integer

O ID do mecanismo de computação associado à fonte de dados.

123

TenantId

integer

O ID do tenant.

1234567

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "0bc14115159376359****",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 3,
    "Connections": [
      {
        "Status": 1,
        "ConnectionType": "mysql",
        "ProjectId": 123,
        "SubType": "mysql",
        "GmtModified": "Mar 17, 2021 4:09:32 PM",
        "EnvType": 1,
        "ConnectStatus": 1,
        "Sequence": 300,
        "Description": "a connection",
        "GmtCreate": "Mar 17, 2021 4:09:32 PM",
        "DefaultEngine": false,
        "Shared": false,
        "Operator": "193543050****",
        "Name": "abc",
        "Content": "{\\\"database\\\":\\\"xxx\\\",\\\"instanceName\\\":\\\"xxx\\\",\\\"password\\\":\\\"xxx\\\",\\\"rdsOwnerId\\\":\\\"xxx\\\",\\\"tag\\\":\\\"rds\\\",\\\"username\\\":\\\"xxx\\\"}",
        "Id": 1,
        "BindingCalcEngineId": 123,
        "TenantId": 1234567
      }
    ]
  }
}

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. A origem de dados não existe.
400 Invalid.Tenant.ProjectNotExists The project does not exist. O projeto não existe.
400 Invalid.Tenant.UserNotInProject The user is not in the project. O usuário não existe no projeto.
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. O usuário não é o proprietário nem o administrador do projeto.
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. O membro a ser adicionado não existe no locatário.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.