GetProjectRole API 概要 - DataWorks ワークスロール管理 - Alibaba Cloud - DataWorks

ワークスペースロールの詳細を照会します。

操作説明

この API は、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:GetProjectRole

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペースの ID。DataWorks コンソールにログインし、ワークスペース管理ページでワークスペース ID を取得できます。	10002
Code	string	必須	ワークスペースロールのコード。有効な値： role_project_admin: ワークスペース管理者 role_project_dev: デベロッパー role_project_dg_admin: データガバナンス管理者 role_project_guest: Visitors role_project_security: セキュリティ管理者 role_project_deploy: デプロイヤー role_project_owner: ワークスペースオーナー role_project_data_analyst: データアナリスト role_project_pe: 運用保守エンジニア role_project_erd: モデルデザイナー	role_project_guest

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス。
RequestId	string	リクエスト ID。	82F28E60-CF48-5EDF-AB25-D806847B97D1
ProjectRole	object	ワークスペースロールの詳細。
ProjectId	integer	DataWorks ワークスペースの ID。注：システムロールの場合、固定値 -1 が返されます。	10002
Code	string	ワークスペースロールのコード。	role_project_guest
Name	string	ワークスペースロールの名前。	Visitors
Type	string	ワークスペースロールのタイプ。有効な値： UserCustom: カスタムロール System: システムロール	System
ModulePermissions	array<object>	ワークスペース内モジュールの権限。
	object
ModuleId	integer	モジュール ID。	2
ModuleName	string	モジュール名。	HoloStudio
PermissionType	string	権限タイプ。	Read

例

成功レスポンス

JSONJSON

{
  "RequestId": "82F28E60-CF48-5EDF-AB25-D806847B97D1",
  "ProjectRole": {
    "ProjectId": 10002,
    "Code": "role_project_guest",
    "Name": "Visitors",
    "Type": "System",
    "ModulePermissions": [
      {
        "ModuleId": 2,
        "ModuleName": "HoloStudio",
        "PermissionType": "Read"
      }
    ]
  }
}

エラーコード

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

変更履歴

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