すべてのプロダクト
Search

このプロダクト

    :AddWorkspaceUsers

    ドキュメントセンター

    :AddWorkspaceUsers

    最終更新日:Sep 09, 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:AddWorkspaceUsers

    create

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    WorkspaceId

    string

    必須

    ワークスペースの ID。

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

    string

    必須

    ユーザーの ID。これらは Alibaba Cloud UID ではなく、Quick BI のユーザー ID です。

    • カンマ (,) で区切って複数のユーザー ID を指定できます。

    de4bc5f9429141cc8091cdd1c15b****
    RoleId

    integer

    必須

    事前設定されたワークスペースロールの ID。有効な値:

    • 25: ストレージ管理管理者

    • 26: ワークスペース開発者

    • 27: ストレージ分析アナリスト

    • 30: ワークスペース視聴者

    列挙値:

    • 25 :

      管理者。

    • 26 :

      開発者。

    • 27 :

      アナリスト。

    • 30 :

      視聴者。

    25

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Success

    boolean

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

    • true: リクエストが成功しました。一部のメンバーは正常に追加されますが、他のメンバーは失敗する場合があります。失敗の理由については、応答の FailureDetail を参照してください。

    • false: リクエストが失敗しました。データは永続化されません。

    true
    RequestId

    string

    リクエストの ID。

    7AAB95D7-2E11-4FE2-94BC-858E4FC0C976
    Result

    object

    操作の実行結果。

    Failure

    integer

    追加に失敗したユーザーの数。

    2
    FailureDetail

    object

    失敗の理由。

    {"2046274934845893" : "AE0150010001: このユーザーは既に存在します。", "1213444447906552" : "AE0150010001: このユーザーは既に存在します。"}
    Success

    integer

    追加されたユーザーの数。

    1
    Total

    integer

    追加されるユーザーの総数。

    3

    例

    成功レスポンス

    JSONJSON

    {
  "Success": true,
  "RequestId": "7AAB95D7-2E11-4FE2-94BC-858E4FC0C976",
  "Result": {
    "Failure": 2,
    "FailureDetail": {
      "2046274934845893": "AE0150010001: This user already exists.",
      "1213444447906552": "AE0150010001: This user already exists."
    },
    "Success": 1,
    "Total": 3
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Workspace.NotIn.Organization The workspace is not owned by the organization. ワークスペースが組織に属していません。
    400 User.RoleType.Valid The role ID is invalid. ロール ID が無効です。
    400 Viewer.CannotHave.CustomRole Organization viewer cannot have custom roles. 組織のビジターにカスタムロールを設定することはできません。
    400 UserAnalyst.NotSupport.ThisRole This role has permissions that analysts cannot grant. ロールにはアナリストが付与できない権限が含まれています。
    400 Workspace.Not.Exist The group workspace does not exist. グループワークスペースが存在しません。
    400 ApiUser.Not.Exists The specified user does not exist. ユーザーが存在しません。
    400 Viewer.AddInTo.Workspace Organization members with viewer type are not allowed to add to workspace: %s. 組織のゲストタイプのユーザーをワークスペースに追加することはできません: %s。
    400 User.AlreadyIn.Workspace This user already exists. ユーザーはワークスペースにすでに存在します。
    400 User.AlreadyIn.Role The user is already assigned this role. ユーザーには指定されたロールがすでに割り当てられています。

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

    変更履歴

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