データリネージ用の ListLineages API 概要 - DataWorks - Alibaba Cloud - DataWorks

データマップ内の指定されたエンティティの上流および下流のエンティティを照会します。オプションで、詳細なリネージ関係情報を含めることができます。

操作説明

この API を使用するには、DataWorks Standard Edition 以降のエディションを購入する必要があります。
この API を使用して、特定のエンティティの上流および下流のエンティティとそのリネージ関係を照会できます。

今すぐお試しください

この 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:ListLineages

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SrcEntityId	string	任意	ソースエンティティの ID。これは、`ListTables` API または `ListColumns` API から返されるテーブル ID または列 ID、あるいはカスタムエンティティの ID です。	maxcompute-table:::project_name:[schema_name]:table_name
DstEntityId	string	任意	宛先エンティティの ID。これは、`ListTables` API または `ListColumns` API から返されるテーブル ID または列 ID、あるいはカスタムエンティティの ID です。	dlf-table::catalog_id:database_name::table_name
SrcEntityName	string	任意	ソースエンティティの名前。このパラメータはファジーマッチングに対応しています。	srcName1
DstEntityName	string	任意	宛先エンティティの名前。このパラメータはファジーマッチングに対応しています。	dstName1
NeedAttachRelationship	boolean	任意	リネージ関係を含めるかどうかを指定します。デフォルト： false。	false
SortBy	string	任意	結果をソートするフィールド。デフォルトは `Name` で、エンティティ名でソートされます。	Name
Order	string	任意	ソート順。デフォルト： `Asc`。有効な値： `Asc`：昇順 `Desc`：降順	Asc
PageNumber	integer	任意	取得するページ番号。デフォルト： 1。	1
PageSize	integer	任意	ページあたりのエントリ数。デフォルト： 10。最大： 100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	0000-ABCD-EFG****
Success	boolean	リクエストが成功したかどうかを示します。	true
PagingInfo	object	ページネーションの詳細。
TotalCount	integer	エントリの総数。	12
PageNumber	integer	返されるデータのページ番号。	1
PageSize	integer	現在のページで返されるエントリ数。	10
Lineages	array<object>	リネージ情報のリスト。
	object	リネージエントリ。
SrcEntity	LineageEntity	ソースエンティティ。
DstEntity	LineageEntity	宛先エンティティ。
Relationships	array	リネージ関係のリスト。
	LineageRelationship	リネージ関係。

例

成功レスポンス

JSONJSON

{
  "RequestId": "0000-ABCD-EFG****",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 12,
    "PageNumber": 1,
    "PageSize": 10,
    "Lineages": [
      {
        "SrcEntity": {
          "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "DstEntity": {
          "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "Relationships": [
          {
            "SrcEntity": {
              "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
              "Name": "test_tbl",
              "Attributes": {
                "key": "key1:value1"
              }
            },
            "Task": {
              "Id": "12345",
              "Type": "custom-sql",
              "Attributes": {
                "key": "key1:value21"
              }
            },
            "Id": "maxcompute-table.p.table:custom-table.xxx:custom-sql.123",
            "CreateTime": 1743040581000
          }
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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