すべてのプロダクト
Search

このプロダクト

    DataWorks:GetDataSource

    ドキュメントセンター

    DataWorks:GetDataSource

    最終更新日:Sep 03, 2026

    データソース ID を指定してデータソースを照会します。

    操作説明

    1. この特徴を使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。

    2. DataWorks ワークスペースで、以下のいずれかのロールを持っている必要があります:

    • テナントオーナー、ワークスペース管理者、Deployment、開発者、プロジェクトオーナー、または O&M エンジニア

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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

    データソースの接続設定。エンドポイント、アクセス ID、環境コンテキストを含みます。データソース環境タイプ (envType) は、このオブジェクトのメンバープロパティです。有効な値:

    • Dev: 開発環境。

    • Prod: 本番環境。

    データソースのタイプによって、異なる構成モード (ConnectionPropertiesMode) で異なるプロパティ仕様があります。詳細については、「データソース接続プロパティ (ConnectionProperties)」を参照してください。

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

    string

    データソースが追加されるカテゴリ。タイプごとにサブタイプが異なり、パラメーターの制約も異なります。例:

    • InstanceMode: インスタンスモード。

    • UrlMode: 接続文字列モード。

    • CdhMode: CDH モード。

    UrlMode
    Description

    string

    データソースの説明。

    test
    CreateTime

    integer

    データソースが作成された時間 (タイムスタンプ)。

    1698286929333
    CreateUser

    string

    データソースを作成したユーザーの ID。

    1107550004253538
    ModifyTime

    integer

    データソースが最後に変更済みの時間 (タイムスタンプ)。

    1698286929333
    ModifyUser

    string

    データソースを最後に変更済みのユーザーの ID。

    1107550004253538
    QualifiedName

    string

    データソースのビジネス一意キー。たとえば、Hologres データソースのフォーマットは ${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database} です。

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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。