全部產品
Search

搜尋本產品

    Quick BI：GetDataSourceConnectionInfo - 擷取資料來源資訊

    文件中心

    Quick BI：GetDataSourceConnectionInfo - 擷取資料來源資訊

    更新時間：Dec 24, 2025

    擷取資料來源資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    quickbi-public:GetDataSourceConnectionInfo

    get

    *全部資源

    *

    		 無 無

    請求文法

    POST  HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DsId

    string

    是

    資料來源 ID。

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

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

    object

    資料來源資訊。

    Address

    string

    資料庫連接串地址（網域名稱或 ip）。

    172.**.**.48
    AuthLevel

    string

    權限等級：

    • 0 -- 私人

    • 1 -- 協同編輯(舊)

    • 11 -- 協同編輯——空間成員

    • 12 -- 協同編輯——指定到人

    0
    CreatorId

    string

    建立人的 Quick BI 使用者識別碼。

    U240****0880C6095
    DsId

    string

    資料來源 ID。

    a201c85c-******
    DsType

    string

    資料來源類型。

    枚舉值：

    • hive :

      Hive 資料來源

    • vertica :

      Vertica 資料來源

    • ppas :

      RDS PPAS 資料來源

    • dm :

      DM7 資料來源-達夢

    • tsdb :

      TSDB 資料來源

    • tdsql :

      TDSQL-H 資料來源

    • mysql_hybrid :

      HybridDB for MySQL 資料來源

    • sqlserver :

      sqlserver 資料來源

    • postgresql :

      postgresql 資料來源

    • garuda :

      garuda 資料來源

    • adb_spark :

      adb 資料來源 Spark 引擎

    • greenplum :

      greenplum 資料來源

    • phoenix_thin :

      PHOENIX THIN 資料來源

    • dla :

      DataLake Analytics 資料來源

    • starrocks :

      StarRocks 資料來源

    • mysql :

      mysql 資料來源

    • hana :

      SAP HANA 資料來源

    • mongodb :

      MongoDB 資料來源

    • adb :

      ADB

    • hbase :

      HBASE 資料來源

    • oscar :

      神通資料來源

    • gbase :

      Gbase 資料來源

    • oracle :

      oracle 資料來源

    • sybase :

      SAP SYBASE IQ 資料來源

    • dataphin :

      DataPhin 資料來源-多引擎

    • odps :

      odps 資料來源

    • db2 :

      IBM DB2 資料來源(LUW)

    • yida :

      宜搭應用資料來源

    • clickhouse :

      ClickHouse 資料來源

    • oceanbase_oracle :

      OceanBase_Oracle 模式資料來源

    • presto :

      presto 資料來源

    • polardb :

      polardb 資料來源

    • dataphin_odps :

      DataPhin 資料來源 odps 引擎

    • selectdb :

      SelectDB 資料來源

    mysql
    DsVersion

    string

    資料來源的版本。

    5.7
    Instance

    string

    資料庫執行個體，對應資料庫名稱，ODPS 為 project。

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

    string

    執行個體 ID。

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

    string

    修改人的 Quick BI 使用者識別碼。

    U240****0880C6095
    NoSasl

    boolean

    impala 資料來源是否需要身分識別驗證即可登入：

    • true-需要賬戶密碼登入

    • false-不需要驗證(預設)

    true
    ParentDsType

    string

    多引擎資料來源的主要資料源類型。

    dataphin
    Port

    string

    連接埠。

    3306
    Project

    string

    擷取串連串詳情時，odps 供前端展示使用。

    prod-ossdoc
    Schema

    string

    資料庫 schema，僅對支援 schema 的資料庫需要設定。

    Analysis
    ShowName

    string

    資料來源前端展示名稱。

    0327
    WorkspaceId

    string

    資料來源所屬工作空間 ID。

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

    boolean

    是否成功。

    true

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    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.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。