GetUserGroupInfo を使用してユーザーグループ情報を検索 - 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:GetUserGroupInfo

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Keyword	string	必須	ユーザーグループ名のキーワード。	测试用户组

レスポンスフィールド

フィールド	型	説明	例
	object
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
RequestId	string	リクエスト ID。	D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5
Result	array<object>	ユーザーグループ情報。
	object
CreateTime	string	ユーザーグループの作成時間。	2021-03-15 17:13:55
CreateUser	string	サブユーザーグループの作成者。これは Alibaba Cloud の UID ではなく、Quick BI の UserID です。	46e5374665ba4b679ee22e2a2927****
IdentifiedPath	string	ユーザーグループのディレクトリレベル。	2fe4fbd8-588f-489a-b3e1-e92c7af0**/34fd141d-4598-4093-8c33-8e066dcb**
ModifiedTime	string	ユーザーグループの最終更新時間。	2021-03-15 20:36:40
ModifyUser	string	ユーザーグループの更新者。これは Alibaba Cloud の UID ではなく、Quick BI の UserID です。	46e5374665ba4b679ee22e2a2927****
ParentUsergroupId	string	親ユーザーグループの ID。	2fe4fbd8-588f-489a-b3e1-e92c7af0****
UsergroupDesc	string	ユーザーグループの説明。	测试描述
UsergroupId	string	ユーザーグループ ID。	34fd141d-4598-4093-8c33-8e066dcb****
UsergroupName	string	ユーザーグループの名前。	测试用户组01

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5",
  "Result": [
    {
      "CreateTime": "2021-03-15 17:13:55",
      "CreateUser": "46e5374665ba4b679ee22e2a2927****",
      "IdentifiedPath": "2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****",
      "ModifiedTime": "2021-03-15 20:36:40",
      "ModifyUser": "46e5374665ba4b679ee22e2a2927****",
      "ParentUsergroupId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
      "UsergroupDesc": "测试描述",
      "UsergroupId": "34fd141d-4598-4093-8c33-8e066dcb****",
      "UsergroupName": "测试用户组01"
    }
  ]
}

エラーコード

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

変更履歴

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