You need to enable JavaScript to run this app.
E-MapReduce

E-MapReduce

Copy page
Download PDF
User management
ListClusterUsers - Get cluster user list
Copy page
Download PDF
ListClusterUsers - Get cluster user list

Get cluster user list

Debug

request parameters

The following table lists only the unique request parameters for this API and some common parameters. For more information, see common parameters.

const columns = [ 
  { 
    width: '20%', 
title: 'Parameter', 
    dataIndex: 'Name', 
    className: 'openapi-doc-parameter-table-name' 
  }, 
  { 
    width: 130, 
title: 'Type', 
    dataIndex: 'DataType', 
    className: 'openapi-doc-parameter-table-type' 
  }, 
  { 
    width: 90, 
title: 'Required', 
    dataIndex: 'IsRequired', 
    className: 'openapi-doc-parameter-table-required' 
  }, 
  { 
    width: '20%', 
title: 'Example value', 
    dataIndex: 'Example', 
    className: 'openapi-doc-parameter-table-example' 
  }, 
  { 
title: 'Description', 
    dataIndex: 'Description', 
    className: 'openapi-doc-parameter-table-description' 
  }, 
]; 

const data = [ 
  { 
    rowKey: '->Action', 
    Name: 'Action', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"ListClusterUsers"} />, 
Description: <RenderMd content={"Operation to be performed. Value: ListClusterUsers."} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->Version', 
    Name: 'Version', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"2023-08-15"} />, 
Description: <RenderMd content={"API version. Value: 2023-08-15."} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ClusterId', 
    Name: 'ClusterId', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"emr-xxx"} />, 
Description: <RenderMd content={"Cluster ID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->UserName', 
    Name: 'UserName', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"emr_user"} />, 
Description: <RenderMd content={"Cluster username"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->Keyword', 
    Name: 'Keyword', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"emr"} />, 
Description: <RenderMd content={"Keyword for fuzzy matching of user names"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->UserGroupName', 
    Name: 'UserGroupName', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"emr_usergroup"} />, 
Description: <RenderMd content={"Cluster user group name"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->CreateorName', 
    Name: 'CreateorName', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"creator"} />, 
Description: <RenderMd content={"Creator name"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->UserNameOrder', 
    Name: 'UserNameOrder', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"ASC,DESC"} />, 
Description: <RenderMd content={"Username sorting method"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->CreateTimeOrder', 
    Name: 'CreateTimeOrder', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"ASC,DESC"} />, 
Description: <RenderMd content={"User creation time sorting method"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->UpdateTimeOrder', 
    Name: 'UpdateTimeOrder', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"ASC,DESC"} />, 
Description: <RenderMd content={"User update time sorting method"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->UserNames', 
    Name: 'UserNames', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["emr_user"]"} />, 
Description: <RenderMd content={"Used for batch queries"} />, 
    children: [ 
    ] 
  }, 
  
]; 

return (<Table 
  rowKey="rowKey" 
  className="openapi-doc-parameter-table" 
  columns={columns} 
  data={data} 
  border={ { cell: true, wrapper: true } } 
  scroll={ { x: "auto" } } 
  pagination={false} 
/>);

response parameters

The following table lists only the unique response parameters for this API. For more information, see response structure.

Parameter
Type
Example value
Description
items
Array of Object

[
{
"ClusterId": "emr-xxx",
"UserName": "emr_user",
"Description": "User description",
"CreatorId": "12345678",
"CreatorName": "creator",
"UserGroupNames": [
"emr_usergroup"
]
}
]

User cluster information

sample request

POST /?Action=ListClusterUsers&Version=2023-08-15 HTTP/1.1 
Host: emr.cn-beijing.volcengineapi.com 
Content-Type: application/json; charset=UTF-8 
X-Date: 20240702T125623Z 
X-Content-Sha256: 287e874e******d653b44d21e 
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240702/cn-beijing/emr/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f 

{ 
  "ClusterId": "emr-xxx" 
}

sample response

{ 
  "ResponseMetadata": { 
    "RequestId": "202407081019341630311861572E4666", 
    "Action": "ListClusterUsers", 
    "Version": "2023-08-15", 
    "Service": "emr", 
    "Region": "cn-beijing" 
  }, 
  "Result": { 
    "Items": [ 
      { 
        "ClusterId": "emr-xxx", 
        "UserName": "emr_user", 
"Description": "User description", 
        "CreatorId": "12345678", 
        "CreatorName": "creator" 
      } 
    ] 
  } 
}

error codes

The following table lists the error codes related to the business logic of this API. For common error codes, see the common error codes documentation.

Status code
Error code
Error message
Note
400
InvalidClusterId
cluster id {clusterId} not found

Cluster does not exist

Last updated: 2026.06.01 17:04:20