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

E-MapReduce

  • Documentation
    • E-MapReduceAPI referenceEMR on ECS API referenceApplication managementListComponents - component list
Copy page
Download PDF
Application management
ListComponents - component list
Copy page
Download PDF
ListComponents - component list

Component list

Note

Call ListComponents to obtain a list of E-MapReduce (EMR) cluster components.

important notes

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

Note

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

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.

**Action **string %%require%% Example value: ListComponents
The operation to perform. Value: ListComponents.

**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 service names

**ComponentNames **string[] Optional Example value: ["DATANODE"]
List of component names

Response parameters

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

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

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

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

**ComponentName **string Example value: ZKFC
Component name

**ComponentType **string
Component type

**ComponentState **string Example value: STARTED
Component state

**CreateTime **string Example value: null
Creation time

**StartTime **string Example value: null
Start time

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

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

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

sample request 

{ 
    "RequestId":null, 
    "RegionId":"cn-beijing", 
    "UserId":xxx, 
    "AccountId":xxx, 
    "ClusterId":"emr-xxx", 
    "ApplicationNames": ["HDFS"] 
}

sample response 

{ 
    "ResponseMetadata": { 
        "RequestId": "20231205115604A412C01E25FABxxx", 
        "Action": "ListComponents", 
        "Version": "2023-08-15", 
        "Service": "emr", 
        "Region": "cn-beijing", 
        "Error": null, 
        "Deprecated": false 
    }, 
    "Result": { 
        "Items": [ 
            { 
                "ClusterId": "emr-xxx", 
                "ApplicationName": "HDFS", 
                "ComponentName": "NAMENODE", 
                "Replica": 0, 
                "ComponentState": "STARTED", 
                "CreateTime": null, 
                "StartTime": null 
            }, 
            { 
                "ClusterId": "emr-xxx", 
                "ApplicationName": "HDFS", 
                "ComponentName": "JOURNALNODE", 
                "Replica": 0, 
                "ComponentState": "STARTED", 
                "CreateTime": null, 
                "StartTime": null 
            }, 
            { 
                "ClusterId": "emr-xxx", 
                "ApplicationName": "HDFS", 
                "ComponentName": "DATANODE", 
                "Replica": 0, 
                "ComponentState": "STARTED", 
                "CreateTime": null, 
                "StartTime": null 
            }, 
            { 
                "ClusterId": "emr-xxx", 
                "ApplicationName": "HDFS", 
                "ComponentName": "ROUTER", 
                "Replica": 0, 
                "ComponentState": "STARTED", 
                "CreateTime": null, 
                "StartTime": null 
            }, 
            { 
                "ClusterId": "emr-xxx", 
                "ApplicationName": "HDFS", 
                "ComponentName": "ZKFC", 
                "Replica": 0, 
                "ComponentState": "STARTED", 
                "CreateTime": null, 
                "StartTime": null 
            }, 
            { 
                "ClusterId": "emr-xxx", 
                "ApplicationName": "HDFS", 
                "ComponentName": "HdfsFoundation", 
                "Replica": 0, 
                "ComponentState": "INSTALLED", 
                "CreateTime": null, 
                "StartTime": null 
            } 
        ], 
        "TotalCount": 6, 
        "MaxResults": 10, 
        "NextToken": null 
    } 
}

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

400
InvalidRequest

Access Denied {clusterId}

No permission for this cluster

Last updated: 2026.06.01 17:04:20