調用ListRoles API查詢資料湖角色列表-資料湖構建-阿里雲

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dlf:ListRoles

get

*全部資源

*

無

請求文法

GET /api/metastore/auth/roles/list HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
NextPageToken	string	否	翻頁令牌，用於擷取下一頁資料。如果響應結果中沒有提供，則傳Null 字元串（""）或Null 字元（''）。	token!
RoleNamePattern	string	否	角色名稱匹配的Regex。支援模糊搜尋，比如.test.。	.test.
PageSize	integer	否	分頁大小，最大值為 1000。	100

返回參數

名稱	類型	描述	樣本值
	object	返回訊息體。
RequestId	string	請求 ID。	B7F4B621-E41E-4C84-B97F-42B5380A32BB
Code	string	狀態代碼描述。	OK
Message	string	返回資訊。	.
Success	boolean	是否調用成功。取值如下： true：調用成功。 false：調用失敗。	True
NextPageToken	string	翻頁令牌，用於擷取下一頁資料。	2cb472ec1bf84f8d92f9c4baa0d21c19aa
Roles	Roles	角色列表資訊。	[ { "Description":"reserved by the system", "DisplayName":"admin", "UpdateTime":0, "IsPredefined":1, "Name":"admin" } ]

樣本

正常返回樣本

JSON格式

{
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Code": "OK",
  "Message": ".",
  "Success": true,
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
  "Roles": [
    {
      "Name": "role_name",
      "Description": "role description",
      "Users": [
        {
          "PrincipalArn": "acs:ram::[AliyunAccountId]:user/username_abc"
        }
      ],
      "DisplayName": "顯示名稱，允許中文",
      "PrincipalArn": "acs:dlf::111:role/role_name",
      "CreateTime": 1647323053,
      "UpdateTime": 1647323053,
      "IsPredefined": 1
    }
  ]
}

錯誤碼

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

變更歷史

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