調用ListUsers API擷取使用者詳情列表-Data Management-阿里雲

擷取使用者的詳情列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:ListUsers

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 ID，可通過調用介面 GetUserActiveTenant 擷取該參數的值。	3***
Role	string	否	使用者角色，取值說明如下： USER：普通使用者 DBA：DBA ADMIN：管理員 SECURITY_ADMIN：安全性系統管理員 STRUCT_READ_ONLY：結構唯讀說明您可在 DMS 控制台右上方頭像處查看您的角色。	DBA
UserState	string	否	使用者狀態，取值說明如下： NORMAL：正常 DISABLE：禁用 DELETE：已刪除	NORMAL
SearchKey	string	否	搜尋關鍵詞，支援模糊搜尋。	test
PageNumber	integer	否	開始頁數。	1
PageSize	integer	否	每頁記錄數。說明每頁記錄數，取值：10、20、50、100。預設值為 10。	10

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	滿足條件的記錄總數。	3
RequestId	string	請求 ID。	69161997-6030-53BA-A333-DBEC83B732FF
ErrorCode	string	錯誤碼。	InvalidTid
ErrorMessage	string	錯誤資訊。	Specified parameter Tid is not valid.
UserList	object
User	array<object>	使用者詳情列表。
	array<object>	使用者詳情。
State	string	使用者狀態，傳回值說明如下： NORMAL：正常 DISABLE：禁用 DELETE：已刪除	NORMAL
CurResultCount	integer	當天查詢行數。	0
UserId	string	使用者識別碼。	8****
LastLoginTime	string	最後登入時間。	2021-11-08 13:43:43
MaxResultCount	integer	當天最高查詢行數。	50000
ParentUid	string	父帳號 UID。	140692647406****
RoleIdList	object
RoleIds	array	角色 ID 列表。
	integer	角色 ID 列表，具體角色 ID 的傳回值說明如下： 1：表示角色為普通使用者。 2：表示角色為 DBA。 3：表示角色為管理員。 4：表示角色為安全性系統管理員。 6：表示角色為結構唯讀。	3
RoleNameList	object
RoleNames	array	角色列表。
	string	角色名稱列表，具體的角色名稱傳回值說明如下： USER：普通使用者 DBA：DBA ADMIN：管理員 SECURITY_ADMIN：安全性系統管理員 STRUCT_READ_ONLY：結構唯讀	ADMIN
NickName	string	使用者暱稱。	test_NickName
MaxExecuteCount	integer	當天最高查詢次數。	2000
CurExecuteCount	integer	當天查詢次數。	0
Mobile	string	使用者手機號碼。說明如果您已經在控制台介面右上方頭像處的通知裡配置過手機號碼，此處將返回。如果您沒有配置過手機號碼，此處則沒有返回。	1389999****
Uid	string	使用者 UID。	167382665015****
Email	string	電子郵箱，用於接收訊息通知。說明如果您已經在控制台介面右上方頭像處的通知裡配置過電子郵箱，此處將返回。如果您沒有配置過電子郵箱，此處則沒有返回。	username@example.com
DingRobot	string	DingTalk機器人，用於接收訊息通知。說明如果您已經在控制台介面右上方頭像處的通知裡配置過DingTalk機器人，此處將返回。如果您沒有配置過DingTalk機器人，此處則沒有返回。	https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef
Webhook	string	Webhook，用於接收訊息通知。說明如果您已經配置過 Webhook，當 DMS 中有訊息通知時，系統會將訊息通知發送到您指定的 URL 地址。如果您沒有配置過，此處則沒有返回。	http://dms-XXX.aliyun.com:8***
SignatureMethod	string	Webhook 簽名方式，傳回值說明如下： NONE：不簽名 HMAC_SHA1：HMAC_SHA1	HMAC_SHA1
NotificationMode	string	訊息通知方式，傳回值可能為多個值，單個傳回值說明如下： SMS：簡訊 EMAIL：電子郵箱 DINGDING：DingTalk DINGROBOT：DingTalk機器人 WEBHOOK：Webhook	DINGROBOT
Success	boolean	請求是否成功，傳回值如下： true：請求成功 false：請求失敗	true

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 3,
  "RequestId": "69161997-6030-53BA-A333-DBEC83B732FF",
  "ErrorCode": "InvalidTid",
  "ErrorMessage": "Specified parameter Tid is not valid.",
  "UserList": {
    "User": [
      {
        "State": "NORMAL",
        "CurResultCount": 0,
        "UserId": "8****",
        "LastLoginTime": "2021-11-08 13:43:43",
        "MaxResultCount": 50000,
        "ParentUid": "140692647406****",
        "RoleIdList": {
          "RoleIds": [
            3
          ]
        },
        "RoleNameList": {
          "RoleNames": [
            "ADMIN"
          ]
        },
        "NickName": "test_NickName",
        "MaxExecuteCount": 2000,
        "CurExecuteCount": 0,
        "Mobile": "1389999****",
        "Uid": "167382665015****",
        "Email": "username@example.com",
        "DingRobot": "https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef",
        "Webhook": "http://dms-XXX.aliyun.com:8***",
        "SignatureMethod": "HMAC_SHA1",
        "NotificationMode": "DINGROBOT"
      }
    ]
  },
  "Success": true
}

錯誤碼

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

變更歷史

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