ListByUserGroupId でユーザーグループ情報を ID でクエリ - Quick BI

ユーザーグループ ID に基づいて、ユーザーグループ情報を一度にクエリします。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
UserGroupIds	string	必須	クエリするユーザーグループの ID。複数のユーザーグループ ID はコンマ (,) で区切ります。	34fe-*-6dcb,84q9-**-4a274

レスポンスフィールド

フィールド	型	説明	例
	object
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
RequestId	string	リクエスト ID。	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	object	返されるユーザーグループのクエリ結果。
FailedUserGroupIds	array	失敗したユーザーグループのリスト。
	string	クエリに失敗したユーザーグループ ID。	[]
UserGroupModels	array<object>	クエリされたユーザーグループの詳細。
	object
CreateTime	string	シークレットが作成された時間。	2021-03-15 17:13:55
CreateUser	string	Quick BI の作成者の UserID。	46e5*******ee22e2a292704c8
IdentifiedPath	string	ユーザーグループのパス。	2fe4fbd8-**-af083ea/34fd1-**-dcbc33f
ModifiedTime	string	保護ポリシーが最後に更新された時刻です。	2021-03-15 20:36:40
ModifyUser	string	Quick BI の変更者の UserID。	46e5*******ee22e2a292704c8
ParentUsergroupId	string	親ユーザーグループの ID。	2fe4fbd8-588f-489a-b3e1-e92c7af083ea
UsergroupDesc	string	ユーザーグループの説明。	描述信息
UsergroupId	string	ユーザーグループの ID。	34fd141d-****-4093-8c33-8e066dcbc33f
UsergroupName	string	ユーザーグループの名前。	测试用户组

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": {
    "FailedUserGroupIds": [
      "[]"
    ],
    "UserGroupModels": [
      {
        "CreateTime": "2021-03-15 17:13:55",
        "CreateUser": "46e5*******ee22e2a292704c8",
        "IdentifiedPath": "2fe4fbd8-****-af083ea/34fd1-****-dcbc33f",
        "ModifiedTime": "2021-03-15 20:36:40",
        "ModifyUser": "46e5*******ee22e2a292704c8",
        "ParentUsergroupId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
        "UsergroupDesc": "描述信息",
        "UsergroupId": "34fd141d-****-4093-8c33-8e066dcbc33f",
        "UsergroupName": "测试用户组"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Usergroup.Not.Exist	The user group does not exist.

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

変更履歴

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