QueryWorkspaceRoleConfig API を使用したワークスペースロール構成の取得 - Quick BI

指定されたワークスペースロールの構成情報を取得します。

今すぐお試しください

この 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:QueryWorkspaceRoleConfig

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RoleId	integer	必須	ワークスペースのロール ID。事前定義ロールとカスタムロールが含まれます： 25：ワークスペース管理者 (事前定義ロール) 26：開発者 (事前定義ロール) 27：アナリスト (事前定義ロール) 30：閲覧者 (事前定義ロール) カスタムロール：カスタムロールに対応するロール ID	25

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	object	インターフェイスのクエリ結果を返します。
AuthConfigList	array<object>	ロール権限構成のリスト。
	object	特定の権限構成。
ActionAuthKeys	array	権限範囲。
	string	特定の権限： edit：作成 use：使用 list：リスト表示	edit
AuthKey	string	権限タイプ： portal_create：データポータル dashboard_create：ダッシュボード report_create：電子ワークシート screen_create：データスクリーン analysis：アドホック分析 offline_download：セルフサービスデータ取得 data_form：データ入力 quick_etl：データ準備 cube：データセット datasource：データソース	portal_create
IsSystemRole	boolean	事前定義ロールかどうか。有効な値： true：はい false：いいえ	true
RoleId	integer	ワークスペースのロール ID。事前定義ロールとカスタムロールが含まれます： 25：ワークスペース管理者 (事前定義ロール) 26：開発者 (事前定義ロール) 27：アナリスト (事前定義ロール) 30：閲覧者 (事前定義ロール) カスタムロール：カスタムロールに対応するロール ID	25
RoleName	string	ロール名。	空间管理员
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": {
    "AuthConfigList": [
      {
        "ActionAuthKeys": [
          "edit"
        ],
        "AuthKey": "portal_create"
      }
    ],
    "IsSystemRole": true,
    "RoleId": 25,
    "RoleName": "空间管理员"
  },
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	User.Role.NotExist	User role not exist: %s.

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

変更履歴

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