All Products
Search

This Product

    Quick BI:GetDataSourceConnectionInfo

    Document Center

    Quick BI:GetDataSourceConnectionInfo

    Last Updated:Jun 11, 2026

    Mengambil informasi koneksi sumber data.

    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

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    quickbi-public:GetDataSourceConnectionInfo

    get

    *All Resource

    *

    		 None None

    Sintaks permintaan

    POST  HTTP/1.1

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DsId

    string

    Yes

    ID sumber data.

    7AAB95D-*****-****-*4FC0C976

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    Request ID.

    7AAB95D-*****-****-*4FC0C976
    Result

    object

    Data source information.

    Address

    string

    Database connection string address (domain or IP).

    172.**.**.48
    AuthLevel

    string

    Permission level:

    • 0 -- Private

    • 1 -- Collaborative Editing (old)

    • 11 -- Collaborative Editing - Space Members

    • 12 -- Collaborative Editing - Specified to Individuals

    0
    CreatorId

    string

    Quick BI user ID of the creator.

    U240****0880C6095
    DsId

    string

    Data source ID.

    a201c85c-******
    DsType

    string

    Data source type.

    Valid values:

    • hive :

      Hive Data Source

    • vertica :

      Vertica Data Source

    • ppas :

      RDS PPAS Data Source

    • dm :

      DM7 Data Source-Dameng

    • tsdb :

      TSDB Data Source

    • tdsql :

      TDSQL-H Data Source

    • mysql_hybrid :

      HybridDB for MySQL Data Source

    • sqlserver :

      sqlserver Data Source

    • postgresql :

      postgresql Data Source

    • garuda :

      garuda Data Source

    • adb_spark :

      adb Data Source Spark Engine

    • greenplum :

      greenplum Data Source

    • phoenix_thin :

      PHOENIX THIN Data Source

    • dla :

      DataLake Analytics Data Source

    • starrocks :

      StarRocks Data Source

    • mysql :

      mysql Data Source

    • hana :

      SAP HANA Data Source

    • mongodb :

      MongoDB Data Source

    • adb :

      ADB

    • hbase :

      HBASE Data Source

    • oscar :

      Sheng Tong Data Source

    • gbase :

      Gbase Data Source

    • oracle :

      oracle Data Source

    • sybase :

      SAP SYBASE IQ Data Source

    • dataphin :

      DataPhin Data Source-Multi-engine

    • odps :

      odps Data Source

    • db2 :

      IBM DB2 Data Source(LUW)

    • yida :

      yida Application Data Source

    • clickhouse :

      ClickHouse Data Source

    • oceanbase_oracle :

      OceanBase_Oracle Data Source

    • presto :

      presto Data Source

    • polardb :

      polardb Data Source

    • dataphin_odps :

      DataPhin Data Source odps Engine

    • selectdb :

      SelectDB Data Source

    mysql
    DsVersion

    string

    Version of the data source.

    5.7
    Instance

    string

    Database instance, corresponding to the database name, and for ODPS, it is the project.

    rm*********t44ju1
    InstanceId

    string

    Instance ID.

    rm*********t44ju1
    ModifyUser

    string

    Quick BI user ID of the modifier.

    U240****0880C6095
    NoSasl

    boolean

    Whether the impala data source requires authentication to log in:

    • true - Requires account and password login

    • false - No authentication required (default)

    true
    ParentDsType

    string

    Primary data source type for multi-engine data sources.

    dataphin
    Port

    string

    Port.

    3306
    Project

    string

    Used for front-end display when obtaining connection details for ODPS.

    prod-ossdoc
    Schema

    string

    Database schema, only needs to be set for databases that support schemas.

    Analysis
    ShowName

    string

    Display name of the data source on the front end.

    0327
    WorkspaceId

    string

    Workspace ID to which the data source belongs.

    0de6**2-d**-4720-8836-0cc****1394c
    Success

    boolean

    Indicates whether the operation was successful.

    true

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "7AAB95D-*****-****-*4FC0C976",
  "Result": {
    "Address": "172.**.**.48",
    "AuthLevel": "0",
    "CreatorId": "U240****0880C6095",
    "DsId": "a201c85c-******",
    "DsType": "mysql",
    "DsVersion": "5.7",
    "Instance": "rm*********t44ju1",
    "InstanceId": "rm*********t44ju1",
    "ModifyUser": "U240****0880C6095",
    "NoSasl": true,
    "ParentDsType": "dataphin",
    "Port": "3306",
    "Project": "prod-ossdoc",
    "Schema": "Analysis",
    "ShowName": "0327",
    "WorkspaceId": "0de6**2-d**-4720-8836-0cc****1394c"
  },
  "Success": true
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 Invalid.Parameter The length of the parameter must not exceed 1000.
    400 Access.Forbidden Your instance version or access key is not allowed to call the API operation, only professional version supports calling.
    400 Internal.System.Error An internal system error occurred.
    400 Instance.Expired Your instance has expired.
    400 Instance.Not.Exist The specified instance does not exist.
    400 Invalid.Organization The specified organizational unit does not exist.
    400 User.Not.In.Organization The specified user is not in the organizational unit.
    400 Invalid.Param.Error The parameter is invalid.
    400 Invalid.Parameter.Error The parameter is invalid:%s.
    400 Datasource.NotFound.Error The specified data source does not exist: %s.
    400 Application.Object.NotExist The object you are operating does not exist or has been deleted.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.