すべてのプロダクト
Search

このプロダクト

    :AddShareReport

    ドキュメントセンター

    :AddShareReport

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

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    WorksId

    string

    必須

    共有ワークの ID。ここでのワークには、BI ポータル、ダッシュボード、スプレッドシート、セルフサービスアクセスが含まれます。

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

    string

    任意

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

    • ShareToType が 0 (ユーザー) の場合、ShareToId はユーザー ID です。

    • ShareToType が 1 (ユーザーグループ) の場合、ShareToId はユーザーグループ ID です。

    • ShareToType が 2 (組織) の場合、ShareToId は組織の ID です。

    de4bc5f9429141cc8091cdd1c15b****
    ShareToType

    integer

    必須

    テンプレートの共有タイプ。有効な値：

    • 0：ユーザー

    • 1：ユーザーグループ

    • 2：組織

    0
    ExpireDate

    integer

    必須

    共有の有効期間。値はミリ秒単位のタイムスタンプです。

    1608202110838
    AuthPoint

    integer

    必須

    権限付与の範囲。有効な値：

    • 1：表示のみ

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

    3

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID。

    05739b8e-3de0-4204-9669-7f04f02522b9
    Result

    boolean

    インターフェイスの実行結果が返されます。有効な値：

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

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

    true
    Success

    boolean

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

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

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

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "05739b8e-3de0-4204-9669-7f04f02522b9",
  "Result": true,
  "Success": true
}

    エラーコード

    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. 指定されたワークスペースは組織単位内にありません。
    400 Workspace.Share.Forbidden Content in the current group workspace cannot be shared. このワークスペースで項目を共有することはできません。
    400 Workspace.OutsideShare.Forbidden Content in the current group workspace cannot be shared with another organization. このワークスペースでは、この組織単位以外のメンバーと項目を共有することはできません。
    400 Usergroup.Not.Exist The user group does not exist.
    400 UserGroup.NotIn.Organization The user group is not in the current organization.
    400 Share.ExpireDate.Error The expire date is illegal.

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

    変更履歴

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