すべてのプロダクト
Search

このプロダクト

    :QueryDatasetList

    ドキュメントセンター

    :QueryDatasetList

    最終更新日:Nov 14, 2025

    指定されたワークスペース内のデータセットを照会します。結果は作成時間の降順でソートされます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    quickbi-public:QueryDatasetList

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    WorkspaceId

    string

    必須

    ワークスペース ID。

    95296e95-ca89-4c7d-8af9-dedf0ad0****
    DirectoryId

    string

    任意

    フォルダの ID。

    • このパラメーターを指定すると、フォルダ内のすべてのデータセットが返されます。

    schemaad8aad00-9c55-4984-a767-b4e0ec60****
    WithChildren

    boolean

    任意

    サブディレクトリ内のデータセットを再帰的に含めるかどうかを指定します。有効な値:

    • true: DirectoryId で指定されたフォルダとそのサブディレクトリ内のすべてのデータセットを返します。

    • false: DirectoryId で指定されたフォルダ内のデータセットのみを返します。

    true
    Keyword

    string

    任意

    名前でデータセットを検索するために使用されるキーワード。

    test
    PageNum

    integer

    任意

    データセットリストのページ番号。

    • 開始値: 1

    • デフォルト値: 1

    1
    PageSize

    integer

    任意

    各ページで返されるエントリ数。

    • デフォルト値: 10

    • 最大値: 1000

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値:

    • true: リクエストは成功しました。

    • false: リクエストは失敗しました。

    true
    RequestId

    string

    リクエスト ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    object

    データセットリストのページ分割された結果。データセットの詳細は Data パラメーターで返されます。

    Data

    array<object>

    データセットリストの詳細。

    array<object>

    CreateTime

    string

    データセットが作成された時間。

    2020-11-02 10:36:05
    DataSource

    object

    データセットが属するデータソースに関する情報。

    DsId

    string

    データソース ID。

    261b252d-c3c3-498a-a0a7-5d1ec6cd****
    DsName

    string

    データソース名。

    test
    DsType

    string

    データソースタイプ。

    mysql
    DatasetId

    string

    データセット ID。

    5820f58c-c734-4d8a-baf1-7979af4f****
    DatasetName

    string

    データセット名。

    company_sales_record_copy12
    Description

    string

    データセットの説明。

    test
    Directory

    object

    データセットが配置されているフォルダに関する情報。

    Id

    string

    フォルダ ID。

    schemaad8aad00-9c55-4984-a767-b4e0ec60****
    Name

    string

    フォルダ名。

    test
    PathId

    string

    フォルダパスの ID。

    schemaad8aad00-9c55-4984-a767-b4e0ec60****
    PathName

    string

    フォルダパスの名前。

    test
    ModifyTime

    string

    データセットが最後に変更された時間。

    2020-11-02 10:36:05
    OpenOfflineAcceleration

    boolean

    抽出ベースのアクセラレーションが有効かどうかを示します。有効な値:

    • true: 有効

    • false: 無効

    true
    OwnerId

    string

    Quick BI のデータセットオーナーのユーザー ID。

    136516262323****
    OwnerName

    string

    データセットオーナーのニックネーム。

    test
    RowLevel

    boolean

    行レベルの権限が有効かどうかを示します。有効な値:

    • true: 有効

    • false: 無効

    true
    WorkspaceId

    string

    ワークスペース ID。

    95296e95-ca89-4c7d-8af9-dedf0ad06adf
    WorkspaceName

    string

    ワークスペース名。

    test
    PageNum

    integer

    ページ番号。

    1
    PageSize

    integer

    リクエストで指定されたページあたりのエントリ数。

    10
    TotalNum

    integer

    エントリの総数。

    1
    TotalPages

    integer

    総ページ数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "CreateTime": "2020-11-02 10:36:05",
        "DataSource": {
          "DsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****",
          "DsName": "test",
          "DsType": "mysql"
        },
        "DatasetId": "5820f58c-c734-4d8a-baf1-7979af4f****",
        "DatasetName": "company_sales_record_copy12",
        "Description": "test",
        "Directory": {
          "Id": "schemaad8aad00-9c55-4984-a767-b4e0ec60****",
          "Name": "test",
          "PathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60****",
          "PathName": "test"
        },
        "ModifyTime": "2020-11-02 10:36:05",
        "OpenOfflineAcceleration": true,
        "OwnerId": "136516262323****",
        "OwnerName": "test",
        "RowLevel": true,
        "WorkspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad06adf",
        "WorkspaceName": "test"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Workspace.NotIn.Organization The workspace is not owned by the organization. 指定されたワークスペースは組織単位内にありません。
    400 CubeSchema.Not.Exist The cube schema does not exist.

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

    変更履歴

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