すべてのプロダクト
Search

このプロダクト

    :QueryWorks

    ドキュメントセンター

    :QueryWorks

    最終更新日: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:QueryWorks

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    WorksId

    string

    必須

    レポート ID

    abcd****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Success

    boolean

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

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

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

    true
    RequestId

    string

    リクエストの ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    object

    ワークの詳細。

    Auth3rdFlag

    integer

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

    • 0：埋め込みサービスが有効になっていません。

    • 1：埋め込みが有効になっています。

    0
    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

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

    1496651577000
    ModifyName

    string

    ワークを変更した人の Alibaba Cloud アカウント名。

    张三
    OwnerId

    string

    Quick BI におけるワークのオーナーのユーザー ID。

    9187a612aa474e2a8ac1414d5529****
    OwnerName

    string

    ワークのオーナーの Alibaba Cloud アカウント名。

    张三
    PublicFlag

    boolean

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

    true
    PublicInvalidTime

    integer

    レポートの公開期限。

    1721366354000
    SecurityLevel

    string

    ワークの共同権限付与のためのセキュリティポリシー。有効な値：

    • 0：非公開

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

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

    説明

    • レガシー権限を使用する場合、戻り値は 1 です。

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

    0
    Status

    integer

    レポートのステータス。有効な値：

    • 0：未公開

    • 1：公開済み

    • 2：変更されたが未公開

    • 3：未公開

    0
    WorkName

    string

    ワークの名前。

    测试报表
    WorkType

    string

    ワークのタイプをクエリします。すべてのタイプをクエリするには、空白のままにします。有効な値：

    • DATAPRODUCT：BI ポータル

    • PAGE：ダッシュボード

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

    • REPORT：ワークブック

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

    PAGE
    WorksId

    string

    ワークの ID。

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

    string

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

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

    string

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

    测试空间

    例

    成功レスポンス

    JSONJSON

    {
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Auth3rdFlag": 0,
    "Description": "备注",
    "Directory": {
      "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "Name": "测试目录",
      "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "PathName": "测试目录"
    },
    "GmtCreate": "1496651577000",
    "GmtModify": "1496651577000",
    "ModifyName": "张三",
    "OwnerId": "9187a612aa474e2a8ac1414d5529****",
    "OwnerName": "张三",
    "PublicFlag": true,
    "PublicInvalidTime": 1721366354000,
    "SecurityLevel": "0",
    "Status": 0,
    "WorkName": "测试报表",
    "WorkType": "PAGE",
    "WorksId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
    "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
    "WorkspaceName": "测试空间"
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Invalid.Works.Empty This work does not exist. It may have been deleted. Work ID is %s.
    400 Resource.NotBelongTo.CurrentOrganization The resource does not belong to the current organization.

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

    変更履歴

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