すべてのプロダクト
Search
ドキュメントセンター

:QueryShareList

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

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ReportId

string

必須

作品の ID。 作品には、データポータル、ダッシュボード、スプレッドシート、セルフサービスデータ抽出、アドホック分析、データ入力、データ可視化画面が含まれます。

6b407e50-e774-406b-9956-da2425c2****

レスポンスフィールド

フィールド

説明

object

Success

boolean

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

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

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

true

RequestId

string

リクエスト ID。

DC4E1E63-B337-44F8-8C22-6F00DF67E2C3

Result

array<object>

作品が共有されているオブジェクトのリストを返します。

object

AuthPoint

integer

共有権限。 有効値:

  • 1:表示のみ

  • 3:表示とエクスポート

3

ExpireDate

integer

権限付与の有効期限を示すミリ秒単位のタイムスタンプ。

1640102400000

ReportId

string

作品の ID。

6b407e50-e774-406b-9956-da2425c2****

ShareId

string

共有設定の ID。

0ab9659e-29cf-47d7-a364-3a91553b****

ShareToId

string

共有先の ID。Quick BI のユーザー ID またはグループ ID を指定できます。

  • ShareToType=2 (組織内のすべてのメンバー) の場合、ShareToId は組織 ID です。

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

ShareToName

string

共有先の名前。

小张

ShareToType

integer

共有のタイプ。 有効値:

  • 0:ユーザー

  • 1:グループ

  • 2:組織

  • 3:スペース

0

ShareType

string

共有された作品のタイプ。 有効値は次のとおりです。

  • dataProduct:データポータル

  • dashboard:ダッシュボード

  • report:スプレッドシート

  • dashboardOfflineQuery:セルフサービスデータ抽出

  • ANALYSIS:アドホック分析

  • DATAFORM:データ入力

  • SCREEN:データ可視化画面

dashboard

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": [
    {
      "AuthPoint": 3,
      "ExpireDate": 1640102400000,
      "ReportId": "6b407e50-e774-406b-9956-da2425c2****",
      "ShareId": "0ab9659e-29cf-47d7-a364-3a91553b****",
      "ShareToId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
      "ShareToName": "小张",
      "ShareToType": 0,
      "ShareType": "dashboard"
    }
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Report.NotExist.Error This work does not exist. It may have been deleted. Work ID is %s. 指定されたワークブックは存在しないか、削除されています。ワークブック ID:%s。
400 Workspace.Not.Exist The group workspace does not exist. 指定されたワークスペースは存在しません。
400 Workspace.NotIn.Organization The workspace is not owned by the organization. 指定されたワークスペースは組織単位内にありません。

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

変更履歴

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