查詢用戶信息。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeUsers

系統規定參數。取值：DescribeUsers。
UserId String 否 1344***

阿里云子賬號UID。
UserType String 否 USER_TYPE_COMPANY_OWNER

用戶類型，可選值：

  • USER_TYPE_COMPANY_OWNER：商家主賬號
  • USER_TYPE_COMPANY_ROOT：高級商家管理員
  • USER_TYPE_COMPANY_ADMIN：商家管理員
  • USER_TYPE_STORE_ADMIN：門店管理員
  • USER_TYPE_STORE_OPERATOR：門店操作員
  • USER_TYPE_GUEST：沒有任何權限的訪客。
UserName String 否 張三

用戶姓名。
PageNumber Integer 否 1

分頁參數：當前頁碼，默認值1。
PageSize Integer 否 10

分頁參數：每頁顯示條數，默認值10。
ExtraParams String 否 {}

系統保留字段，請忽略；

返回數據

名稱 類型 示例值 描述
Code String -1001

內部錯誤碼。
DynamicCode String PlatformResponseError.%s

動態錯誤碼。
DynamicMessage String The specified store %s does not exist.

動態消息。
ErrorCode String MandatoryParameters

錯誤碼。
ErrorMessage String The specified resource type is invalid.

錯誤消息。
Message String success

消息。
PageNumber Integer 1

分頁參數：當前頁碼。
PageSize Integer 10

分頁參數：每頁顯示條數。
RequestId String E69C8998-1787-4999-8C75-D663FF1173CF

請求ID。
Success Boolean true

請求成功與否標識。
TotalCount Integer 100

總條數。
Users Array of UserInfo

用戶信息列表。
Bid String 26842

賬號類型；

26842：阿里云
DingTalkInfos Array of DingTalkInfo

釘釘賬號信息
DingTalkCompanyId String 13124

釘釘商家ID
DingTalkUserId String 3455566

釘釘用戶ID
OwnerId String 1212124434535

阿里云主賬號；
Stores String [s-dxsxxxxxx,s-dxsyyyyyyy]

門店ID列表。
UserId String 1344***

阿里云子賬號UID。
UserName String 張三

用戶姓名。
UserType String USER_TYPE_COMPANY_OWNER

用戶類型，可選值：

  • USER_TYPE_COMPANY_OWNER：商家主賬號
  • USER_TYPE_COMPANY_ROOT：高級商家管理員
  • USER_TYPE_COMPANY_ADMIN：商家管理員
  • USER_TYPE_STORE_ADMIN：門店管理員
  • USER_TYPE_STORE_OPERATOR：門店操作員
  • USER_TYPE_GUEST：沒有任何權限的訪客。

示例

請求示例

http(s)://cloudesl.cn-hangzhou.aliyuncs.com/?Action=DescribeUsers
&<公共請求參數>

正常返回示例

XML格式 

<TotalCount>100</TotalCount>
<PageSize>10</PageSize>
<RequestId>E69C8998-1787-4999-8C75-D663FF1173CF</RequestId>
<Message>success</Message>
<PageNumber>1</PageNumber>
<DynamicCode>PlatformResponseError.%s</DynamicCode>
<DynamicMessage>The specified store %s does not exist.</DynamicMessage>
<ErrorCode>MandatoryParameters</ErrorCode>
<Users>
    <UserName>張三</UserName>
    <OwnerId>1212124434535</OwnerId>
    <UserId>1344***</UserId>
    <Stores>[s-dxsxxxxxx,s-dxsyyyyyyy]</Stores>
    <Bid>26842</Bid>
    <UserType>USER_TYPE_COMPANY_OWNER</UserType>
    <DingTalkInfos>
        <DingTalkCompanyId>13124</DingTalkCompanyId>
        <DingTalkUserId>3455566</DingTalkUserId>
    </DingTalkInfos>
</Users>
<ErrorMessage>The specified resource type is invalid.</ErrorMessage>
<Code>-1001</Code>
<Success>true</Success>

JSON格式 

{
    "TotalCount": 100,
    "PageSize": 10,
    "RequestId": "E69C8998-1787-4999-8C75-D663FF1173CF",
    "Message": "success",
    "PageNumber": 1,
    "DynamicCode": "PlatformResponseError.%s",
    "DynamicMessage": "The specified store %s does not exist.",
    "ErrorCode": "MandatoryParameters",
    "Users": {
        "UserName": "張三",
        "OwnerId": 1212124434535,
        "UserId": "1344***",
        "Stores": "[s-dxsxxxxxx,s-dxsyyyyyyy]",
        "Bid": 26842,
        "UserType": "USER_TYPE_COMPANY_OWNER",
        "DingTalkInfos": {
            "DingTalkCompanyId": 13124,
            "DingTalkUserId": 3455566
        }
    },
    "ErrorMessage": "The specified resource type is invalid.",
    "Code": -1001,
    "Success": true
}

錯誤碼

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