すべてのプロダクト
Search

このプロダクト

    :QueryWorks

    ドキュメントセンター

    :QueryWorks

    最終更新日:Sep 02, 2026

    指定されたデータ作業の情報を照会します。

    今すぐお試しください

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

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    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

    データ作業の備考。

    Remarks
    Directory

    object

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

    Id

    string

    データ作業が属するディレクトリの ID。

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

    string

    ディレクトリの名前。

    TestDirectory
    PathId

    string

    転送スラッシュ (/) で区切られたディレクトリ ID の階層パス。

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

    string

    転送スラッシュ (/) で区切られたディレクトリ名の階層パス。

    TestDirectory
    GmtCreate

    string

    データ作業が作成された時間のタイムスタンプ (ミリ秒単位)。

    1496651577000
    GmtModify

    string

    データ作業が最後に変更された時間のタイムスタンプ (ミリ秒単位)。

    1496651577000
    ModifyName

    string

    データ作業を最後に変更したユーザーの Alibaba Cloud アカウント名。

    John
    OwnerId

    string

    データ作業のオーナーの Quick BI UserID。

    9187a612aa474e2a8ac1414d5529****
    OwnerName

    string

    データ作業のオーナーの Alibaba Cloud アカウント名。

    John
    PublicFlag

    boolean

    データ作業が公開されているかどうかを示します。

    true
    PublicInvalidTime

    integer

    レポートの公開アクセスの有効期限。

    1721366354000
    SecurityLevel

    string

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

    • 0: 非公開。

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

    • 1 または 11: ワークスペースの全メンバーに権限付与。

    説明

    • レガシ権限モデルを使用している場合、戻り値は 1 です。

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

    0
    Status

    integer

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

    • 0: 未公開。

    • 1: 公開済み。

    • 2: 変更済みだが未公開。

    • 3: オフライン。

    0
    WorkName

    string

    データ作業の名前。

    TestReport
    WorkType

    string

    データ作業のタイプ。すべてのタイプを照会するには、このパラメーターを空にします。有効な値:

    • DATAPRODUCT: データポータル

    • PAGE: ダッシュボード

    • FULLPAGE: 全画面ダッシュボード

    • REPORT: ワークブック

    • dashboardOfflineQuery: アドホッククエリ

    PAGE
    WorksId

    string

    データ作業の ID。

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

    string

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

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

    string

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

    TestWorkspace
    GlobalParamVoList

    array<object>

    グローバルパラメーターの配列。

    object

    グローバルパラメーターオブジェクト。

    DataType

    string

    フィールドのタイプ。有効な値:

    • enum: 列挙

    • string: テキスト

    • number: 数値

    • datetime: 日付

    文字列
    ParamName

    string

    パラメーターの名前。

    lastQueryAt
    ParamAlias

    string

    パラメーターのエイリアス。

    lastQueryAt
    Required

    boolean

    パラメーターが必須かどうかを示します。

    false

    例

    成功レスポンス

    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": "测试空间",
    "GlobalParamVoList": [
      {
        "DataType": "string",
        "ParamName": "lastQueryAt",
        "ParamAlias": "lastQueryAt",
        "Required": false
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Invalid.Works.Empty This work does not exist. It may have been deleted. Work ID is %s. 作業が存在しません。削除された可能性があります。作業 ID: %s。
    400 Resource.NotBelongTo.CurrentOrganization The resource does not belong to the current organization. リソースが現在の組織に属していません。

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

    変更履歴

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