全部產品
Search

搜尋本產品

    ：GetDataSource - 查看資料來源詳情

    文件中心

    ：GetDataSource - 查看資料來源詳情

    更新時間：Mar 21, 2026

    根據資料來源ID，查詢指定的資料來源。

    介面說明

    1. 需要購買 DataWorks 基礎版及以上版本才能使用。

    2. 需要在 DataWorks 專案空間中具有如下至少一種角色：

    • 租戶所有者、空間管理員、部署、開發、專案所有者、營運

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dataworks:GetDataSource

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Id

    integer

    是

    資料來源 ID，資料來源的唯一識別碼。

    16035

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    RequestId

    string

    請求 ID。用於定位日誌，排查問題。

    9252F32F-D855-549E-8898-61CF5A733050
    DataSource

    object

    資料來源詳情。

    Id

    integer

    資料來源的 ID。

    16738
    ProjectId

    integer

    資料來源所屬的專案空間 ID。

    52660
    Name

    string

    資料來源的名稱。

    test
    Type

    string

    資料來源的類型。

    hologres
    ConnectionProperties

    any

    資料來源的具體串連配置資訊，包括串連地址、訪問身份、環境資訊等。資料來源環境 envType 資訊是此對象的成員屬性，包括

    • Dev（開發環境）

    • Prod（生產環境）

    不同類型的資料來源在不同的配置模式（ConnectionPropertiesMode）下具有不同的屬性資訊規範，請參考資料來源串連資訊 ConnectionProperties

    { "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
    ConnectionPropertiesMode

    string

    資料來源添加的類別，不同 type 下會有不同的子類型，對應有不同的參數約束，情境舉例：

    • InstanceMode 執行個體模式；

    • UrlMode 串連串模式；

    • CdhMode：CDH 模式。

    UrlMode
    Description

    string

    資料來源的描述資訊。

    test
    CreateTime

    integer

    資料來源的建立時間（時間戳記）。

    1698286929333
    CreateUser

    string

    資料來源的建立者 ID。

    1107550004253538
    ModifyTime

    integer

    資料來源的最近修改時間（時間戳記）。

    1698286929333
    ModifyUser

    string

    資料來源的修改者 ID。

    1107550004253538
    QualifiedName

    string

    資料來源的業務唯一鍵，以 holo 舉例格式是${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}。

    1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "DataSource": {
    "Id": 16738,
    "ProjectId": 52660,
    "Name": "test",
    "Type": "hologres",
    "ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n    \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n    \"database\": \"testdb\",\n    \"securityProtocol\": \"authTypeNone\",\n    \"authType\": \"Executor\",\n    \"authIdentity\": \"1107550004253538\"\n}",
    "ConnectionPropertiesMode": "UrlMode",
    "Description": "test",
    "CreateTime": 1698286929333,
    "CreateUser": "1107550004253538",
    "ModifyTime": 1698286929333,
    "ModifyUser": "1107550004253538",
    "QualifiedName": "1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb"
  }
}

    錯誤碼

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

    變更歷史

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