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

:ListProjectRoles

最終更新日:Mar 21, 2026

DataWorks ワークスペースのロール情報をページごとにクエリします。

操作説明

この API オペレーションは、すべての DataWorks エディションで利用可能です。

今すぐお試しください

この 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。DataWorks コンソールにログインし、ワークスペースページに移動して ID をクエリできます。

このパラメーターを設定して、API オペレーションが適用される DataWorks ワークスペースを指定する必要があります。

21229

Codes

array

任意

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

string

任意

DataWorks ワークスペースのロールのコード。有効な値:

  • 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

任意

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

string

任意

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

Visitors

Type

string

任意

ロールのタイプ。有効な値:

  • UserCustom: ユーザー定義ロール

  • System: システムロール

System

PageNumber

integer

任意

ページ番号。

1

PageSize

integer

任意

1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。

10

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

RequestId

string

リクエスト ID。

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

PagingInfo

object

ページネーション情報。

PageSize

string

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

10

PageNumber

string

ページ番号。

1

TotalCount

string

返されるエントリの総数。

42

ProjectRoles

array<object>

DataWorks ワークスペースのロール。

object

DataWorks ワークスペースのロール。

ProjectId

integer

DataWorks ワークスペース ID。

21229

Code

string

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

role_project_guest

Name

string

ロールの名前。

Visitors

Type

string

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

System

成功レスポンス

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"
      }
    ]
  }
}

エラーコード

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

変更履歴

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