すべてのプロダクト
Search

このプロダクト

    DataWorks:ListProjectRoles

    ドキュメントセンター

    DataWorks:ListProjectRoles

    最終更新日:May 14, 2026

    ワークスペース内のロールのページ分割されたリストを返します。

    操作説明

    この機能は、DataWorks Basic Edition 以降で利用できます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:ListProjectRoles

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ProjectId

    integer

    必須

    DataWorks ワークスペースの ID です。ID は DataWorks コンソールの「ワークスペース管理」ページで確認できます。

    このパラメーターでは、ロールを一覧表示する DataWorks ワークスペースを指定します。

    21229
    Codes

    array

    任意

    ワークスペースロールコードの配列です。

    string

    任意

    ワークスペースロールのコードです。

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

    • role_project_dev：開発者

    • role_project_dg_admin：データガバナンス管理者

    • role_project_guest：ゲスト

    • role_project_security：セキュリティ管理者

    • role_project_deploy：デプロイ担当者

    • role_project_owner：ワークスペース所有者

    • role_project_data_analyst：データアナリスト

    • role_project_pe：運用保守

    • role_project_erd：モデル設計者

    role_project_guest
    Names

    array

    任意

    ワークスペースロール名の配列です。

    string

    任意

    ワークスペースロールの名前です。

    Visitors
    Type

    string

    任意

    ワークスペースロールのタイプです。

    • UserCustom：カスタムロール

    • System：システムロール

    System
    PageNumber

    integer

    任意

    返されるページ番号です。

    1
    PageSize

    integer

    任意

    1ページあたりに返されるエントリ数です。デフォルト値は 10、最大値は 100 です。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ。

    RequestId

    string

    リクエスト ID。この ID を使用してログを特定し、問題のトラブルシューティングを行います。

    61649187-0BCF-5E75-8D4B-64FDBEBBB447
    PagingInfo

    object

    ページネーション情報。

    PageSize

    string

    ページあたりのエントリ数。

    10
    PageNumber

    string

    返されるページ番号。

    1
    TotalCount

    string

    一致するエントリの総数。

    42
    ProjectRoles

    array<object>

    ワークスペースロールのリスト。

    array<object>

    ワークスペースロールの詳細。

    ProjectId

    integer

    DataWorks ワークスペースの ID。

    注：システム定義ロールの場合、このパラメーターは -1 を返します。

    21229
    Code

    string

    ワークスペースロールのコード。

    role_project_guest

    Name

    string

    ワークスペースロールの名前。

    Visitors
    Type

    string

    ワークスペースロールのタイプ。

    System
    ModulePermissions

    array<object>

    object

    ModuleId

    integer

    2
    ModuleName

    string

    HoloStudio
    PermissionType

    string

    Read

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "61649187-0BCF-5E75-8D4B-64FDBEBBB447",
  "PagingInfo": {
    "PageSize": "10",
    "PageNumber": "1",
    "TotalCount": "42",
    "ProjectRoles": [
      {
        "ProjectId": 21229,
        "Code": "role_project_guest\n",
        "Name": "Visitors",
        "Type": "System",
        "ModulePermissions": [
          {
            "ModuleId": 2,
            "ModuleName": "HoloStudio",
            "PermissionType": "Read"
          }
        ]
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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