All Products
Search
Document Center

:DsgUserGroupQueryUserList

最終更新日:Jun 05, 2024

Queries a list of users or roles of the current tenant.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes DsgUserGroupQueryUserList

The operation that you want to perform. Set the value to DsgUserGroupQueryUserList.

Response parameters

Parameter

Type

Example

Description

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true
  • false
ErrorCode String 1029030003

The error code.

ErrorMessage String param error

The error message.

HttpStatusCode Integer 400

The HTTP status code.

Data Array of Datas

The returned data.

AccountName String user1

The name of the user.

YunAccount String user:user1

The name of the Alibaba Cloud account or RAM role. The return value of this parameter must be used if the user group is created by using an Alibaba Cloud account or a RAM role.

AccountType Integer 2

The type of the user. Valid values:

  • 1 to 5: Alibaba Cloud account
  • 6: RAM role
BaseId String 234

The user ID or role ID.

ParentAccountId String 123

The parent user ID. This parameter is required if a RAM user is used.

RequestId String 102400001

The request ID. You can use the ID to locate logs and troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DsgUserGroupQueryUserList
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DsgUserGroupQueryUserListResponse>
    <Success>true</Success>
    <ErrorCode>1029030003</ErrorCode>
    <ErrorMessage>param error</ErrorMessage>
    <HttpStatusCode>400</HttpStatusCode>
    <Data>
        <AccountName>user1</AccountName>
        <YunAccount>user:user1</YunAccount>
        <AccountType>2</AccountType>
        <BaseId>234</BaseId>
        <ParentAccountId>123</ParentAccountId>
    </Data>
    <RequestId>102400001</RequestId>
</DsgUserGroupQueryUserListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "ErrorCode" : "1029030003",
  "ErrorMessage" : "param error",
  "HttpStatusCode" : 400,
  "Data" : [ {
    "AccountName" : "user1",
    "YunAccount" : "user:user1",
    "AccountType" : 2,
    "BaseId" : "234",
    "ParentAccountId" : "123"
  } ],
  "RequestId" : "102400001"
}

Error codes

HttpCode

Error code

Error message

Description

400 USERGROUP.ACCOUNTLISTSIZE.ERROR The number of account exceeds the limit. The number of users exceeds the upper limit.
400 USERGROUP.ID.ERROR The user group ID does not match the tenant or does not exist. The user group ID does not exist or does not belong to the tenant.
400 USERGROUP.LISTSIZE.ERROR The number of user groups exceeds the limit. The number of user groups exceeds the upper limit.
400 USERGROUP.PAGESIZE.ERROR Page size is too large, maximum of 100. The number of entries per page exceeds the upper limit. The maximum number of entries per page is 100.
400 USERACCOUNT.OWNER.ERROR User list or owner user does not exist. The user list or the owner of users does not exist.
400 PARAMS.ERROR param error. The values specified for one or more parameters are invalid.
403 PERMISSION.DENIED.ERROR Permission denied You are not authorized to perform this operation.
500 UNKNOWN.ERROR unknown error. An unknown error has occurred.

For a list of error codes, see Service error codes.