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

E-MapReduce

  • Documentation
    • E-MapReduceAPI referenceEMR on ECS API referenceUser group managementListClusterUserGroups - Retrieve cluster user group list
Copy page
Download PDF
User group management
ListClusterUserGroups - Retrieve cluster user group list
Copy page
Download PDF
ListClusterUserGroups - Retrieve cluster user group list

Retrieve cluster user group list

Debug

API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Go to debug

request parameters

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

Parameter
Type
Required
Example
Description
Action
String
Yes

ListClusterUserGroups

The operation to perform. Value: ListClusterUserGroups.

Version
String
Yes

2023-08-15

API version. Value: 2023-08-15.

ClusterId
String
Yes

emr-xxx

Cluster ID

UserGroupName
String
No

emr_usergroup

User group name

Keyword
String
No

emr

Keyword. Fuzzy match for user group name.

response parameters

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

Parameter
Type
Example
Description
Items
Array of Object

[
{
"ClusterId": "emr-xxx",
"UserGroupName": "emr_usergroup",
"Description": "emr用户组"
}
]

Basic information of user group

sample request 

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

{ 
  "ClusterId": "emr-xxx", 
  "UserGroupName": "emr_usergroup" 
}

sample response 

{ 
  "ResponseMetadata": { 
    "RequestId": "20240708101656249245174165FBBBAE", 
    "Action": "ListClusterUserGroups", 
    "Version": "2023-08-15", 
    "Service": "emr", 
    "Region": "cn-beijing" 
  }, 
  "Result": { 
    "Items": [ 
      { 
        "ClusterId": "emr-xxx", 
        "UserGroupName": "emr_usergroup", 
"Description": "emr user group" 
      } 
    ] 
  } 
}

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