調用DsgUserGroupQueryList介面查詢資料保護傘的使用者組列表-巨量資料開發治理平台 DataWorks-阿里雲

調用DsgUserGroupQueryList介面，查詢資料保護傘的使用者組列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:DsgUserGroupQueryList

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	是	分頁的頁碼數。	1
PageSize	integer	是	每頁顯示的條數，最大為 100。	10
Name	string	否	使用者組名稱關鍵字。平台會根據該關鍵字模糊比對，查詢相關使用者組資訊。	yun_group
Owner	string	否	使用者組的負責人。	user1
ProjectName	string	否	引擎名稱。如需查詢 MaxCompute 使用者組資訊，可配置該參數。	dev_project
userGroupType	integer	否

返回參數

名稱	類型	描述	樣本值
	object	OpenApiResultModel<PagingResultModel>
Success	boolean	調用是否成功。取值如下： true：調用成功。 false：調用失敗。	true
ErrorCode	string	錯誤碼。	1029030003
ErrorMessage	string	錯誤資訊。	param error
HttpStatusCode	integer	HTTP 狀態代碼。	400
PageData	object	分頁資料查詢結果。
PageNumber	integer	分頁的頁碼數。	1
PageSize	integer	每頁顯示的條數，最大為 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

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
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.	使用者組ID不存在或不屬於該租戶。
400	USERGROUP.LISTSIZE.ERROR	The number of user groups exceeds the limit.	使用者組數量超限。
400	USERGROUP.PAGESIZE.ERROR	Page size is too large, maximum of 100.	頁大小超限，最大為100。
400	USERACCOUNT.OWNER.ERROR	User list or owner user does not exist.	使用者列表或負責人使用者不存在。
500	UNKNOWN.ERROR	unknown error.	未知錯誤。
403	PERMISSION.DENIED.ERROR	Permission denied	許可權不足。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。