QueryUserGroupListByParentId で子ユーザーグループを取得 - 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:QueryUserGroupListByParentId

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ParentUserGroupId	string	必須	親ユーザーグループの ID。親ユーザーグループの ID を入力すると、この ID 配下の子ユーザーグループの情報を取得できます。 -1 を入力すると、ルートディレクトリ配下の子ユーザーグループの情報を取得できます。	3d2c23d4-2b41-4af8-a1f5-f6390f32****

レスポンスフィールド

フィールド	型	説明	例
	object
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
RequestId	string	リクエスト ID。	72B19D61-B37A-5C7A-9389-0856CD7935B3
Result	array<object>	子ユーザーグループの情報。
	object
CreateTime	string	子ユーザーグループが作成された時間。	2020-10-30 10:03:09
CreateUser	string	子ユーザーグループの作成者。 Alibaba Cloud の UID の代わりに Quick BI の UserID が使用されます。	136516262323****
IdentifiedPath	string	子ユーザーグループのディレクトリレベル。	2fe4fbd8-588f-489a-b3e1-e92c7af0**/3d2c23d4-2b41-4af8-a1f5-f6390f32/f5eeb52e-d9c2-4a8b-80e3-47ab55c2**
ModifiedTime	string	子ユーザーグループが最後に変更された時間。	2020-11-16 15:49:08
ModifyUser	string	子ユーザーグループを変更したユーザー。 Alibaba Cloud の UID の代わりに Quick BI の UserID が使用されます。	136516262323****
ParentUserGroupId	string	親ユーザーグループの ID。	3d2c23d4-2b41-4af8-a1f5-f6390f32****
UserGroupDescription	string	子ユーザーグループの説明。	用来测试的用户组
UserGroupId	string	子ユーザーグループの ID。	f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
UserGroupName	string	子ユーザーグループの名前。	popapi测试分组

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "72B19D61-B37A-5C7A-9389-0856CD7935B3",
  "Result": [
    {
      "CreateTime": "2020-10-30 10:03:09",
      "CreateUser": "136516262323****",
      "IdentifiedPath": "2fe4fbd8-588f-489a-b3e1-e92c7af0****/3d2c23d4-2b41-4af8-a1f5-f6390f32****/f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
      "ModifiedTime": "2020-11-16 15:49:08",
      "ModifyUser": "136516262323****",
      "ParentUserGroupId": "3d2c23d4-2b41-4af8-a1f5-f6390f32****",
      "UserGroupDescription": "用来测试的用户组",
      "UserGroupId": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
      "UserGroupName": "popapi测试分组"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	UserGroup.NotIn.Organization	The user group is not in the current organization.
400	Usergroup.Not.Exist	The user group does not exist.

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

変更履歴

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