DsgUserGroupQueryList で DSG ユーザーグループをクエリ - DataWorks

DsgUserGroupQueryList を呼び出して、Data Security Guard (DSG) 内のユーザーグループをクエリします。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:DsgUserGroupQueryList

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	必須	返されるページ番号です。	1
PageSize	integer	必須	1 ページあたりの表示件数です。最大値は 100 です。	10
Name	string	任意	ユーザーグループ名のキーワードです。サービスはあいまい検索を実行して、該当するユーザーグループを検索します。	yun_group
Owner	string	任意	ユーザーグループのオーナーです。	user1
ProjectName	string	任意	ユーザーグループをクエリする MaxCompute プロジェクトの名前です。	dev_project

レスポンスフィールド

フィールド	型	説明	例
	object	OpenApiResultModel<PagingResultModel<UserGroupQueryListVO>>
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 `true`：リクエストが成功しました。 `false`：リクエストが失敗しました。	true
ErrorCode	string	エラーコードです。	1029030003
ErrorMessage	string	エラーメッセージです。	param error
HttpStatusCode	integer	HTTP ステータスコードです。	400
PageData	object	ページネーションによるクエリ結果です。
PageNumber	integer	ページ番号です。	1
PageSize	integer	1 ページあたりの表示件数です。最大値は 100 です。	10
TotalCount	integer	ユーザーグループの合計件数です。	100
Data	array<object>	ユーザーグループの一覧です。	{ "accounts": [ "role_project_scheduler" ], "gmtCreate": "2024-05-10 15:22:18", "gmtModified": "2024-05-10 15:22:18", "id": 1955, "name": "dsg_fin_test-复制", "owner": "UAT" }
	object	ユーザーグループの詳細情報です。
Accounts	array	ユーザーグループに属するユーザー名の一覧です。
	string	ユーザー名です。	user1
Id	integer	ユーザーグループの ID です。	123
GmtCreate	string	ユーザーグループが作成された時刻です。	2024-05-10 17:14:44
GmtModified	string	ユーザーグループが最後に更新された時刻です。	2024-05-10 17:14:44
Name	string	ユーザーグループの名前です。	test_group
Owner	string	ユーザーグループのオーナーです。	user1
mcAggregationInfo	string
RequestId	string	リクエスト ID です。	102400001

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "PageData": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Data": [
      {
        "Accounts": [
          "user1"
        ],
        "Id": 123,
        "GmtCreate": "2024-05-10 17:14:44",
        "GmtModified": "2024-05-10 17:14:44",
        "Name": "test_group",
        "Owner": "user1",
        "mcAggregationInfo": ""
      }
    ]
  },
  "RequestId": "102400001"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	PARAMS.ERROR	param error.
400	USERGROUP.ACCOUNTLISTSIZE.ERROR	The number of account exceeds the limit.
400	USERGROUP.ID.ERROR	The user group ID does not match the tenant or does not exist.
400	USERGROUP.LISTSIZE.ERROR	The number of user groups exceeds the limit.
400	USERGROUP.PAGESIZE.ERROR	Page size is too large, maximum of 100.
400	USERACCOUNT.OWNER.ERROR	User list or owner user does not exist.
500	UNKNOWN.ERROR	unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied

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

変更履歴

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