すべてのプロダクト
Search

このプロダクト

    :QueryWorksByWorkspace

    ドキュメントセンター

    :QueryWorksByWorkspace

    最終更新日:Dec 24, 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:QueryWorksByWorkspace

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    WorkspaceId

    string

    必須

    ワークスペースの ID。

    89713491-cb4f-4579-b889-e82c35f1****
    WorksType

    string

    任意

    作業のタイプ。有効な値：

    • DATAPRODUCT：BI ポータル

    • PAGE：ダッシュボード

    • FULLPAGE：フルスクリーンダッシュボード

    • REPORT：ワークブック

    PAGE
    Status

    integer

    任意

    作業のステータス。有効な値：

    • 0：未公開

    • 1：公開済み

    • 2：変更済み、未公開

    • 3：未公開

    0
    ThirdPartAuthFlag

    integer

    任意

    サードパーティの埋め込みステータス。有効な値：

    • 0：埋め込みサービスが無効です。

    • 1：埋め込みが有効です。

    0
    PageNum

    integer

    任意

    返されるページのページ番号。

    • デフォルト値：1。

    1
    PageSize

    integer

    任意

    1ページあたりに返されるエントリ数。

    • デフォルト値：10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Success

    boolean

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

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

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

    true
    RequestId

    string

    リクエストの ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    object

    リクエストされた条件を満たす組織ワークスペース内のすべての作業のリストを返します。

    Data

    array<object>

    作業リストの詳細。

    array<object>

    Auth3rdFlag

    integer

    サードパーティの埋め込みステータス。有効な値：

    • 0：埋め込みサービスが無効です。

    • 1：埋め込みが有効です。

    1
    Description

    string

    作業に関する備考。

    备注
    Directory

    object

    作業が所属するディレクトリ。

    Id

    string

    ディレクトリの ID。

    83d37ba6-d909-48a2-a517-f4d05c3a****
    Name

    string

    ディレクトリの名前。

    所属目录名称。
    PathId

    string

    ディレクトリが所属するディレクトリ ID の階層構造。階層構造は / で区切ります。

    83d37ba6-d909-48a2-a517-f4d05c3a****
    PathName

    string

    ディレクトリが所属するディレクトリの階層構造。階層構造は (/) で区切ります。

    测试目录
    GmtCreate

    string

    作業が作成されたときのタイムスタンプ (ミリ秒単位)。

    1496651577000
    GmtModify

    string

    作業が変更されたときのタイムスタンプ (ミリ秒単位)。

    1572334870000
    ModifyName

    string

    作業変更者のニックネーム。

    张三
    OwnerId

    string

    Quick BI における作業オーナーのユーザー ID。

    作品所属工作空间名称。
    OwnerName

    string

    作業オーナーのニックネーム。

    李四
    PublicFlag

    boolean

    公開されているかどうか。

    true
    PublicInvalidTime

    integer

    レポートの公開期限。

    1721366354000
    SecurityLevel

    string

    作業の共同権限付与に関するセキュリティポリシー。有効な値：

    • 0：非公開

    • 12：指定されたメンバーに権限を付与

    • 1 または 11：すべてのワークスペースメンバーに権限を付与

    説明

    • 従来の権限を使用する場合、戻り値は 1 です。

    • 新しい権限を使用する場合、戻り値は 11 です。

    0
    Status

    integer

    ダッシュボード、フルスクリーンダッシュボード、スプレッドシートのステータス。他の作業タイプのデフォルト値は 1 です。有効な値：

    • 0：未公開

    • 1：公開済み

    • 2：変更済み、未公開

    • 3：未公開

    1
    WorkName

    string

    作業の名前。

    测试报表
    WorkType

    string

    作業のタイプ。有効な値：

    • DATAPRODUCT：BI ポータル

    • PAGE：ダッシュボード

    • FULLPAGE：フルスクリーンダッシュボード

    • REPORT：ワークブック

    • dashboardOfflineQuery：セルフサービスデータ取得

    • Analysis：アドホック分析

    • DATAFORM：フォーム入力

    PAGE
    WorksId

    string

    作業の ID。

    897ce25e-f993-4abd-af84-d13c5610****
    WorkspaceId

    string

    作業が所属するワークスペースの ID。

    87c6b145-090c-43e1-9426-8f93be23****
    WorkspaceName

    string

    作業が所属するワークスペースの名前。

    测试工作空间
    PageNum

    integer

    返されるページのページ番号。

    1
    PageSize

    integer

    インターフェイスがリクエストされたときに設定された、1ページあたりの行数。

    10
    TotalNum

    integer

    テーブルの合計行数。

    1
    TotalPages

    integer

    返される合計ページ数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Auth3rdFlag": 1,
        "Description": "备注",
        "Directory": {
          "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "Name": "所属目录名称。",
          "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "PathName": "测试目录"
        },
        "GmtCreate": "1496651577000",
        "GmtModify": "1572334870000",
        "ModifyName": "张三",
        "OwnerId": "作品所属工作空间名称。",
        "OwnerName": "李四",
        "PublicFlag": true,
        "PublicInvalidTime": 1721366354000,
        "SecurityLevel": "0",
        "Status": 1,
        "WorkName": "测试报表",
        "WorkType": "PAGE",
        "WorksId": "897ce25e-f993-4abd-af84-d13c5610****",
        "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

    エラーコード

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

    変更履歴

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