すべてのプロダクト
Search

このプロダクト

    :QueryWorkspaceUserList

    ドキュメントセンター

    :QueryWorkspaceUserList

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

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    WorkspaceId

    string

    必須

    ワークスペース ID。

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

    string

    任意

    ワークスペースメンバーのユーザー名に対するキーワード。

    分析
    PageNum

    integer

    任意

    ワークスペースメンバーリストの現在のページ番号：

    • 開始値：1

    • デフォルト値：1

    1
    PageSize

    integer

    任意

    ページ分割されたクエリにおける1ページあたりの行数：

    • デフォルト値：10

    • 最大値：1000

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Success

    boolean

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

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

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

    true
    RequestId

    string

    リクエスト ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    object

    メンバーリストのページ分割された結果を返します。メンバーの詳細情報は、応答の Data パラメーターに格納されます。

    Data

    array<object>

    ワークスペースメンバーに関する情報。

    array<object>

    AccountId

    string

    Alibaba Cloud アカウント ID。

    16020915****8429
    AccountName

    string

    Alibaba Cloud アカウント名。

    pop****@aliyunid.test
    NickName

    string

    ニックネーム。

    我就是那个分析师大神
    Role

    object

    ワークスペースメンバーのプリセットロール情報。

    RoleCode

    string

    プリセットロールに対応するコード。

    role_workspace_admin
    RoleId

    integer

    プリセットロール ID。有効な値：

    • 25：ワークスペース管理者

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

    • 27：ワークスペース分析者

    • 30：ワークスペース閲覧者

    25
    RoleName

    string

    プリセットロールの名前。

    管理员
    UserId

    string

    Quick BI ユーザー ID。

    de4bc5f9429141cc8091cdd1c15b****
    PageNum

    integer

    ページ番号。

    1
    PageSize

    integer

    リクエストで設定された1ページあたりの行数。

    10
    TotalNum

    integer

    総行数。

    1
    TotalPages

    integer

    総ページ数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AccountId": "16020915****8429",
        "AccountName": "pop****@aliyunid.test",
        "NickName": "我就是那个分析师大神",
        "Role": {
          "RoleCode": "role_workspace_admin",
          "RoleId": 25,
          "RoleName": "管理员"
        },
        "UserId": "de4bc5f9429141cc8091cdd1c15b****"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Workspace.NotIn.Organization The workspace is not owned by the organization.
    400 Workspace.Not.Exist The group workspace does not exist.

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

    変更履歴

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