AddUserGroupMember でメンバーをユーザーグループに追加 - 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:AddUserGroupMember

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
UserGroupId	string	必須	ユーザーグループの ID。	555c4cd****
UserIdList	string	必須	Quick BI ユーザーの ID。複数の ID はコンマ (,) で区切ります。例：abc,efg。最大 1000 エントリまで入力できます。	46e537a5**,3dadsu**

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	B6141A5A-A9EF-5F16-BF34-EFB9C1CCE4F3
Result	boolean	ユーザーグループへのメンバー追加の結果が返されます。有効な値： true：追加に成功しました。 false：追加に失敗しました。	true
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "B6141A5A-A9EF-5F16-BF34-EFB9C1CCE4F3",
  "Result": true,
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.User	The user does not exist and cannot be added to a user group.
400	Usergroup.Not.Exist	The user group does not exist.
400	Parameter.Length.Exceed	Parameter length exceeds maximum limit: [%s].
400	UserGroup.Already.Synchronized	Organization has synchronized with other organizational structures, so you are not allowed to add users under group.

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

変更履歴

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