Docs

E-MapReduce

Application management

ListApplications - Cluster list

Cluster list query

Note

Call ListApplications to obtain the list of applications for an E-MapReduce (EMR) cluster.

Important notes

You must have a Volcano Engine account and have enabled EMR permissions.

Request description

Request method: POST
Request URL: https://emr.cn-beijing.volcengineapi.com/?Version=2023-08-15&Action=ListApplications

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 table below lists only the unique request parameters for this API and some common parameters. For more information, see Common parameters.

**Action **string %%require%% Example value: ListApplications
The operation to be performed. Value: ListApplications.

**Version **string %%require%% Example value: 2023-08-15
API version. Value: 2023-08-15.

**ClusterId **string %%require%% Example value: emr-xxx
Cluster ID

**ApplicationNames **string[] Optional Example value: ["HDFS"]
List of application names

**MaxResults **integer Optional Example value: 10
Maximum number of records returned

**NextToken **string Optional Example value: xxx
Token for the next page in paginated queries

Response parameters

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

**Items **object[] Example value: --
List of cluster applications

**ApplicationName **string Example value: HDFS
Application name

**ApplicationVersion **string Example value: 3.3.4
Application version

**User **string Example value: hdfs
Application user

**Group **string Example value: hadoop
Application user group

**ApplicationConfigHome **string Example value: /etc/emr/${name}/conf

Application configuration path

**ApplicationHome **string Example value: /usr/lib/emr/current/${name}

Application installation path

**SupportClient **boolean Example value: false
Whether the client is supported

**ApplicationState **string Example value: NORMAL, //Normal WARNING, //Warning STOPPED, //Stopped INIT, //Initializing INSTALLING, //Installing INSTALLED, //Installed STARTING, //Starting STARTED, //Started STOPPING, //Stopping UNINSTALLING, //Uninstalling UNINSTALLED, //Uninstalled EXCEPTION; //Exception

Service status

**MaxResults **integer Example value: 10
Maximum number of records returned per query

**NextToken **string Example value: IcKlh2bKXei9E5Uv/3XjOA==
Token for the next page in paginated queries

**TotalCount **integer Example value: 17
Total record count

Sample request

{ 
   "ClusterId":"emr-xxx" 
}

Sample response

{ 
    "ResponseMetadata": { 
        "RequestId": "202312051929157D73231DC5Cxxx", 
        "Action": "ListApplications", 
        "Version": "2023-08-15", 
        "Service": "emr", 
        "Region": "cn-beijing", 
        "Error": null, 
        "Deprecated": false 
    }, 
    "Result": { 
        "Items": [ 
            { 
                "ApplicationName": "PROMETHEUS", 
                "ReleaseVersion": "1.1.0", 
                "User": "prometheus", 
                "Group": "prometheus", 
                "ApplicationConfigHome": "/etc/emr/${name}/conf", 
                "ApplicationHome": "/usr/lib/emr/current/${name}", 
                "SupportClient": false 
            }, 
            { 
                "ApplicationName": "KNOX", 
                "ReleaseVersion": "1.5.0", 
                "User": "knox", 
                "Group": "knox", 
                "ApplicationConfigHome": "/etc/emr/${name}/conf", 
                "ApplicationHome": "/usr/lib/emr/current/${name}", 
                "SupportClient": false 
            },... 
        ], 
        "TotalCount": 17, 
        "MaxResults": 10, 
        "NextToken": "IcKlh2bKXei9E5Uv/3XjOA==" 
    } 
}

Error codes

The table below 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
400	InvalidRequest	Access Denied {clusterId}	No permission for this cluster

Last updated: 2026.06.01 17:04:19

E-MapReduce

Note #

Important notes #

Request description #

Debug #

Request parameters #

Response parameters #

Sample request #

Sample response #

Error codes #