All Products
Search

This Product

    DataWorks:CreateConnection

    Document Center

    DataWorks:CreateConnection

    Last Updated:Jun 11, 2026

    Menambahkan sumber data.

    Catatan

    API ini telah ditinggalkan. Kami merekomendasikan migrasi ke dataworks-public(2020-05-18) - CreateDataSource guna memperoleh fungsionalitas yang lebih baik dan dukungan berkelanjutan. Meskipun API yang telah ditinggalkan ini masih dapat diakses sementara, tidak akan ada pembaruan atau perbaikan bug lebih lanjut.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ProjectId

    integer

    Yes

    ID workspace tempat sumber data dikaitkan. Anda dapat memanggil operasi ListProjects untuk menanyakan ID.

    1
    Name

    string

    Yes

    Nama sumber data.

    abc
    Description

    string

    No

    Deskripsi string koneksi.

    abc
    ConnectionType

    string

    Yes

    Jenis string koneksi. Nilai yang valid:

    • odps

    • mysql

    • rds

    • oss

    • sqlserver

    • polardb

    • oracle

    • mongodb

    • emr

    • postgresql

    • analyticdb_for_mysql

    • hybriddb_for_postgresql

    • holo

    rds
    SubType

    string

    No

    Subtipe string koneksi. Parameter ini digunakan untuk skenario di mana suatu jenis mencakup subtipe. Jenis dan subtipe berikut didukung:

    • Jenis: rds

    • Subtipe: mysql, sqlserver, dan postgresql.

    mysql
    EnvType

    integer

    Yes

    Lingkungan tempat sumber data digunakan. Nilai yang valid: 0 dan 1. Nilai 0 menunjukkan lingkungan pengembangan. Nilai 1 menunjukkan lingkungan produksi.

    1
    Content

    string

    Yes

    Detail sumber data. Contoh detail dari beberapa sumber data umum:

    • 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"}

    Elemen respons

    Element

    Type

    Description

    Example

    object

    HttpStatusCode

    string

    Kode status HTTP.

    200
    Data

    integer

    ID sumber data.

    123
    RequestId

    string

    ID permintaan.

    0bc141151593763****
    Success

    boolean

    Menunjukkan apakah permintaan berhasil.

    true

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 Invalid.Tenant.ConnectionNotExists The connection does not exist. The connection does not exist.
    400 Invalid.Tenant.ProjectNotExists The project does not exist. The project does not exist.
    400 Invalid.Tenant.UserNotInProject The user is not in the project. The user is not in the project.
    400 ConnectionAlreadyExist The connection with envType %s and name %s already exists. ConnectionAlreadyExist
    400 DataSource.CheckRamRoleFailure Failed to check the RAM role. AccountId %s. roleArn %s.
    400 DataSource.ConnectionStrProperty.PatternNotMatch The pattern value %s is invalid. The correct pattern is %s.
    400 Invalid.DataSource.DataSourceTypeNotSupport The dataSourceType %s and subType %s are not supported. DataSource type not support yet.
    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. The data source connection str required property missing.
    400 Invalid.DataSource.DataSourceTypeNotExist The data source type %s does not exist. The dataSource type %s are not exist.
    403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. The user is not a project administrator or owner.
    403 Invalid.Tenant.UserNotInTenant The user is not in tenant. The user is not in tenant.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.