すべてのプロダクト
Search

このプロダクト

    DataWorks:ListSchemas

    ドキュメントセンター

    DataWorks:ListSchemas

    最終更新日:Mar 21, 2026

    Data Map で指定されたデータベースまたは MaxCompute プロジェクト配下のスキーマ一覧をクエリします。現在、MaxCompute および Hologres 型に対応しています。

    操作説明

    1. 本機能を利用するには、DataWorks Basic Edition 以上をご購入いただく必要があります。

    今すぐお試しください

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

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ParentMetaEntityId

    string

    必須

    親エンティティ ID です。詳細については、「メタデータエンティティに関する概念」をご参照ください。Hologres のメタデータクローラー型の場合、ListDatabases 操作を呼び出して、ParentMetaEntityId パラメーターの設定を照会できます。

    ParentMetaEntityId パラメーターは、${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name} の形式で設定します。該当するレベルが存在しない場合は、そのレベルを空欄のままにしてください。

    説明

    MaxCompute スキーマの情報をクエリする場合、Instance ID レベルにはプレースホルダーとして空文字列を指定し、Database name レベルには MaxCompute プロジェクト名を指定してください。また、対象の MaxCompute プロジェクトでスキーマ機能が有効化されていることを確認してください。

    maxcompute-project:123456XXX::test_project holo-database:h-abc123xxx::test_db
    Name

    string

    任意

    名前です。あいまい検索がサポートされています。

    abc
    Comment

    string

    任意

    コメントです。前方一致検索（ファジィマッチ）が可能です。

    test comment
    Types

    array

    任意

    スキーマタイプです。完全一致検索のみサポートされます。このパラメーターを空欄のままにした場合、すべてのタイプがクエリされます。

    string

    任意

    スキーマタイプです。

    MANAGED
    SortBy

    string

    任意

    ソート対象のフィールドです。デフォルト値は CreateTime です。有効な値は以下のとおりです。

    • CreateTime

    • ModifyTime

    • Name

    • Type

    CreateTime
    Order

    string

    任意

    ソート順です。デフォルト値は Asc です。有効な値は以下のとおりです。

    • Asc：昇順

    • Desc：降順

    Asc
    PageNumber

    integer

    任意

    ページ番号です。デフォルト値は 1 です。

    1
    PageSize

    integer

    任意

    1 ページあたりの表示件数です。デフォルト値は 10、最大値は 100 です。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーターです。

    RequestId

    string

    リクエスト ID です。

    235BBA5E-3428-XXXXXX
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    PagingInfo

    object

    ページネーション情報です。

    TotalCount

    integer

    合計件数です。

    1
    PageNumber

    integer

    ページ番号です。

    1
    PageSize

    integer

    1 ページあたりの表示件数です。

    10
    Schemas

    array

    スキーマです。

    Schema

    スキーマです。

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "235BBA5E-3428-XXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Schemas": [
      {
        "Id": "maxcompute-schema:123456XXX::test_project:default\nholo-schema:h-abc123xxx::test_db:test_schema",
        "Name": "test_db",
        "Comment": "test comment",
        "Type": "MANAGED",
        "ParentMetaEntityId": "maxcompute-project:123456XXX::test_project\nholo-database:h-abc123xxx::test_db",
        "CreateTime": 1736852168000,
        "ModifyTime": 1736852168000
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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