Todos os produtos
Search

Este produto

    DataWorks:CreateConnection

    Central de documentação

    DataWorks:CreateConnection

    Última atualização: Oct 27, 2026

    Cria uma fonte de dados.

    Nota

    Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2020-05-18) - CreateDataSource para funcionalidade aprimorada e suporte contínuo. Embora a API descontinuada permaneça temporariamente acessível, nenhuma atualização ou correção de bugs será fornecida.

    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 espaço de trabalho associado à fonte de dados. Você pode obter o ID do espaço de trabalho chamando a operação ListProjects.

    1
    Name

    string

    Sim

    O nome da fonte de dados.

    abc
    Description

    string

    Não

    A descrição da string de conexão.

    abc
    ConnectionType

    string

    Sim

    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 é usado quando um tipo pai possui subtipos. Combinações válidas:

    • Tipo pai: rds

    • Subtipos: mysql, sqlserver ou postgresql.

    mysql
    EnvType

    integer

    Sim

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

    • 0: ambiente de desenvolvimento.

    • 1: ambiente de produção.

    1
    Content

    string

    Sim

    As informações detalhadas da fonte de dados. Exemplos 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":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"}

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    HttpStatusCode

    string

    O código de status HTTP.

    200
    Data

    integer

    O ID da fonte de dados.

    123
    RequestId

    string

    O ID da solicitação.

    0bc141151593763****
    Success

    boolean

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

    true

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "HttpStatusCode": "200",
  "Data": 123,
  "RequestId": "0bc141151593763****",
  "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. 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.
    400 ConnectionAlreadyExist The connection with envType %s and name %s already exists. O nome da string de conexão já existe.
    400 DataSource.CheckRamRoleFailure Failed to check the RAM role. AccountId %s. roleArn %s. Falha ao verificar as permissões da fonte de dados.
    400 DataSource.ConnectionStrProperty.PatternNotMatch The pattern value %s is invalid. The correct pattern is %s. As propriedades da string de conexão da fonte de dados não correspondem às regras.
    400 Invalid.DataSource.DataSourceTypeNotSupport The dataSourceType %s and subType %s are not supported. O tipo de fonte de dados não é suportado.
    400 Invalid.Param.Odps.EngineIdOrConnectStrEmpty Either the compute engine ID or the connection string must be specified when data source type is ODPS.
    400 MissingParam.ConnectionStr.Property You must specify property %s required by the data source connection string. Uma propriedade obrigatória está ausente na string de conexão da origem de dados.
    400 Invalid.DataSource.DataSourceTypeNotExist The data source type %s does not exist. O tipo de fonte de dados não existe.
    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.